NSFaultManagement.yaml 28.2 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
4
5
  title: SOL005 - NS Fault Management Interface
  description: |
rameshnaraya's avatar
rameshnaraya committed
6
    SOL005 - NS Fault Management Interface
7
8
9
10
11

    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.

12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
13

14
15
  contact:
    name: NFV-SOL WG
16
  license:
17
    name: ETSI Forge copyright notice
18
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Giacomo Bernini's avatar
Giacomo Bernini committed
19
  version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
20

21
externalDocs:
22
  description: ETSI GS NFV-SOL 005 V3.6.1
23
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf
24
25
26
27
28

servers:
  - url: http://127.0.0.1/nsfm/v1
  - url: https://127.0.0.1/nsfm/v1

29
paths:
30
31
  /api_versions:
    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
32

33
  /alarms:
34
    parameters:
35
36
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
37
    get:
38
      description: |
39
        The API consumer can use this method to retrieve information about the alarm list. See clause 8.4.2.3.2.
40
      parameters:
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
        - in: query
          name: filter
          description:  >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            The following attribute names shall be supported by the NFVO in the filter expression:
            -	id
            -	nsInstanceId
            -	rootCauseFaultyComponent.faultyNestedNsInstanceId
            -	rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId
            -	rootCauseFaultyComponent.faultyVnfInstanceId
            -	rootCauseFaultyResource.faultyResourceType
            -	eventType
            -	perceivedSeverity
            -	probableCause
          schema:
            type: string
59
60
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
61
      responses:
62
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
63
          $ref: '#/components/responses/Alarms.Get.200'
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "416":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
84

85
  /alarms/{alarmId}:
86
    parameters:
87
88
89
      - $ref: '#/components/parameters/AlarmId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
90
    get:
91
      description: |
92
        The API consumer can use this method to read an individual alarm. See clause 8.4.3.3.2.
93
      parameters:
94
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
95
      responses:
96
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
97
          $ref: '#/components/responses/IndividualAlarm.Get.200'
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "416":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
118

119
    patch:
120
      description: |
121
        This method modifies an individual alarm resource. See clause 8.4.3.3.4.
122
      parameters:
123
124
125
126
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmModificationRequest'
127
      responses:
128
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
129
          $ref: '#/components/responses/IndividualAlarm.Patch.200'
130
131
132
133
134
135
136
137
138
139
140
141
142
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
143
          $ref: '#/components/responses/IndividualAlarm.Patch.409'
144
        "412":
145
          $ref: '#/components/responses/IndividualAlarm.Patch.412'
146
147
148
149
150
151
152
153
        "416":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
154

155
  /subscriptions:
156
    parameters:
157
158
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
159
    get:
160
      description: |
161
162
163
        The API consumer can use this method to retrieve the list of active subscriptions for alarms related to an
        NS subscribed by the API consumer. It can be used e.g. for resynchronization after error situations.
        See clause 8.4.4.3.2.
164
      parameters:
165
166
167
168
169
170
171
172
173
174
        - in: query
          name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the FmSubscription and in data types referenced from 
            it shall be supported by the NFVO in the filter expression.
          schema:
            type: string
175
176
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
177
      responses:
178
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
179
          $ref: '#/components/responses/FmSubscriptions.Get.200'
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
198

199
200
    post:
      description: |
201
        The POST method creates a new subscription. See clause 8.4.4.3.1.
202
203
204
205
206
207
208
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/FmSubscriptionRequest'
      responses:
        "201":
Giacomo Bernini's avatar
Giacomo Bernini committed
209
          $ref: '#/components/responses/FmSubscriptions.Post.201'
210
        "303":
211
          $ref: '#/components/responses/FmSubscriptions.Post.303'
212
213
214
215
216
217
218
219
220
221
222
223
224
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "422":
225
          $ref: '#/components/responses/FmSubscriptions.Post.422'
226
227
228
229
230
231
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
232

233
  /subscriptions/{subscriptionId}:
234
    parameters:
235
236
237
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
238
    get:
239
      description: |
240
241
        The API consumer can use this method for reading an individual subscription for alarms related to NSs
        subscribed by the API consumer. See clause 8.4.5.3.2.
242
      parameters:
243
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
244
      responses:
245
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
246
          $ref: '#/components/responses/IndividualFmSubscription.Get.200'
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
265

266
    delete:
267
      description: |
268
        This method terminates an individual subscription. See clause 8.4.5.3.5.
269
      responses:
270
        "204":
