NFVManoFaultManagement.yaml 30.2 KB
Newer Older
1
openapi: 3.0.2
2

3
4
info:
  title: SOL009 - NFV-MANO Fault Management interface
5
  description: |
6
7
    SOL009 - NFV-MANO Fault Management interface

8
9
10
11
12
    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.

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

14
15
  contact:
    name: NFV-SOL WG
16
17
18
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
19
20
  version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1

21
externalDocs:
22
  description: ETSI GS NFV-SOL 009 V3.6.1
23
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
24
25
26
27
28
29
30
31

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

paths:
  /api_versions:
    $ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
Giacomo Bernini's avatar
upd    
Giacomo Bernini committed
32

33
34
35
  /alarms:
    get:
      description: >
36
        The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2.
37
      parameters:
38
39
40
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
Giacomo Bernini's avatar
Giacomo Bernini committed
41
        - $ref: "#/components/parameters/filter.Alarms"
42
        - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
43
44
      responses:
        "200":
Muhammad Hamza's avatar
Muhammad Hamza committed
45
          $ref: '#/components/responses/Alarms.Get.200'
46
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
47
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
48
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
49
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
50
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
51
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
52
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
53
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
54
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
55
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
56
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
57
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
58
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
59
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
60
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
61
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
62
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
63
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
64
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
65
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
66
67
  "/alarms/{alarmId}":
    parameters:
68
      - $ref: "#/components/parameters/alarmId"
69
70
    get:
      description: >
71
        The client can use this method to read an individual alarm. See clause 7.5.4.3.2.
72
      parameters:
73
74
75
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
76
77
      responses:
        "200":
Muhammad Hamza's avatar
Muhammad Hamza committed
78
          $ref: '#/components/responses/Alarm.Get.200'
79
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
80
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
81
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
82
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
83
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
84
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
85
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
86
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
87
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
88
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
89
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
90
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
91
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
92
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
93
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
94
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
95
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
96
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
97
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
98
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
99
100
    patch:
      description: >
101
        This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4.
102
      parameters:
103
104
105
106
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
107
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
108
        $ref: "#/components/requestBodies/AlarmModifications"
109
110
      responses:
        "200":
Muhammad Hamza's avatar
Muhammad Hamza committed
111
          $ref: '#/components/responses/Alarm.Patch.200'
112
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
113
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
114
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
115
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
116
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
117
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
118
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
119
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
120
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
121
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
122
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
123
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
124
        "409":
Giacomo Bernini's avatar
Giacomo Bernini committed
125
          $ref: ../components/SOL009_resp.yaml#/components/responses/409
126
        "412":
Giacomo Bernini's avatar
Giacomo Bernini committed
127
          $ref: ../components/SOL009_resp.yaml#/components/responses/412
128
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
129
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
130
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
131
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
132
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
133
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
134
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
135
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
136
137
138
  /subscriptions:
    post:
      description: >
139
        The POST method creates a new subscription. See clause 7.5.5.3.1.
140
      parameters:
141
142
143
144
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
145
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
146
        $ref: "#/components/requestBodies/FmSubscriptionRequest"
147
148
      responses:
        "201":
Muhammad Hamza's avatar
Muhammad Hamza committed
149
          $ref: '#/components/responses/Subscriptions.Post.201'
150
        "303":
Giacomo Bernini's avatar
Giacomo Bernini committed
151
          $ref: ../components/SOL009_resp.yaml#/components/responses/303
152
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
153
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
154
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
155
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
156
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
157
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
158
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
159
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
160
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
161
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
162
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
163
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
164
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
165
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
166
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
167
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
168
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
169
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
170
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
171
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
172
173
174
    get:
      description: >
        The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
175
176
        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.
        See clause 7.5.5.3.2.
177
      parameters:
178
179
180
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
Giacomo Bernini's avatar
Giacomo Bernini committed
181
        - $ref: "#/components/parameters/filter.FmSubscriptions"
182
        - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
183
184
      responses:
        "200":
Muhammad Hamza's avatar
Muhammad Hamza committed
185
          $ref: '#/components/responses/Subscriptions.Get.200'
186
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
187
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
188
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
189
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
190
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
191
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
192
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
193
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
194
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
195
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
196
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
197
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
198
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
199
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
200
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
201
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
202
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
203
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
204
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
205
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
206
207
  "/subscriptions/{subscriptionId}":
    parameters:
