aboutsummaryrefslogtreecommitdiffstats
path: root/products/onap-dublin/features/vfc/src/main/resources/open-cli-schema/nslcm/vfc-nslcm-subscription-schema.yaml
blob: f2f129e342e8780cb5c4ed397ba3de6ab20a3cd2 (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
82
83
84
85
86
87
88
89
90
91
92
93
94
# Copyright (c) 2019, CMCC 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: vfc-nslcm-get-subscription
description: vfc nsclm subscribe notification

info:
  product: onap-dublin
  service: vfc
  author: ONAP VFC Team (yangyanyj@chinamobile.com)

parameters:
  - name: callback-uri
    description: callback-uri
    type: string
    short_option: c
    long_option: callback-uri
    is_optional: false
  - name: notification-types
    description: the type of notification
    type: string
    short_option: n
    long_option: notification-types
    is_optional: false

results:
  direction: portrait
  attributes:
    - name: subscription_id
      description: subscription_id
      scope: short
      type: string
    - name: callback-uri
      description: callback-uri
      scope: short
      type: string
    - name: links
      description: links
      scope: short
      type: string
    - name: filter
      description: filter
      scope: short
      type: string

http:
  service:
    auth: none
    mode: direct
  request:
    uri: /api/nslcm/v1/subscriptions
    method: POST
    context:
      remove_empty_node: true
    body:
    '{
      "callbackUri": "${callback-uri}",
      "authentication": {
        "authType": ["BASIC"],
        "paramsBasic": {
          "username": "username",
          "password": "password"
        }
      },
      "filter": {
        "notificationTypes": ["${notification-types}"],
        "operationTypes": [
          "INSTANTIATE"
        ],
        "operationStates": [
          "STARTING"
        ]
      }
    }'

    headers:
      Content-Type: application/json
      Accept: application/json
  success_codes:
    - 201
  result_map:
    subscription_id: $b{$.subscriptionId}
    callback-Uri: $b{$.callbackUri}
    links: $b{$.links}
    filter: $b{$.filter}