aboutsummaryrefslogtreecommitdiffstats
path: root/products/onap-beijing/features/aai/src/main/resources/open-cli-schema/service-instance/service-list-schema-beijing.yaml
blob: 8b514be7d40b3f33e45cc72ae481498d49ca7c40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Copyright 2018 Huawei Technologies Co., Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

open_cli_schema_version: 1.0
name: service-list
description: List created service instance

info:
  product: onap-beijing
  service: aai
  author: ONAP CLI Team onap-discuss@lists.onap.org

parameters:
  - name: customer-name
    description: customer name
    type: string
    short_option: x
    long_option: customer-name
    is_optional: false
  - name: service-type
    description: service subscription type
    type: string
    short_option: y
    long_option: service-type
    is_optional: false

results:
  direction: landscape
  attributes:
    - name: service-id
      description: instance id of service
      scope: short
      type: string
    - name: service-name
      description: Service name
      scope: short
      type: string
    - name: model-invariant-id
      description: Model invariant id of service model
      scope: long
      type: string
    - name: model-uuid
      description: Model uuid for service model
      scope: long
      type: string
    - name: description
      description: service description
      scope: long
      type: string

http:
  service:
    name: aai
    version: v11
    auth: basic
    mode: direct

  request:
    uri: /aai/v11/business/customers/customer/${customer-name}/service-subscriptions/service-subscription/${service-type}/service-instances
    method: GET
  success_codes:
    - 200
  result_map:
    service-id: $b{service-instance.[*].service-instance-id}
    service-name: $b{service-instance.[*].service-instance-name}
    model-invariant-id: $b{service-instance.[*].model-invariant-id}
    model-uuid: $b{service-instance.[*].model-version-id}
    description: $b{service-instance.[*].description}
  sample_response:
    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}"}]}'