VNFLifecycleManagementNotification.yaml 16.5 KB
Newer Older
1
2
3
swagger: "2.0"

info:
Giacomo Bernini's avatar
Giacomo Bernini committed
4
  version: "1.5.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL003 - VNF Lifecycle Management Notification interface
6
  description: >
7
8
    SOL003 - VNF Lifecycle Management Notification interface

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

13
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
17
18

externalDocs:
19
20
  description: ETSI GS NFV-SOL 003 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_NFV-SOL003v020801p.pdf
21
22
23
24
25
26
27
28
29
30
31
32

basePath: "/callback/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
33
  ###############################################################################
34
  # Notification endpoint VnfLcmOperationOccurrenceNotification                 #
35
  ###############################################################################
36
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfLcmOperationOccurrenceNotification':
37
38
    post:
      description: >
39
        Notify.
40
41
42
43
        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 5.4.20.3.1-1 and 5.4.20.3.1-2 for
        URI query parameters, request and response data structures, and response codes.
44
45
      parameters:
        - name: VnfLcmOperationOccurrenceNotification
46
          description: A notification about lifecycle changes triggered by a VNF LCM operation occurrence..
47
48
49
          in: body
          required: true
          schema:
50
            $ref: "./definitions/SOL003VNFLifecycleManagementNotification_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification"
Gergely Csatari's avatar
Gergely Csatari committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
65
66
67
68
69
70
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
71
72
      responses:
        204:
73
          description: >
74
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
75

76
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
77
78
79
80
81
82
83
84
85
          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.
              type: string
              maximum: 1
              minimum: 0
86
87
88
89
90
91
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
92
93
94
95
96
97
98
99
100
101
102
103
104
105
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
106
107
108

    get:
      description: >
109
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
110
111
112
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2
        for URI query parameters, request and response data structures, and response codes.
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

132
133
            Shall be returned to indicate that the notification endpoint has been tested successfully.
            The response body shall be empty.
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
          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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

164
165
166
  ###############################################################################
  # Notification endpoint VnfIdentifierCreationNotification                     #
  ###############################################################################
167
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIdentifierCreationNotification':
168
169
    post:
      description: >
170
        Notify.
171
172
173
174
        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 5.4.20.3.1-1 and 5.4.20.3.1-2 for
        URI query parameters, request and response data structures, and response codes.
175
176
177
      parameters:
        - name: VnfIdentifierCreationNotification
          description: >
178
            A notification about the creation of a VNF identifier and the related "Individual VNF instance" resource.
179
180
181
182
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification"
Gergely Csatari's avatar
Gergely Csatari committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
197
198
199
200
201
202
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
203
204
      responses:
        204:
205
          description: >
206
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
207

208
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
209
210
211
212
213
214
215
216
217
          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.
              type: string
              maximum: 1
              minimum: 0
218
219
220
221
222
223
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
224
225
226
227
228
229
230
231
232
233
234
235
236
237
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
238
239
240

    get:
      description: >
241
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
242
243
244
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2
        for URI query parameters, request and response data structures, and response codes.
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

264
265
            Shall be returned to indicate that the notification endpoint has been tested successfully.
            The response body shall be empty.
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
          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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

296
297
298
  ###############################################################################
  # Notification endpoint VnfIdentifierDeletionNotification                     #
  ###############################################################################
299
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIdentifierDeletionNotification':
300
301
    post:
      description: >
302
        Notify.
303
304
305
306
        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 5.4.20.3.1-1 and 5.4.20.3.1-2 for
        URI query parameters, request and response data structures, and response codes.
307
308
309
      parameters:
        - name: VnfIdentifierDeletionNotification
          description: >
310
            A notification about the deletion of a VNF identifier and the related "Individual VNF instance" resource.
311
312
313
314
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification"
Gergely Csatari's avatar
Gergely Csatari committed
315
316
317
318
319
320
321
322
323
324
325
326
327
328
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
329
330
331
332
333
334
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
335
336
      responses:
        204:
337
          description: >
338
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
339

340
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
341
342
343
344
345
346
347
348
349
          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.
              type: string
              maximum: 1
              minimum: 0
350
351
352
353
354
355
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
356
357
358
359
360
361
362
363
364
365
366
367
368
369
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
370
371
372

    get:
      description: >
373
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
374
375
376
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2
        for URI query parameters, request and response data structures, and response codes.
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

396
397
            Shall be returned to indicate that the notification endpoint has been tested successfully.
            The response body shall be empty.
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
          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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"