NSDManagementNotification.yaml 37.9 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
6
7
8
9
10
  title: SOL005 - NSD Management Notification interface
  description: >
    SOL005 - NSD Management Notification interface
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.
11
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
12
13
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:
17
18
  description: ETSI GS NFV-SOL 005 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
19

20
basePath: /callback/v2
21
22
23
24
25
26
27
28
29
30
31
32

schemes:
  - http
  - https

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

paths:
  ###############################################################################
33
  # Notification endpoint NsdOnBoardingNotification                             #
34
  ###############################################################################
35
  '/URI_is_provided_by_the_client_when_creating_the_subscription_NsdOnBoardingNotification':
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
54
        The POST method delivers a notification from the API producer to the API consumer.
55
56
57
58
59
60
61
62
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: NsdOnBoardingNotification
          description: >
            A notification about the successful on-boarding of an NSD.
          in: body
63
          required: true
moscatelli's avatar
moscatelli committed
64
65
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingNotification"
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
            204 NO CONTENT

85
            Shall be returned when the notification has been delivered successfully.
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
102
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
103
        401:
104
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
105
        403:
106
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
107
        404:
108
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
109
        405:
110
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
111
        406:
112
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
113
        500:
114
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
115
        503:
116
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
117
118
119
120

    get:
      summary: Test the notification endpoint
      description: >
121
122
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

138
            Shall be returned when the notification endpoint has been tested successfully.
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
156
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
157
        401:
158
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
159
        403:
160
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
161
        404:
162
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
163
        405:
164
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
165
        406:
166
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
167
        500:
168
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
169
        503:
170
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

  ###############################################################################
  # Notification endpoint NsdOnBoardingFailureNotification                      #
  ###############################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_NsdOnBoardingFailureNotification':
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
194
        The POST method delivers a notification from the API producer to the API consumer.
195
196
197
198
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
moscatelli's avatar
moscatelli committed
199
        - name: NsdOnBoardingFailureNotification
200
          description: >
moscatelli's avatar
moscatelli committed
201
202
            A notification about the failure of on-boarding an NSD.
          in: body
203
          required: true
moscatelli's avatar
moscatelli committed
204
205
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingFailureNotification"
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
            204 NO CONTENT

225
            Shall be returned when the notification has been delivered successfully.
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
242
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
243
        401:
244
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
245
        403:
246
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
247
        404:
248
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
249
        405:
250
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
251
        406:
252
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
253
        500:
254
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
255
        503:
256
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
257
258
259
260

    get:
      summary: Test the notification endpoint
      description: >
261
262
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

278
            Shall be returned when the notification endpoint has been tested successfully.
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
296
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
297
        401:
298
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
299
        403:
300
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
301
        404:
302
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
303
        405:
304
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
305
        406:
306
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
307
        500:
308
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
309
        503:
310
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333

  ###############################################################################
  # Notification endpoint NsdChangeNotification                                 #
  ###############################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_NsdChangeNotification':
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
334
        The POST method delivers a notification from the API producer to the API consumer.
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: NsdChangeNotification
          description: >
            A notification about the state change of an on-boarded NSD.
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdChangeNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
            204 NO CONTENT

365
            Shall be returned when the notification has been delivered successfully.
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
382
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
383
        401:
384
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
385
        403:
386
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
387
        404:
388
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
389
        405:
390
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
391
        406:
392
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
393
        500:
394
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
395
        503:
396
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
397
398
399
400

    get:
      summary: Test the notification endpoint
      description: >
401
402
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

418
            Shall be returned when the notification endpoint has been tested successfully.
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
436
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
437
        401:
438
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
439
        403:
440
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
441
        404:
442
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
443
        405:
444
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
445
        406:
446
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
447
        500:
448
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
449
        503:
450
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473

  ###############################################################################
  # Notification endpoint NsdDeletionNotification                               #
  ###############################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_NsdDeletionNotification':
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
474
        The POST method delivers a notification from the API producer to the API consumer.
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: NsdDeletionNotification
          description: >
            A notification about the deletion of an on-boarded NSD.
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdDeletionNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
            204 NO CONTENT

