NFVManoFaultManagement.yaml 29.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  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:
Giacomo Bernini's avatar
Giacomo Bernini committed
15
16
  description: ETSI GS NFV-SOL 009 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.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
29
30
31
32
33
  /alarms:
    get:
      description: >
        Get Alarm List. The client can use this method to retrieve information
        about the alarm list. This method shall follow the provisions specified
        in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
34
35
36
37
38
        - $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"
39
40
      responses:
        "200":
41
          $ref: '#/components/responses/Alarms.Get'
42
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
43
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
44
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
45
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
46
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
47
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
48
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
49
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
50
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
51
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
52
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
53
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
54
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
55
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
56
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
57
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
58
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
59
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
60
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
61
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
62
63
  "/alarms/{alarmId}":
    parameters:
64
      - $ref: "#/components/parameters/alarmId"
65
66
67
68
69
70
71
    get:
      description: >
        The client can use this method to read an individual alarm. This method
        shall follow the provisions specified in the tables 7.5.4.3.2-1 and
        7.5.4.3.2-2 for URI query parameters, request and response data
        structures, and response codes.
      parameters:
72
73
74
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
75
76
      responses:
        "200":
77
          $ref: '#/components/responses/Alarm.Get'
78
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
79
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
80
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
81
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
82
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
83
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
84
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
85
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
86
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
87
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
88
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
89
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
90
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
91
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
92
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
93
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
94
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
95
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
96
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
97
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
98
99
100
101
102
103
104
    patch:
      description: >
        This method modifies an "Individual alarm" resource. This method shall
        follow the provisions specified in the tables 7.5.4.3.4-1 and
        7.5.4.3.4-2 for URI query parameters, request and response data
        structures, and response codes.
      parameters:
105
106
107
108
        - $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"
109
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
110
        $ref: "#/components/requestBodies/AlarmModifications"
111
112
      responses:
        "200":
113
          $ref: '#/components/responses/Alarm.Patch'
114
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
115
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
116
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
117
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
118
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
119
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
120
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
121
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
122
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
123
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
124
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
125
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
126
        "409":
Giacomo Bernini's avatar
Giacomo Bernini committed
127
          $ref: ../components/SOL009_resp.yaml#/components/responses/409
128
        "412":
Giacomo Bernini's avatar
Giacomo Bernini committed
129
          $ref: ../components/SOL009_resp.yaml#/components/responses/412
130
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
131
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
132
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
133
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
134
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
135
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
136
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
137
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
  /subscriptions:
    post:
      description: >
        Subscribe. The POST method creates a new subscription. This method shall
        follow the provisions specified in the tables 7.5.5.3.1-1 and
        7.5.5.3.1-2 for URI query parameters, request and response data
        structures, and response codes. As the result of successfully executing
        this method, a new "Individual subscription" resource as defined in
        clause 7.5.6 shall have been created. This method shall not trigger any
        notification. Creation of two "Individual subscription" resources with
        the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the API
        consumer, and might make sense only in very rare use cases.
        Consequently, the NFV-MANO functional entity may either allow creating a
        new "Individual subscription" resource if another "Individual
        subscription" resource with the same filter and callbackUri already
        exists (in which case it shall return the "201 Created" response code),
        or may decide to not create a duplicate "Individual subscription"
        resource (in which case it shall return a "303 See Other" response code
        referencing the existing "Individual subscription" resource with the
        same filter and callbackUri).
      parameters:
160
161
162
163
        - $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"
164
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
165
        $ref: "#/components/requestBodies/FmSubscriptionRequest"
166
167
      responses:
        "201":
168
          $ref: '#/components/responses/Subscriptions.Post'
169
        "303":
Giacomo Bernini's avatar
Giacomo Bernini committed
170
          $ref: ../components/SOL009_resp.yaml#/components/responses/303
171
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
172
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
173
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
174
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
175
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
176
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
177
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
178
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
179
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
180
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
181
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
182
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
183
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
184
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
185
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
186
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
187
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
188
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
189
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
190
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
191
192
193
194
195
196
197
198
199
    get:
      description: >
        Query Subscription Information

        The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. This method
        shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
200
201
202
203
204
        - $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"
205
206
      responses:
        "200":
207
          $ref: '#/components/responses/Subscriptions.Get'
208
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
209
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
210
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
211
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
212
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
213
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
214
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
215
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
216
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
217
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
218
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
219
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
220
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
221
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
222
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
223
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
224
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
225
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
226
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
227
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
228
229
  "/subscriptions/{subscriptionId}":
    parameters:
230
      - $ref: "#/components/parameters/subscriptionId"
231
232
233
234
235
236
237
238
    get:
      description: >
        Query Subscription Information. The client can use this method for
        reading an individual subscription for NFV-MANO functional entity alarms
        subscribed by the client. This method shall follow the provisions
        specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query
        parameters, request and response data structures, and response codes.
      parameters:
239
240
241
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
242
243
      responses:
        "200":
244
          $ref: '#/components/responses/Subscription.Get'
245
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
246
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
247
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
248
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
249
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
250
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
251
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
252
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
253
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
254
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
255
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
256
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
257
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
258
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
259
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
260
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
261
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
262
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
263
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
264
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
265
266
267
268
269
270
271
272
273
274
275
276
277
    delete:
      description: >
        Terminate Subscription. This method terminates an individual
        subscription. This method shall follow the provisions specified in the
        tables 7.5.6.3.5-1 and 7.5.6.3.5-2 for URI query parameters, request and
        response data structures, and response codes. As the result of
        successfully executing this method, the "Individual subscription"
        resource shall not exist any longer. This means that no notifications
        for that subscription shall be sent to the formerly-subscribed API
        consumer. NOTE:	Due to race conditions, some notifications might still
        be received by the formerly-subscribed API consumer for a certain time
        period after the deletion.
      parameters:
278
279
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
280
281
      responses:
        "204":
282
          $ref: '#/components/responses/Subscription.Delete'
283
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
284
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
285
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
286
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
287
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
288
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
289
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
290
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
291
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
292
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
293
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
294
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
295
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
296
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
297
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
298
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
299
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
300
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
301
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
302
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
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
415
416
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
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).

      type: object
      properties:
        notificationTypes:
          description: >
            Match particular notification types.
            Permitted values:
            * AlarmNotification
            * AlarmClearedNotification
            * AlarmListRebuiltNotification
            The permitted values of the "notificationTypes" attribute are
            spelled exactly as the names of the notification types to
            facilitate automated code generation systems.
          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
445
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/PerceivedSeverityType"
446
447
448
449
450
        eventTypes:
          description: >
            Match VNF alarms with an event type listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
451
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/EventType"
452
453
454
455
456
457
        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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
  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:
481
    Alarms.Get:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
518
519
520
521
522
      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"

523
    Alarm.Get:
Giacomo Bernini's avatar
Giacomo Bernini committed
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
      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"

543
    Alarm.Patch:
Giacomo Bernini's avatar
Giacomo Bernini committed
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
      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"

572
    Subscriptions.Post:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
      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"

610
    Subscriptions.Get:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
      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"

662
    Subscription.Get:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
691
692
693
694
695
696
697
      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"

698
    Subscription.Delete:
Giacomo Bernini's avatar
Giacomo Bernini committed
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
      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