products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml

   1 # Copyright 2017-18 Huawei 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: vfmodule-delete
  17
  18 description: delete a VF module (experimental)
  19
  20 info:
  21   product: onap-amsterdam
  22   service: so
  23   author: ONAP CLI Team onap-discuss@lists.onap.org
  24
  25 parameters:
  26   - name: vfmodule-id
  27     description: VF module Id
  28     type: string
  29     short_option: x
  30     long_option: vfmodule-id
  31     is_optional: false
  32   - name: service-id
  33     description: unique id for service
  34     type: string
  35     short_option: j
  36     long_option: service-id
  37     is_optional: false
  38   - name: vf-id
  39     description: unique id for related VF
  40     type: string
  41     short_option: y
  42     long_option: vf-id
  43     is_optional: false
  44   - name: vf-model-invariant-id
  45     description: vf model invariant id
  46     type: string
  47     short_option: k
  48     long_option: vf-model-invariant-id
  49     is_optional: false
  50   - name: vfmodule-name
  51     description: vfmodule model name
  52     type: string
  53     short_option: e
  54     long_option: vfmodule-name
  55     is_optional: false
  56   - name: vfmodule-version
  57     description: vf module version
  58     type: string
  59     short_option: g
  60     long_option: vfmodule-version
  61     is_optional: false
  62   - name: cloud-region
  63     description: cloud region identifier
  64     type: string
  65     short_option: l
  66     long_option: cloud-region
  67     is_optional: false
  68   - name: tenant-id
  69     description: openstack tenant id
  70     type: string
  71     long_option: tenant-id
  72     short_option: z
  73     is_optional: false
  74
  75 http:
  76   service:
  77     name: so
  78     version: v3
  79     auth: basic
  80     mode: direct
  81   request:
  82     uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules/${vfmodule-id}
  83     method: DELETE
  84     body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"${vf-model-invariant-id}","modelName":"${vfmodule-name}","modelVersion":"${vfmodule-version}"},"cloudConfiguration":{"lcpCloudRegionId":"${cloud-region}","tenantId":"${tenant-id}"},"requestInfo":{"source":"VID"}}}'
  85
  86   success_codes:
  87     - 202