208
      - $ref: "#/components/parameters/subscriptionId"
209
210
    get:
      description: >
211
212
        The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms
        subscribed by the client. See clause 7.5.6.3.2.
213
      parameters:
214
215
216
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
217
218
      responses:
        "200":
Muhammad Hamza's avatar
Muhammad Hamza committed
219
          $ref: '#/components/responses/Subscription.Get.200'
220
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
221
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
222
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
223
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
224
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
225
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
226
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
227
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
228
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
229
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
230
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
231
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
232
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
233
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
234
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
235
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
236
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
237
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
238
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
239
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
240
241
    delete:
      description: >
242
        This method terminates an individual subscription. See clause 7.5.6.3.5.
243
      parameters:
244
245
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
246
247
      responses:
        "204":
Muhammad Hamza's avatar
Muhammad Hamza committed
248
          $ref: '#/components/responses/Subscription.Delete.204'
249
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
250
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
251
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
252
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
253
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
254
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
255
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
256
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
257
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
258
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
259
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
260
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
261
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
262
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
263
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
264
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
265
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
266
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
267
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
268
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
269

270
271
components:
  parameters:
Giacomo Bernini's avatar
Giacomo Bernini committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
    filter.Alarms:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.

        The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string.
        The API consumer may supply this parameter.

        The following attribute names shall be supported by the NFV-MANO functional entity in the attribute-based
        filtering expression: id, managedObjectId, eventType, perceivedSeverity, probableCause.

      in: query
      required: false
      schema:
        type: string
    filter.FmSubscriptions:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.

        The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string.
        The API consumer may supply this parameter.

        All attribute names that appear in the FmSubscription and in data types referenced from it shall be supported
        by the NFV-MANO functional entity in the filter expression.
      in: query
      required: false
      schema:
        type: string
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
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
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
    alarmId:
      name: alarmId
      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.
      in: path
      required: true
      schema:
        type: string
    subscriptionId:
      name: subscriptionId
      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 "Individual subscription" resource.
        It can also be retrieved from the "id" attribute in the payload body
        of that response.
      in: path
      required: true
      schema:
        type: string
  schemas:
    FmSubscriptionRequest:
      description: >
        This type represents a subscription request related to notifications
        about NFV-MANO faults.
      type: object
      required:
        - callbackUri
      properties:
        filter:
          description: >
            Filter settings for this subscription, to define the subset of all
            notifications this subscription relates to. A particular
            notification is sent to the subscriber if the filter matches, or if
            there is no filter.
          $ref: "#/components/schemas/FmNotificationsFilter"
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        authentication:
          description: >
            Authentication parameters to configure the use of Authorization when sending notifications
            corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
            This attribute shall only be present if the subscriber requires authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"

    FmSubscription:
      description: >
        This type represents a subscription related to notifications about VNF
        faults.
      type: object
      required:
        - id
        - callbackUri
        - _links
      properties:
        id:
          description: >
            Identifier of this "Individual subscription" resource.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        filter:
          description: >
            Filter settings for this subscription, to define the subset of all
            notifications this subscription relates to. A particular
            notification is sent to the subscriber if the filter matches, or if
            there is no filter.
          $ref: "#/components/schemas/FmNotificationsFilter"
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        _links:
          description: >
            Links for this resource.
          type: object
          required:
            - self
          properties:
            self:
              description: >
                URI of this resource.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"

    AlarmModifications:
      description: >
        This type represents attribute modifications for an "Individual alarm"
        resource, i.e. modifications to a resource representation based on the
        "Alarm" data type. The attributes of "Alarm" that can be modified
        are included in the "AlarmModifications" data type.
      type: object
      required:
        - ackState
      properties:
        ackState:
          description: >
            New value of the "ackState" attribute in "Alarm".
            Permitted values:
            * ACKNOWLEDGED
          type: string
          enum:
            - ACKNOWLEDGED

    FmNotificationsFilter:
      description: >
        This type represents a subscription filter related to notifications about NFV-MANO functional entity faults.
        It shall comply with the provisions defined in table 7.6.3.2-1. At a particular nesting level in the filter
        structure, the following applies: All attributes shall match in order for the filter to match (logical "and"
        between different filter attributes). If an attribute is an array, the attribute shall match if at least one
        of the values in the array matches (logical "or" between the values of one filter attribute).
