products/onap-beijing/features/aai/src/main/resources/open-cli-schema/service-instance/service-list-schema-1.1.yaml

   1 # Copyright 2018 Huawei Technologies Co., Ltd.\r
   2 #\r
   3 # Licensed under the Apache License, Version 2.0 (the "License");\r
   4 # you may not use this file except in compliance with the License.\r
   5 # You may obtain a copy of the License at\r
   6 #\r
   7 #     http://www.apache.org/licenses/LICENSE-2.0\r
   8 #\r
   9 # Unless required by applicable law or agreed to in writing, software\r
  10 # distributed under the License is distributed on an "AS IS" BASIS,\r
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  12 # See the License for the specific language governing permissions and\r
  13 # limitations under the License.\r
  14 \r
  15 open_cli_schema_version: 1.0\r
  16 name: service-list\r
  17 description: List created service instance\r
  18 \r
  19 info:\r
  20   product: onap-beijing\r
  21   service: aai\r
  22   author: ONAP CLI Team onap-discuss@lists.onap.org\r
  23 \r
  24 parameters:\r
  25   - name: customer-name\r
  26     description: customer name\r
  27     type: string\r
  28     short_option: x\r
  29     long_option: customer-name\r
  30     is_optional: false\r
  31   - name: service-type\r
  32     description: service subscription type\r
  33     type: string\r
  34     short_option: y\r
  35     long_option: service-type\r
  36     is_optional: false\r
  37 \r
  38 results:\r
  39   direction: landscape\r
  40   attributes:\r
  41     - name: service-id\r
  42       description: instance id of service\r
  43       scope: short\r
  44       type: string\r
  45     - name: service-name\r
  46       description: Service name\r
  47       scope: short\r
  48       type: string\r
  49     - name: model-invariant-id\r
  50       description: Model invariant id of service model\r
  51       scope: long\r
  52       type: string\r
  53     - name: model-uuid\r
  54       description: Model uuid for service model\r
  55       scope: long\r
  56       type: string\r
  57     - name: description\r
  58       description: service description\r
  59       scope: long\r
  60       type: string\r
  61 \r
  62 http:\r
  63   service:\r
  64     name: aai\r
  65     version: v11\r
  66     auth: basic\r
  67     mode: direct\r
  68 \r
  69   request:\r
  70     uri: /aai/v11/business/customers/customer/${customer-name}/service-subscriptions/service-subscription/${service-type}/service-instances\r
  71     method: GET\r
  72   success_codes:\r
  73     - 200\r
  74   result_map:\r
  75     service-id: $b{service-instance.[*].service-instance-id}\r
  76     service-name: $b{service-instance.[*].service-instance-name}\r
  77     model-invariant-id: $b{service-instance.[*].model-invariant-id}\r
  78     model-uuid: $b{service-instance.[*].model-version-id}\r
  79     description: $b{service-instance.[*].description}\r
  80   sample_response:\r
  81     body: '{"service-instance": [{"service-instance-id": "${service-id}","service-instance-name": "${service-name}","description": "${description}","model-invariant-id": "${model-invariant-id}","model-version-id": "${model-uuid}"}]}'\r