products/onap-dublin/features/vfc/src/main/resources/open-cli-schema/nslcm/vfc-nslcm-sol005-get-schema.yaml

   1 # Copyright (c) 2019, CMCC Technologies Co., Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License")
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #       http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 open_cli_schema_version: 1.0
  16 name: vfc-nslcm-sol-get
  17 description: vfc nsclm get the status of creating ns in slo005 api
  18
  19 info:
  20   product: onap-dublin
  21   service: vfc
  22   author: ONAP VFC Team (yangyanyj@chinamobile.com)
  23
  24 results:
  25   direction: portrait
  26   attributes:
  27     - name: ns-instance-id
  28       description: ns-instance-id
  29       scope: short
  30       type: string
  31     - name: ns-name
  32       description: ns-name
  33       scope: short
  34       type: string
  35     - name: description
  36       description: description
  37       scope: short
  38       type: string
  39     - name: nsd-id
  40       description: nsd-id
  41       scope: short
  42       type: string
  43
  44 http:
  45   service:
  46     auth: none
  47     mode: direct
  48   request:
  49     uri: api/nslcm/v1/ns_instances
  50     method: GET
  51     context:
  52       remove_empty_node: true
  53     body: '{}'
  54     headers:
  55       Content-Type: application/json
  56       Accept: application/json
  57   success_codes:
  58     - 200
  59   result_map:
  60     ns-instance-id: $b{$.nsInstanceId}
  61     ns-name: $b{$.nsName}
  62     description: $b{$.description}
  63     nsd-id: $b{$.nsdId}