NFVManoFaultManagement.yaml 29.1 KB
Newer Older
1
2
openapi: 3.0.2
info:
Giacomo Bernini's avatar
Giacomo Bernini committed
3
  version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
4
5
6
7
8
9
10
11
12
13
14
  title: SOL009 - NFV-MANO Fault Management interface
  description: >
    SOL009 - NFV-MANO Fault Management 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.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
15
16
  description: ETSI GS NFV-SOL 009 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
17
18
19
20
21
22
23
24

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
25

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

263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
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
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
components:
  parameters:
    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).
379
380
        * NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
                of the notification types to facilitate automated code generation systems.
381
382
383
384
385
386
387
388
389
      type: object
      properties:
        notificationTypes:
          description: >
            Match particular notification types.
            Permitted values:
            * AlarmNotification
            * AlarmClearedNotification
            * AlarmListRebuiltNotification
390
391

            See note.
392
393
394
395
396
397
398
399
400
401
402
403
          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
404
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/PerceivedSeverityType"
405
406
407
408
409
        eventTypes:
          description: >
            Match VNF alarms with an event type listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix  
Giacomo Bernini committed
410
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/EventType"
411
412
413
414
415
416
        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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
  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:
440
    Alarms.Get:
Giacomo Bernini's avatar
Giacomo Bernini committed
441
442
443
444
445
446
447
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
      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"

482
    Alarm.Get:
Giacomo Bernini's avatar
Giacomo Bernini committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
      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"

502
    Alarm.Patch:
Giacomo Bernini's avatar
Giacomo Bernini committed
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
      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"

531
    subscriptions.post.201:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
561
562
563
564
565
566
567
      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"
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
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
    subscriptions.post.303:
      description: >
        303 SEE OTHER

        SShall be returned when a subscription with the same
        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
    subscriptions.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, 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
638

639
    subscriptions.get.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
      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"

691
    subscription.get.200:
Giacomo Bernini's avatar
Giacomo Bernini committed
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

        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"

727
    subscription.delete.204:
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
      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