415
416
        * NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
                of the notification types to facilitate automated code generation systems.
417
418
419
420
421
422
423
424
425
      type: object
      properties:
        notificationTypes:
          description: >
            Match particular notification types.
            Permitted values:
            * AlarmNotification
            * AlarmClearedNotification
            * AlarmListRebuiltNotification
426
427

            See note.
428
429
430
431
432
433
434
435
436
437
438
439
          type: array
          items:
            type: string
            enum:
              - AlarmNotification
              - AlarmClearedNotification
              - AlarmListRebuiltNotification
        perceivedSeverities:
          description: >
            Match VNF alarms with a perceived severity listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
440
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/PerceivedSeverityType"
441
442
443
444
445
        eventTypes:
          description: >
            Match VNF alarms with an event type listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
446
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/EventType"
447
448
449
450
451
452
        probableCauses:
          description: >
            Match VNF alarms with a probable cause listed in this attribute.
          type: array
          items:
            type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
  requestBodies:
    AlarmModifications:
      description: >
        The parameter for the alarm modification, as defined in clause
        7.6.2.8. The Content-Type header shall be set to
        "application/merge-patch+json" according to IETF RFC 7396.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AlarmModifications"
      required: true

    FmSubscriptionRequest:
      description: >
        Details of the subscription to be created, as defined in clause
        7.6.2.2.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FmSubscriptionRequest"
      required: true

  responses:
Muhammad Hamza's avatar
Muhammad Hamza committed
476
    Alarms.Get.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
515
516
517
      description: >
        200 OK

        Shall be returned when information about zero or more alarms has been queried successfully.
        The response body shall contain in an array the representations of zero or more alarms as defined
        in clause 7.6.2.4. 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.
        If the NFV-MANO functional entity 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:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1
        Link:
          description: >
            Reference to other resources. Used for paging in the present
            document.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"

Muhammad Hamza's avatar
Muhammad Hamza committed
518
    Alarm.Get.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
      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:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"

Muhammad Hamza's avatar
Muhammad Hamza committed
538
    Alarm.Patch.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
      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 7.6.2.4).
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        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.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AlarmModifications"

Muhammad Hamza's avatar
Muhammad Hamza committed
567
    Subscriptions.Post.201:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
596
597
598
599
600
601
602
603
      description: >
        201 CREATED

        Shall be returned when the subscription has been created successfully. The response body shall contain a
        representation of the created "Individual subscription" resource. The HTTP response shall include a
        "Location:"" HTTP header that points to the created "Individual subscription" resource.
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        Location:
          description: |
            The resource URI of the created subscription resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
        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.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FmSubscription"
Muhammad Hamza's avatar
Muhammad Hamza committed
604
    Subscriptions.Post.303:
605
606
607
      description: >
        303 SEE OTHER

Muhammad Hamza's avatar
Muhammad Hamza committed
608
        Shall be returned when a subscription with the same
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
        callbackURI and the same filter already exists and the
        policy of NFV-MANO functional entity 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:
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
        Location:
          description: >
            The resource URI of the created "Individual subscription" resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
Muhammad Hamza's avatar
Muhammad Hamza committed
639
    Subscriptions.Post.422:
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
669
670
671
672
673
      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, 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 API producer has tested the Notification endpoint as
        described in clause 7.5.7.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:
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
Giacomo Bernini's avatar
Giacomo Bernini committed
674

Muhammad Hamza's avatar
Muhammad Hamza committed
675
    Subscriptions.Get.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
      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 7.6.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. If the NFV-MANO
        functional entity 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:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1
        Link:
          description: >
            Reference to other resources. Used for paging in the present
            document, see clause 4.7.2.1.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/FmSubscription"

Muhammad Hamza's avatar
Muhammad Hamza committed
727
    Subscription.Get.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
      description: >
        200 OK

        The operation has completed successfully. The response body shall contain a representation of the
        subscription resource.
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FmSubscription"

Muhammad Hamza's avatar
Muhammad Hamza committed
763
    Subscription.Delete.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
      description: >
        204 NO CONTENT

        Shall be returned when the "Individual subscription" resource has been deleted successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the corresponding HTTP
            request has provided an invalid authorization token.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1