505
            Shall be returned when the notification has been delivered successfully.
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
522
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
523
        401:
524
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
525
        403:
526
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
527
        404:
528
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
529
        405:
530
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
531
        406:
532
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
533
        500:
534
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
535
        503:
536
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
537
538
539
540

    get:
      summary: Test the notification endpoint
      description: >
541
542
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

558
            Shall be returned when the notification endpoint has been tested successfully.
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
576
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
577
        401:
578
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
579
        403:
580
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
581
        404:
582
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
583
        405:
584
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
585
        406:
586
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
587
        500:
588
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
589
        503:
590
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613

  ###############################################################################
  # Notification endpoint PnfdOnBoardingNotification                            #
  ###############################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_PnfdOnBoardingNotification':
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
614
        The POST method delivers a notification from the API producer to the API consumer.
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: PnfdOnBoardingNotification
          description: >
            A notification about the successful on-boarding of a PNFD.
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
            204 NO CONTENT

645
            Shall be returned when the notification has been delivered successfully.
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
662
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
663
        401:
664
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
665
        403:
666
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
667
        404:
668
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
669
        405:
670
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
671
        406:
672
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
673
        500:
674
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
675
        503:
676
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
677
678
679
680

    get:
      summary: Test the notification endpoint
      description: >
681
682
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

698
            Shall be returned when the notification endpoint has been tested successfully.
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
716
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
717
        401:
718
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
719
        403:
720
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
721
        404:
722
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
723
        405:
724
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
725
        406:
726
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
727
        500:
728
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
729
        503:
730
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753

  ###############################################################################
  # Notification endpoint PnfdOnBoardingFailureNotification                     #
  ###############################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_PnfdOnBoardingFailureNotification':
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
754
        The POST method delivers a notification from the API producer to the API consumer.
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: PnfdOnBoardingFailureNotification
          description: >
            A notification about the failure of on-boarding a PNFD.
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingFailureNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
            204 NO CONTENT

785
            Shall be returned when the notification has been delivered successfully.
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
802
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
803
        401:
804
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
805
        403:
806
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
807
        404:
808
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
809
        405:
810
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
811
        406:
812
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
813
        500:
814
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
815
        503:
816
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
817
818
819
820

    get:
      summary: Test the notification endpoint
      description: >
821
822
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

838
            Shall be returned when the notification endpoint has been tested successfully.
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
856
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
857
        401:
858
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
859
        403:
860
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
861
        404:
862
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
863
        405:
864
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
865
        406:
866
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
867
        500:
868
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
869
        503:
870
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893

  ###############################################################################
  # Notification endpoint PnfdDeletionNotification                              #
  ###############################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_PnfdDeletionNotification':
    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

    post:
      summary: Notify about NSD and PNFD changes
      description: >
894
        The POST method delivers a notification from the API producer to the API consumer.
895
896
897
898
899
900
901
902
903
904
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: PnfdDeletionNotification
          description: >
            A notification about the deletion of an on-boarded PNFD.
          in: body
          required: true
          schema:
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdDeletionNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          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
      responses:
        204:
          description: >
moscatelli's avatar
moscatelli committed
923
            204 NO CONTENT
924

925
            Shall be returned when the notification has been delivered successfully.
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
942
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
943
        401:
944
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
945
        403:
946
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
947
        404:
948
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
949
        405:
950
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
951
        406:
952
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
953
        500:
954
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
955
        503:
956
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
957
958
959
960

    get:
      summary: Test the notification endpoint
      description: >
961
962
        The GET method allows the API producer to test the notification endpoint
        that is provided by the API consumer, e.g. during subscription.
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

978
            Shall be returned when the notification endpoint has been tested successfully.
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
996
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
997
        401:
998
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
999
        403:
1000
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
For faster browsing, not all history is shown. View entire blame