aboutsummaryrefslogtreecommitdiffstats
path: root/products/onap-beijing/features/aai/src/main/resources/open-cli-schema/service-instance/service-instance-relationship-delete-schema.yaml
blob: b70aeeb59ecca0bad9eb4cc95e42f5a659a4fa87 (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
# 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-instance-relationship-delete
description: delete a service instance relationship for vnf/pnf

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

parameters:
  - name: global-customer-id
    description: global-customer-id
    type: string
    short_option: g
    long_option: global-customer-id
    is_optional: false
  - name: service-type
    description: service-type
    type: string
    short_option: z
    long_option: service-type
    is_optional: false
  - name: service-instance-id
    description: service-instance-id
    type: string
    short_option: i
    long_option: service-instance-id
    is_optional: false
  - name: relationship
    description: relationship
    type: json
    short_option: r
    long_option: relationship
    is_optional: false
# sample json of relationship
#            {
#                "related-to": "logical-link",
#                "related-link": "/aai/v11/network/logical-links/logical-link/S11-00001",
#                "relationship-data": [
#                    {
#                        "relationship-key": "logical-link.link-name",
#                        "relationship-value": "S11-00001"
#                    }
#                ]
#            }

http:
  service:
    auth: basic
    mode: direct
  request:
    uri: /aai/v11/business/customers/customer/${global-customer-id}/service-subscriptions/service-subscription/${service-type}/service-instances/service-instance/${service-instance-id}/relationship-list/relationship
    method: DELETE
    context:
      remove_empty_node: true
    body: '"${relationship}"'
  success_codes:
    - 200
    - 201
    - 204