Giacomo Bernini's avatar
Giacomo Bernini committed
271
          $ref: '#/components/responses/IndividualFmSubscription.Delete.204'
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
290

291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
components:
  parameters:
    AlarmId:
      name: alarmId
      in: path
      description: |
        Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute
        in the AlarmNotification or AlarmClearedNotification.  It can also be retrieved from the "id" attribute of
        the applicable array element in the payload body of the response to a GET request to the "Alarms" resource.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
        Identifier of this subscription. This identifier can be retrieved from the resource referenced by the
        "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also
        be retrieved from the "id" attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

  requestBodies:
    AlarmModificationRequest:
      description: |
        The parameter for the alarm modification, as defined in clause 8.5.2.8.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications
      required: true

    FmSubscriptionRequest:
      description: |
        Details of the subscription to be created, as defined in clause 8.5.2.2.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest
      required: true

  responses:
Giacomo Bernini's avatar
Giacomo Bernini committed
339
    Alarms.Get.200:
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
      description: |
        200 OK
        Shall be returned when information about zero or more alarms has been queried successfully. The response body
        shall contain the list of related alarms. If the "filter" URI parameter was supplied in the request, the data
        in the response body shall have been transformed according to the rules specified in clauses 5.2.2 of ETSI GS
        NFV-SOL 013. If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
        for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause
        5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm

Giacomo Bernini's avatar
Giacomo Bernini committed
384
    IndividualAlarm.Get.200:
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
      description: |
        200 OK
        Shall be returned when information about an individual alarm has been read successfully. The response body
        shall contain a representation of the individual alarm.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm

Giacomo Bernini's avatar
Giacomo Bernini committed
416
    IndividualAlarm.Patch.200:
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
      description: |
        200 OK
        Shall be returned when the request has been accepted and completed. The response body shall contain attribute
        modifications for an 'Individual alarm' resource (see clause 8.5.2.8).
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications

448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
505
506
507
508
509
510
511
512
513
514
    IndividualAlarm.Patch.409:
      description: |
        409 CONFLICT
        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
        with the state of the "Individual alarm" resource.
        Typically, this is due to the fact that the alarm is already in the state that is requested to be set
        (such as trying to acknowledge an already-acknowledged alarm).
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualAlarm.Patch.412:
      description: |
        412 Precondition Failed

        Shall be returned upon the following error: A precondition given in an HTTP request header is not fulfilled.
        Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
        The response body should contain a ProblemDetails structure, in which the "detail" attribute should
        convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string

Giacomo Bernini's avatar
Giacomo Bernini committed
515
    FmSubscriptions.Get.200:
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
      description: |
        200 OK
        Shall be returned when the list of subscriptions has been queried successfully. The response body shall
        contain in an array the representations of all active subscriptions of the functional block that invokes the
        method, i.e. zero or more representations of FM subscriptions, as defined in clause 8.5.2.3. If the "filter"
        URI parameter was supplied in the request, the data in the response body shall have been transformed according
        to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013 [16]. If the NFVO supports alternative 2 (paging)
        according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource, inclusion of the Link HTTP header
        in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 [16].
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription

Giacomo Bernini's avatar
Giacomo Bernini committed
561
    FmSubscriptions.Post.201:
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
      description: |
        201 Created
        Shall be returned when the subscription has been created successfully. The response body shall contain a
        representation of the created subscription resource. The HTTP response shall include a "Location:" HTTP
        header that points to the created subscription resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription

596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
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
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
    FmSubscriptions.Post.303:
      description: |
        303 See Other
        Shall be returned when a subscription with the same callback URI and the same filter already exists and the
        policy of the NFVO is to not create redundant subscriptions.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
        "Individual subscription" resource.
        The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Location:
          description: The resource URI of the created NS instance
          style: simple
          explode: false
          schema:
            type: string
            format: url

    FmSubscriptions.Post.422:
      description: |
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type of the payload body is supported and the payload
        body of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 8.4.6.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about
        the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

Giacomo Bernini's avatar
Giacomo Bernini committed
669
    IndividualFmSubscription.Get.200:
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
      description: |
        200 OK
        Shall be returned when information about an individual subscription has been read successfully. The response
        body shall contain a representation of the subscription resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription

Giacomo Bernini's avatar
Giacomo Bernini committed
702
    IndividualFmSubscription.Delete.204:
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
      description: |
        204 - No Content
        Shall be returned when the subscription resource has been deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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
      content: {}