VNFPackageManagementNotification.yaml 11.1 KB
Newer Older
1
openapi: 3.0.2
2
3

info:
4
  title: SOL003 - VNF Package Management Notification interface
5
  description: |
6
7
    SOL003 - VNF Package Management Notification interface

8
    IMPORTANT: Please note that this file might be not aligned to the current
9
10
11
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

12

13
14
15
16
17
18
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
19

20
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
21
22
  contact:
    name: NFV-SOL WG
23
  license:
24
    name: ETSI Forge copyright notice
25
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
26
  version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
27
28

externalDocs:
29
30
  description: ETSI GS NFV-SOL 002 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
31

32
33
34
servers:
  - url: http://127.0.0.1/callback/v2
  - url: https://127.0.0.1/callback/v2
35
36

paths:
37
38
39
  ###############################################################################
  # Notification endpoint VnfPackageOnboardingNotification                      #
  ###############################################################################
40
  /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification:
41
    #SOL003 location: 10.4.9
42
43
44
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
45
    post:
46
      description: |
47
48
49
50
51
        Notify.
        The POST method delivers a notification from the API producer to an API consumer.
        The API consumer shall have previously created an "Individual subscription" resource with a matching filter.
        This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2
        for URI query parameters, request and response data structures, and response codes.
52
      parameters:
53
54
55
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageOnboardingNotification'
56
57
      responses:
        204:
58
          $ref: '#/components/responses/VnfPackageOnboardingNotification.Post.204'
59
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
60
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
61
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
62
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
63
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
64
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
65
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
66
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
67
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
68
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
69
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
70
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
71
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
72
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli's avatar
moscatelli committed
73

74
    get:
75
      description: |
76
77
        The GET method allows the API producer to test the notification endpoint that is provided by 
        the API consumer e.g. during subscription.
78
79
        This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2
        for URI query parameters, request and response data structures, and response codes.
80
81
      responses:
        204:
82
          $ref: '#/components/responses/VnfPackageOnboardingNotification.Get.204'
83
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
84
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
85
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
86
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
87
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
88
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
89
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
90
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
91
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
92
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
93
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
94
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
95
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
96
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
97

98
99
100
  ###############################################################################
  # Notification endpoint VnfPackageChangeNotification                          #
  ###############################################################################
101
  /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification:
102
    #SOL003 location: 10.4.9
103
104
105
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
106
    post:
107
      description: |
108
109
110
111
112
        Notify.
        The POST method delivers a notification from the API producer to an API consumer.
        The API consumer shall have previously created an "Individual subscription" resource with a matching filter.
        This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2
        for URI query parameters, request and response data structures, and response codes.
113
      parameters:
114
115
116
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageChangeNotification'
117
118
      responses:
        204:
119
          $ref: '#/components/responses/VnfPackageChangeNotification.Post.204'
120
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
121
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
122
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
123
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
124
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
125
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
126
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
127
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
128
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
129
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
130
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
131
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
132
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
133
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli's avatar
moscatelli committed
134

135
    get:
136
      description: |
137
138
        The GET method allows the API producer to test the notification endpoint that is provided by 
        the API consumer e.g. during subscription.
139
140
        This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2
        for URI query parameters, request and response data structures, and response codes.
141
142
      responses:
        204:
143
          $ref: '#/components/responses/VnfPackageChangeNotification.Get.204'
144
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
145
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
146
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
147
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
148
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
149
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
150
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
151
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
152
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
153
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
154
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
155
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
156
        503:
157
158
159
160
161
162
163
164
165
166
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"

components:
  requestBodies:

    VnfPackageOnboardingNotification:
      description: A notification about on-boarding of a VNF package.
      content:
        application/json:
          schema:
167
            $ref: "definitions/SOL003VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification"
168
169
170
171
172
173
174
175
      required: true

    VnfPackageChangeNotification:
      description: |
        A notification about changes of status in a VNF package.=
      content:
        application/json:
          schema:
176
            $ref: "definitions/SOL003VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification"
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
      required: true

  responses:
  
    VnfPackageOnboardingNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully.
      headers:
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    VnfPackageOnboardingNotification.Get.204:
      description: |
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    VnfPackageChangeNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully.
      headers:
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    VnfPackageChangeNotification.Get.204:
      description: |
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string