gerrit.onap Code Review - cli.git/blob

   1 # Copyright 2018 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: customer-show
  17 description: Retrieves the given registered customer in Onap
  18
  19 info:
  20   product: onap-casablanca
  21   service: aai
  22   author: ONAP CLI Team onap-discuss@lists.onap.org
  23
  24 parameters:
  25   - name: customer-name
  26     description: Onap customer name
  27     type: string
  28     short_option: x
  29     long_option: customer-name
  30     is_optional: false
  31
  32 results:
  33   direction: landscape
  34   attributes:
  35     - name: name
  36       description: Onap customer name
  37       scope: short
  38       type: string
  39     - name: subscriber-name
  40       description: Onap subscriber name
  41       scope: short
  42       type: string
  43     - name: resource-version
  44       description: Onap subscriber resource version
  45       scope: long
  46       type: string
  47     - name: subscriber-type
  48       description: Onap subscriber type
  49       scope: long
  50       type: string
  51 http:
  52   service:
  53     auth: basic
  54     mode: direct
  55   request:
  56     uri: /aai/v13/business/customers/customer/${customer-name}
  57     method: GET
  58   success_codes:
  59     - 200
  60   result_map:
  61     name: $b{$.global-customer-id}
  62     subscriber-name: $b{$.subscriber-name}
  63     subscriber-type: $b{$.subscriber-type}
  64     resource-version: $b{$.resource-version}
  65   sample_response:
  66     body: '{"global-customer-id":"Linan","subscriber-name":"Linan","subscriber-type":"INFRA","resource-version":"1501768482","service-subscriptions":{"service-subscription":[{"service-type":"vFW","resource-version":"1501768482","relationship-list":{"relationship":[{"related-to":"tenant","related-link":"https://192.168.17.12:8443/aai/v8/cloud-infrastructure/cloud-regions/cloud-region/Rackspace/RegionOne/tenants/tenant/e69e6d64b44347509c3fc512391f34a6/","relationship-data":[{"relationship-key":"cloud-region.cloud-owner","relationship-value":"Rackspace"},{"relationship-key":"cloud-region.cloud-region-id","relationship-value":"RegionOne"},{"relationship-key":"tenant.tenant-id","relationship-value":"e69e6d64b44347509c3fc512391f34a6"}],"related-to-property":[{"property-key":"tenant.tenant-name","property-value":"onap"}]}]}},{"service-type":"vLB","resource-version":"1501768482","relationship-list":{"relationship":[{"related-to":"tenant","related-link":"https://192.168.17.12:8443/aai/v8/cloud-infrastructure/cloud-regions/cloud-region/Rackspace/RegionOne/tenants/tenant/e69e6d64b44347509c3fc512391f34a6/","relationship-data":[{"relationship-key":"cloud-region.cloud-owner","relationship-value":"Rackspace"},{"relationship-key":"cloud-region.cloud-region-id","relationship-value":"RegionOne"},{"relationship-key":"tenant.tenant-id","relationship-value":"e69e6d64b44347509c3fc512391f34a6"}],"related-to-property":[{"property-key":"tenant.tenant-name","property-value":"onap"}]}]}}]}}'