44f3a707a1d5c4c55e5b6aef429295ddefa8c8f5
[cli.git] /
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-instance-relationship-create\r
17 description: Create a service instance relationship for vnf/pnf\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: global-customer-id\r
26     description: global-customer-id\r
27     type: string\r
28     short_option: g\r
29     long_option: global-customer-id\r
30     is_optional: false\r
31   - name: service-type\r
32     description: service-type \r
33     type: string\r
34     short_option: z\r
35     long_option: service-type\r
36     is_optional: false\r
37   - name: service-instance-id\r
38     description: service-instance-id\r
39     type: string\r
40     short_option: i\r
41     long_option: service-instance-id\r
42     is_optional: false\r
43   - name: relationship\r
44     description: relationship\r
45     type: json\r
46     short_option: r\r
47     long_option: relationship\r
48     is_optional: false\r
49 # sample json of relationship\r
50 #            {\r
51 #                "related-to": "logical-link",\r
52 #                "related-link": "/aai/v11/network/logical-links/logical-link/S11-00001",\r
53 #                "relationship-data": [\r
54 #                    {\r
55 #                        "relationship-key": "logical-link.link-name",\r
56 #                        "relationship-value": "S11-00001"\r
57 #                    }\r
58 #                ]\r
59 #            }\r
60     \r
61 http:\r
62   service:\r
63     auth: basic\r
64     mode: direct\r
65   request:\r
66     uri: /business/customers/customer/${global-customer-id}/service-subscriptions/service-subscription/${service-type}/service-instances/service-instance/${service-instance-id}/relationship-list/relationship \r
67     method: PUT\r
68     context:\r
69       remove_empty_node: true\r
70     body: '"${relationship}"'\r
71   success_codes:\r
72     - 200\r
73     - 201\r