NSPerformanceManagement.yaml 43.9 KB
Newer Older
1
2
3
swagger: "2.0"

info:
moscatelli's avatar
moscatelli committed
4
  version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: "SOL005 - NS Performance Management Interface"
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - NS Performance Management Interface
8
9
10
11
12
13
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. 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
  license:
14
    name: "ETSI Forge copyright notice"
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact:
17
    name: "NFV-SOL WG"
moscatelli's avatar
moscatelli committed
18

19
externalDocs:
20
21
  description: ETSI GS NFV-SOL 005 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
moscatelli's avatar
moscatelli committed
22

23
basePath: /nspm/v1
moscatelli's avatar
moscatelli committed
24

25
schemes:
26
  - http
27
  - https
moscatelli's avatar
moscatelli committed
28

29
consumes:
30
  - application/json
moscatelli's avatar
moscatelli committed
31

32
produces:
33
  - application/json
moscatelli's avatar
moscatelli committed
34

35
paths:
36
37
38
39
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
40
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
41

42
43
44
  ###############################################################################
  # PM Jobs                                                                     #
  ###############################################################################
45
46
  '/pm_jobs':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
61

62
    post:
rameshnaraya's avatar
rameshnaraya committed
63
      summary: Create a PM job.
64
65
66
67
68
      description: >
        The POST method creates a PM job.
        This method shall follow the provisions specified in the 
        Tables 7.4.2.3.1-1 and 7.4.2.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
69
70
71
        As the result of successfully executing this method, a new 
        "Individual PM job" resource shall exist as defined in 
        clause 7.4.3.
72
      parameters:
73
74
75
76
        - name: CreatePmJobRequest
          in: body
          required: true
          schema:
77
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
            description: >
              The VNF creation parameters.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
95
        201:
96
          description: >
97
            201 CREATED
98

99
            Shall be returned when the PM job has been created successfully.
100
101
102
103
            The response body shall contain a representation of
            the created PM job resource, as defined in clause 7.5.2.7.
            The HTTP response shall include a "Location" HTTP
            header that points to the created PM job resource.          
104
          schema:
105
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
rameshnaraya's avatar
rameshnaraya committed
106
107
          headers:
            Content-Type:
108
              type: string
rameshnaraya's avatar
rameshnaraya committed
109
110
111
112
113
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
            WWW-Authenticate:
114
              type: string
rameshnaraya's avatar
rameshnaraya committed
115
116
117
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
118
119
                has provided an invalid authorization token.
              maximum: 1
120
121
122
123
124
125
126
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
127
        400:
128
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
129
        401:
130
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
131
        403:
132
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
133
        404:
134
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
135
        405:
136
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
137
        406:
138
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
139
        500:
140
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
141
        503:
142
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
143
144

    get:
rameshnaraya's avatar
rameshnaraya committed
145
      summary: Query PM jobs.
146
147
      description: >
        The client can use this method to retrieve information about PM jobs.
148
      parameters:
149
150
        - name: filter
          in: query
151
          required: false
152
153
          type: string
          description: >
154
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
155
156
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
157
            All attribute names that appear in the PmJob and in data types referenced from it
158
            shall be supported by the NFVO in the filter expression.
159
160
        - name: all_fields
          in: query
161
          required: false
162
163
          type: string
          description: >
164
165
166
            Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013
            for details. The NFVO shall support this parameter.
        - name: fields
167
          in: query
168
          required: false
169
170
          type: string
          description: >
171
172
173
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013
            for details. The NFVO should support this parameter.
        - name: exclude_fields
174
          in: query
175
          required: false
176
177
          type: string
          description: >
178
179
            Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013
            for details. The NFVO should support this parameter.
180
181
        - name: exclude_default
          in: query
182
          required: false
183
184
185
          type: string
          description: >
            Indicates to exclude the following complex attributes from the response.
186
187
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this 
            parameter.
188
189
190
            The following attributes shall be excluded from the PmJob structure in the response
            body if this parameter is provided, or none of the parameters "all_fields," "fields",
            "exclude_fields", "exclude_default" are provided:
191
192
193
194
            reports.
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
195
196
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of 
            ETSI GS NFV-SOL 013 for this resource.
197
198
199
          in: query
          required: false
          type: string
