SDC service-model commands for onboarding
[cli.git] / products / onap-dublin / features / sdc / src / main / resources / open-cli-schema / service-model / service2vf-model-list-schema-dublin.yaml
1 # Copyright © Intel Corporation 2019
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: service2vf-model-list
17 description: List the VF in a given service model in SDC
18
19 info:
20   product: onap-dublin
21   service: sdc
22   author: ONAP CLI Team onap-discuss@lists.onap.org
23
24
25 parameters:
26   - name: service-model-id
27     description: Service model uuid
28     type: string
29     short_option: z
30     long_option: service-model-id
31     is_optional: false
32
33 results:
34   direction: landscape
35   attributes:
36     - name: vf-uuid
37       description: UUID
38       type: string
39       scope: short
40     - name: vf-name
41       description: name
42       type: string
43       scope: short
44     - name: vf-customization-uuid
45       description: customization UUID
46       type: string
47       scope: short
48     - name: vf-version
49       description: version
50       type: string
51       scope: short
52
53 http:
54   service:
55     name: sdc
56     version: v1.0
57     auth: basic
58     mode: direct
59   request:
60     uri: /sdc2/rest/v1/catalog/services/${service-model-id}
61     method: GET
62   success_codes:
63     - 200
64   result_map:
65     vf-uuid: $b{componentInstances.[*].componentUid}
66     vf-name: $b{componentInstances.[*].componentName}
67     vf-version: $b{componentInstances.[*].componentVersion}
68     vf-customization-uuid: $b{componentInstances.[*].customizationUUID}