products/onap-dublin/features/vfc/src/main/resources/open-cli-schema/nslcm/vfc-nslcm-sol005-instantiate-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-instantiate
  17 description: vfc nslcm instantiate ns with sol005 api
  18
  19 info:
  20   product: onap-dublin
  21   service: vfc
  22   author: ONAP VFC Team (yangyanyj@chinamobile.com)
  23
  24 parameters:
  25   - name: ns-instance-id
  26     description: ns's instance id
  27     type: string
  28     short_option: i
  29     long_option: ns-instance-id
  30     is_optional: false
  31   - name: location
  32     description: localtion(vimid)
  33     type: string
  34     short_option: c
  35     long_option: location
  36     is_optional: false
  37   - name: sdn-controller-id
  38     description: sdn controller id
  39     type: string
  40     short_option: n
  41     long_option: sdn-controller-id
  42     is_optional: false
  43
  44 results:
  45   direction: portrait
  46   attributes:
  47     - name: job-id
  48       description: job id
  49       scope: short
  50       type: string
  51
  52 http:
  53   service:
  54     auth: none
  55     mode: direct
  56   request:
  57     uri: /api/nslcm/v1/ns_instances/${ns-instance-id}/instantiate
  58     method: POST
  59     context:
  60       remove_empty_node: true
  61     body: '{
  62              "additionalParamForNs":
  63                {
  64                  "sdncontroller": "${sdn-controller-id}",
  65                  "location": "${location}"
  66                }
  67            }'
  68     headers:
  69       Content-Type: application/json
  70       Accept: application/json
  71   success_codes:
  72     - 202
  73   result_map:
  74     job-id: $b{$.jobId}