200
201
202
203
204
205
206
207
208
209
210
211
212
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
213
          type: string
214
      responses:
rameshnaraya's avatar
rameshnaraya committed
215
216
        200:
          description: >
217
            200 OK
218

219
220
            Shall be returned when information about zero or more PM jobs has been queried successfully.
            The response body shall contain in an array the representations of
221
            zero or more PM jobs, as defined in clause 7.5.2.7.
222
223
224
225
226
227
228
229
230
231

            If the "filter" URI parameter or one of the "all_fields", "fields", "include_fields",
            "exclude_fields" or "exclude_default" URI parameters was supplied in the request and is
            supported, the data in the response body shall have been transformed according to the 
            rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV SOL 013, respectively.
            
            If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of 
            ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 5.4.2.3 of 
            ETSI GS NFV SOL 013.
232
          headers:
rameshnaraya's avatar
rameshnaraya committed
233
234
235
236
237
238
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
239
              type: string
rameshnaraya's avatar
rameshnaraya committed
240
241
              description: >
                Challenge if the corresponding HTTP request has not provided
242
243
244
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
245
246
247
248
249
250
251
252
253
254
255
256
257
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
rameshnaraya's avatar
rameshnaraya committed
258
259
260
          schema:
            type: array
            items:
261
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
262
        400:
263
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
264
        401:
265
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
266
        403:
267
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
268
269
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
270
        405:
271
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
272
        406:
273
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
274
        500:
275
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
276
        503:
277
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
278
279
280
281

  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
282
283
284
285
286
287
  '/pm_jobs/{pmJobId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.3
    parameters:
      - name: pmJobId
        description: >
          Identifier of the PM job.
rameshnaraya's avatar
rameshnaraya committed
288
289
290
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
          to a POST request creating a new PM job resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.          
291
292
293
        in: path
        type: string
        required: true
294
295
296
297
298
299
300
301
302
303
304
305
306
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: true
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
307

308
    get:
rameshnaraya's avatar
rameshnaraya committed
309
      summary: Read a single PM job.
310
311
312
313
314
315
      description: >
        The client can use this method for reading an individual PM job.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
316
            Reference: IETF RFC 7231.
317
318
319
320
321
          in: header
          required: true
          type: string
      responses:
        200:
322
323
          description: >
            200 OK
324

325
326
            Shall be returned when information about an individual 
            PM job has been queried successfully.
327
328
            The response body shall contain a representation of
            the PM job resource, as defined in clause 7.5.2.7.            
rameshnaraya's avatar
rameshnaraya committed
329
          schema:
330
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
331
          headers:
rameshnaraya's avatar
rameshnaraya committed
332
            Content-Type:
333
              type: string
rameshnaraya's avatar
rameshnaraya committed
334
335
336
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
337
            WWW-Authenticate:
338
              type: string
339
340
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
341
342
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
343
344
              maximum: 1
              minimum: 0
345
346
347
348
349
350
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
351
        400:
352
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
353
        401:
354
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
355
        403:
356
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
357
358
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
359
        405:
360
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
361
        406:
362
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
363
        500:
364
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
365
        503:
366
367
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

368
    delete:
rameshnaraya's avatar
rameshnaraya committed
369
      summary: Delete a PM job.
370
371
372
373
      description: >
        This method terminates an individual PM job.
      responses:
        204:
374
          description: >
375
            204 NO CONTENT
376

377
378
379
380
            The PM job was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
381
              type: string
382
383
              description: >
                Challenge if the corresponding HTTP request has not provided
384
385
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
386
387
              maximum: 1
              minimum: 0
388
389
390
391
392
393
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
394
        400:
395
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
396
        401:
397
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
398
        403:
399
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
400
401
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
402
        405:
403
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
404
        406:
405
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
406
        500:
407
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
408
        503:
409
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
410

411
412
413
  ###############################################################################
  # Individual performance report                                               #
  ###############################################################################
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
  '/pm_jobs/{pmJobId}/reports/{reportId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.4
    parameters:
      - name: pmJobId
        description: >
          Identifier of the PM job.
        in: path
        type: string
        required: true
      - name: reportId
        description: >
          Identifier of the performance report.
        in: path
        type: string
        required: true
429
430
431
432
433
434
435
436
437
438
439
440
441
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: true
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
442

