products/onap-dublin/features/vfc/src/main/resources/open-cli-schema/catalog/vfc-catalog-get-ns-descriptors-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-get-ns-descriptors
  17 description: VFC get ns descriptors from catalog
  18
  19 info:
  20   product: onap-dublin
  21   service: vfc
  22   author: ONAP VFC Team (yangyanyj@chinamobile.com)
  23
  24 parameters:
  25   - name: nsd-info-id
  26     description: nsd's info id
  27     type: string
  28     short_option: c
  29     long_option: nsd-info-id
  30     is_optional: false
  31
  32 results:
  33   direction: landscape
  34   attributes:
  35     - name: id
  36       description: ns package id
  37       scope: short
  38       type: string
  39     - name: nsd-info-id
  40       description: nsd-info-id
  41       scope: short
  42       type: string
  43     - name: nsd-name
  44       description: nsd-name
  45       scope: short
  46       type: string
  47     - name: nsd-onboarding-state
  48       description: nsd-onboarding-state
  49       scope: short
  50       type: string
  51     - name: vnf-package-ids
  52       description: vnf-package-ids
  53       scope: short
  54       type: array
  55     - name: pnf-package-ids
  56       description: pnf-package-ids
  57       scope: short
  58       type: array
  59
  60 http:
  61   service:
  62     auth: none
  63     mode: direct
  64   request:
  65     uri: /api/nsd/v1/ns_descriptors/${nsd-info-id}
  66     method: GET
  67     context:
  68       remove_empty_node: true
  69     body: '{}'
  70     headers:
  71       Content-Type: application/json
  72       Accept: application/json
  73   success_codes:
  74     - 200
  75   result_map:
  76     id: $b{$.id}
  77     nsd-info-id: $b{$.nsdId}
  78     nsd-name: $b{$.nsdName}
  79     nsd-onboarding-state: $b{$.nsdOnboardingState}
  80     vnf-package-ids: $b{$.vnfPkgIds}
  81     pnf-package-ids: $b{$.pnfdInfoIds}