443
    get:
rameshnaraya's avatar
rameshnaraya committed
444
      summary: Read an individual performance report.
445
446
447
448
449
450
451
      description: >
        The client can use this method for reading an individual performance
        report.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
452
            Reference: IETF RFC 7231.
453
454
455
456
457
          in: header
          required: true
          type: string
      responses:
        200:
458
459
460
461
462
463
464
          description: >
            200 OK

            Information of an individual performance report was read successfully.
            The response body shall contain a representation of
            the performance report resource, as defined in
            clause 7.5.2.10.
rameshnaraya's avatar
rameshnaraya committed
465
          schema:
466
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PerformanceReport"
467
          headers:
rameshnaraya's avatar
rameshnaraya committed
468
            Content-Type:
469
              type: string
rameshnaraya's avatar
rameshnaraya committed
470
471
472
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
473
            WWW-Authenticate:
474
              type: string
475
476
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
477
478
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
479
480
              maximum: 1
              minimum: 0
481
482
483
484
485
486
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
487
        400:
488
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
489
        401:
490
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
491
        403:
492
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
493
494
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
495
        405:
496
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
497
        406:
498
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
499
        500:
500
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
501
        503:
502
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
503

504
505
506
  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
507
  '/thresholds':
508
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5
509
510
511
512
513
514
515
516
517
518
519
520
521
522
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
523

524
    post:
rameshnaraya's avatar
rameshnaraya committed
525
      summary: Create a threshold.
526
      description: >
527
        The POST method can be used by the client to create a threshold.
528

529
530
531
        This method shall follow the provisions specified in the 
        table 7.4.5.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
532
      parameters:
533
534
535
536
        - name: CreateThresholdRequest
          in: body
          required: true
          schema:
537
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
            description: >
              Request parameters to create a threshold resource.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
554
555
      responses:
        201:
556
          description: >
557
            201 CREATED
558

559
560
561
562
563
564
            A threshold was created successfully.
            The response body shall contain a representation of
            the created threshold resource, as defined in clause 7.5.2.9.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the created
            threshold resource.            
rameshnaraya's avatar
rameshnaraya committed
565
          schema:
566
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
567
          headers:
rameshnaraya's avatar
rameshnaraya committed
568
            Content-Type:
569
              type: string
rameshnaraya's avatar
rameshnaraya committed
570
571
572
573
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
574
            WWW-Authenticate:
575
              type: string
576
577
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
578
579
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
580
581
              maximum: 1
              minimum: 0
582
583
584
585
586
587
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
588
        400:
589
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
590
        401:
591
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
592
        403:
593
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
594
595
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
596
        405:
597
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
598
        406:
599
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
600
        500:
601
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
602
        503:
603
604
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

605
    get:
606
      summary: Query thresholds.
607
608
609
      description: >
        The client can use this method to query information about thresholds.
      parameters:
610
611
        - name: filter
          in: query
612
          required: false
613
614
          type: string
          description: >
615
616
617
618
619
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the Thresholds data type and in data types referenced from it
            shall be supported by the NFVO in the filter expression.
620
621
622
623
624
625
626
        - name: nextpage_opaque_marker
          in: query
          required: false
          type: string
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
627
628
629
630
631
632
633
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
634
635
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
636
          description: >
637
            200 OK
638

rameshnaraya's avatar
rameshnaraya committed
639
            Information about zero or more thresholds was queried successfully.
640
            The response body shall contain representations of
rameshnaraya's avatar
rameshnaraya committed
641
            zero or more thresholds, as defined in clause 7.5.2.9.
642
          headers:
rameshnaraya's avatar
rameshnaraya committed
643
644
            Content-Type:
              description: The MIME type of the body of the response.
645
              type: string
rameshnaraya's avatar
rameshnaraya committed
646
647
              maximum: 1
              minimum: 1
648
            WWW-Authenticate:
649
              type: string
650
651
              description: >
                Challenge if the corresponding HTTP request has not provided
652
653
654
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
655
656
657
658
659
660
661
662
663
664
665
666
667
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
668
669
          schema:
            type: array
rameshnaraya's avatar
rameshnaraya committed
670
            items:
671
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
672
        400:
673
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
674
        401:
675
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
676
        403:
677
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
678
679
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
680
        405:
681
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
682
        406:
683
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
684
        500:
685
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
686
        503:
687
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
688
689
690
691

  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
692
  '/thresholds/{thresholdId}':
693
694
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.6
    parameters:
695
696
697
698
699
700
701
702
703
704
      - name: thresholdId
        description: >
          Identifier of the threshold.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new threshold resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
705
706
707
708
709
710
711
712
713
714
715
716
717
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: true
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
718

719
    get:
rameshnaraya's avatar
rameshnaraya committed
720
      summary: Query a single threshold.
721
722
      description: >
        The client can use this method for reading an individual threshold.
rameshnaraya's avatar
rameshnaraya committed
723
724
725
        This method shall follow the provisions specified in the 
        Tables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
726
727
728
729
730
731
732
733
734
735
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
736
737
          description: >
            200 OK
738

739
740
741
            Information about an individual threshold was queried successfully.
            The response body shall contain a representation of
            the threshold, as defined in clause 7.5.2.9.            
rameshnaraya's avatar
rameshnaraya committed
742
          schema:
743
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
744
          headers:
rameshnaraya's avatar
rameshnaraya committed
745
            Content-Type:
746
              type: string
rameshnaraya's avatar
rameshnaraya committed
747
748
749
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
750
            WWW-Authenticate:
751
              type: string
752
753
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
754
755
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
756
757
              maximum: 1
              minimum: 0
758
759
760
761
762
763
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
764
        400:
765
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
766
        401:
767
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
768
        403:
769
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
770
771
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
772
        405:
773
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
774
        406:
775
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
776
        500:
777
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
778
        503:
779
780
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

781
    delete:
rameshnaraya's avatar
rameshnaraya committed
782
      summary: Delete a threshold.
783
784
785
786
787
788
789
790
791
792
793
794
      description: >
        This method allows to delete a threshold.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
795
          description: >
moscatelli's avatar
moscatelli committed
796
            204 NO CONTENT
797

798
799
800
801
            The threshold was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
802
              type: string
803
804
              description: >
                Challenge if the corresponding HTTP request has not provided
805
806
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
807
808
              maximum: 1
              minimum: 0
809
810
811
812
813
814
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
815
        400:
816
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
817
        401:
818
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
819
        403:
820
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
821
822
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
823
        405:
824
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
825
        406:
826
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
827
        500:
828
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
829
        503:
830
831
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

832
833
834
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
835
836
  '/subscriptions':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.7
837
838
839
840
841
842
843
844
845
846
847
848
849
850
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
851

852
    post:
rameshnaraya's avatar
rameshnaraya committed
853
      summary: Subscribe to PM notifications.
854
855
856
857
      description: >
        The POST method creates a new subscription.
        This method shall follow the provisions specified in the Tables 7.4.7.3.1-1 and 7.4.7.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
rameshnaraya's avatar
rameshnaraya committed
858
859
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
860
        Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
rameshnaraya's avatar
rameshnaraya committed
861
862
863
        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 subscription resource (in which case it shall return a "303 See Other" response code referencing
        the existing subscription resource with the same filter and callbackUri)
864
      parameters:
865
866
867
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
868
            Reference: IETF RFC 7231.
869
870
871
872
873
874
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
875
            Reference: IETF RFC 7231.
876
877
878
879
880
881
882
          in: header
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
883
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
884
885
            description: >
              Details of the subscription to be created.
886
887
      responses:
        201:
888
          description: >
889
            201 CREATED
890

891
892
893
894
895
            The subscription was created successfully.
            A representation of the created subscription resource
            shall be returned in the response body, as defined in clause 7.5.2.3.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the created subscription resource.            
rameshnaraya's avatar
rameshnaraya committed
896
          schema:
897
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
898
          headers:
rameshnaraya's avatar
rameshnaraya committed
899
            Content-Type:
900
              type: string
rameshnaraya's avatar
rameshnaraya committed
901
902
903
904
905
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
              maximum: 1
906
              minimum: 1
907
            WWW-Authenticate:
908
              type: string
909
910
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
911
912
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
913
              maximum: 1
914
915
916
917
918
919
920
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
921
        303:
922
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
923
        400:
924
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
925
        401:
926
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
927
        403: