NSPerformanceManagement.yaml 42.8 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
      parameters:
70
71
72
73
        - name: CreatePmJobRequest
          in: body
          required: true
          schema:
74
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
            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:
92
        201:
93
          description: >
94
            201 CREATED
95

96
97
98
99
100
            The PM job was created successfully.
            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.          
101
          schema:
102
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
rameshnaraya's avatar
rameshnaraya committed
103
104
          headers:
            Content-Type:
105
              type: string
rameshnaraya's avatar
rameshnaraya committed
106
107
108
109
110
              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:
111
              type: string
rameshnaraya's avatar
rameshnaraya committed
112
113
114
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
115
116
                has provided an invalid authorization token.
              maximum: 1
117
118
119
120
121
122
123
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
124
        400:
125
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
126
        401:
127
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
128
        403:
129
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
130
        404:
131
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
132
        405:
133
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
134
        406:
135
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
136
        500:
137
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
138
        503:
139
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
140
141

    get:
rameshnaraya's avatar
rameshnaraya committed
142
      summary: Query PM jobs.
143
144
      description: >
        The client can use this method to retrieve information about PM jobs.
145
      parameters:
146
147
        - name: filter
          in: query
148
          required: false
149
150
          type: string
          description: >
151
152
153
            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.
154
            All attribute names that appear in the PmJob and in data types referenced from it
155
            shall be supported by the NFVO in the filter expression.
156
157
        - name: all_fields
          in: query
158
          required: false
159
160
161
162
163
164
          type: string
          description: >
            Include all complex attributes in the response. See clause 4.3.3 for details. The
            NFVO shall support this parameter.
        - name: include
          in: query
165
          required: false
166
167
168
169
170
171
          type: string
          description: >
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
        - name: exclude
          in: query
172
          required: false
173
174
175
176
177
178
          type: string
          description: >
            Complex attributes to be excluded from the response. See clause 4.3.3 for details.
            The NFVO should support this parameter.
        - name: exclude_default
          in: query
179
          required: false
180
181
182
          type: string
          description: >
            Indicates to exclude the following complex attributes from the response.
183
184
185
186
            See clause 4.3.3 for details. The NFVO shall support this parameter.
            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:
187
188
189
190
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
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
195
196
197
198
199
200
201
202
203
204
205
206
207
        - 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
208
          type: string
209
      responses:
rameshnaraya's avatar
rameshnaraya committed
210
211
        200:
          description: >
212
            200 OK
213

rameshnaraya's avatar
rameshnaraya committed
214
            Information about zero or more PM jobs was queried successfully.
215
            The response body shall contain representations of
216
            zero or more PM jobs, as defined in clause 7.5.2.7.
217
          headers:
rameshnaraya's avatar
rameshnaraya committed
218
219
220
221
222
223
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
224
              type: string
rameshnaraya's avatar
rameshnaraya committed
225
226
              description: >
                Challenge if the corresponding HTTP request has not provided
227
228
229
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
230
231
232
233
234
235
236
237
238
239
240
241
242
              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
243
244
245
          schema:
            type: array
            items:
246
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
247
        400:
248
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
249
        401:
250
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
251
        403:
252
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
253
254
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
255
        405:
256
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
257
        406:
258
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
259
        500:
260
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
261
        503:
262
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
263
264
265
266

  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
267
268
269
270
271
272
  '/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
273
274
275
          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.          
276
277
278
        in: path
        type: string
        required: true
279
280
281
282
283
284
285
286
287
288
289
290
291
      - 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
292

293
    get:
rameshnaraya's avatar
rameshnaraya committed
294
      summary: Read a single PM job.
295
296
297
298
299
300
      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.
301
            Reference: IETF RFC 7231.
302
303
304
305
306
          in: header
          required: true
          type: string
      responses:
        200:
307
308
          description: >
            200 OK
309

310
311
312
            Information about an individual PM job was queried successfully.
            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
313
          schema:
314
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
315
          headers:
rameshnaraya's avatar
rameshnaraya committed
316
            Content-Type:
317
              type: string
rameshnaraya's avatar
rameshnaraya committed
318
319
320
              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.
321
            WWW-Authenticate:
322
              type: string
323
324
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
325
326
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
327
328
              maximum: 1
              minimum: 0
329
330
331
332
333
334
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
335
        400:
336
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
337
        401:
338
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
339
        403:
340
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
341
342
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
343
        405:
344
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
345
        406:
346
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
347
        500:
348
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
349
        503:
350
351
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

352
    delete:
rameshnaraya's avatar
rameshnaraya committed
353
      summary: Delete a PM job.
354
355
356
357
      description: >
        This method terminates an individual PM job.
      responses:
        204:
358
          description: >
359
            204 NO CONTENT
360

361
362
363
364
            The PM job was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
365
              type: string
366
367
              description: >
                Challenge if the corresponding HTTP request has not provided
368
369
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
370
371
              maximum: 1
              minimum: 0
372
373
374
375
376
377
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
378
        400:
379
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
380
        401:
381
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
382
        403:
383
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
384
385
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
386
        405:
387
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
388
        406:
389
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
390
        500:
391
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
392
        503:
393
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
394

395
396
397
  ###############################################################################
  # Individual performance report                                               #
  ###############################################################################
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
  '/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
413
414
415
416
417
418
419
420
421
422
423
424
425
      - 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
426

427
    get:
rameshnaraya's avatar
rameshnaraya committed
428
      summary: Read an individual performance report.
429
430
431
432
433
434
435
      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.
436
            Reference: IETF RFC 7231.
437
438
439
440
441
          in: header
          required: true
          type: string
      responses:
        200:
442
443
444
445
446
447
448
          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
449
          schema:
450
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PerformanceReport"
451
          headers:
rameshnaraya's avatar
rameshnaraya committed
452
            Content-Type:
453
              type: string
rameshnaraya's avatar
rameshnaraya committed
454
455
456
              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.
457
            WWW-Authenticate:
458
              type: string
459
460
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
461
462
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
463
464
              maximum: 1
              minimum: 0
465
466
467
468
469
470
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
471
        400:
472
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
473
        401:
474
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
475
        403:
476
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
477
478
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
479
        405:
480
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
481
        406:
482
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
483
        500:
484
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
485
        503:
486
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
487

488
489
490
  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
491
  '/thresholds':
492
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5
493
494
495
496
497
498
499
500
501
502
503
504
505
506
    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
507

508
    post:
rameshnaraya's avatar
rameshnaraya committed
509
      summary: Create a threshold.
510
      description: >
511
        The POST method can be used by the client to create a threshold.
512

513
514
515
        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.        
516
      parameters:
517
518
519
520
        - name: CreateThresholdRequest
          in: body
          required: true
          schema:
521
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
            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
538
539
      responses:
        201:
540
          description: >
541
            201 CREATED
542

543
544
545
546
547
548
            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
549
          schema:
550
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
551
          headers:
rameshnaraya's avatar
rameshnaraya committed
552
            Content-Type:
553
              type: string
rameshnaraya's avatar
rameshnaraya committed
554
555
556
557
              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.
558
            WWW-Authenticate:
559
              type: string
560
561
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
562
563
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
564
565
              maximum: 1
              minimum: 0
566
567
568
569
570
571
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
572
        400:
573
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
574
        401:
575
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
576
        403:
577
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
578
579
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
580
        405:
581
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
582
        406:
583
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
584
        500:
585
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
586
        503:
587
588
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

589
    get:
590
      summary: Query thresholds.
591
592
593
      description: >
        The client can use this method to query information about thresholds.
      parameters:
594
595
        - name: filter
          in: query
596
          required: false
597
598
          type: string
          description: >
599
600
601
602
603
            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.
604
605
606
607
608
609
610
        - 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.
611
612
613
614
615
616
617
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
618
619
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
620
          description: >
621
            200 OK
622

rameshnaraya's avatar
rameshnaraya committed
623
            Information about zero or more thresholds was queried successfully.
624
            The response body shall contain representations of
rameshnaraya's avatar
rameshnaraya committed
625
            zero or more thresholds, as defined in clause 7.5.2.9.
626
          headers:
rameshnaraya's avatar
rameshnaraya committed
627
628
            Content-Type:
              description: The MIME type of the body of the response.
629
              type: string
rameshnaraya's avatar
rameshnaraya committed
630
631
              maximum: 1
              minimum: 1
632
            WWW-Authenticate:
633
              type: string
634
635
              description: >
                Challenge if the corresponding HTTP request has not provided
636
637
638
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
639
640
641
642
643
644
645
646
647
648
649
650
651
              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
652
653
          schema:
            type: array
rameshnaraya's avatar
rameshnaraya committed
654
            items:
655
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
656
        400:
657
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
658
        401:
659
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
660
        403:
661
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
662
663
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
664
        405:
665
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
666
        406:
667
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
668
        500:
669
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
670
        503:
671
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
672
673
674
675

  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
676
  '/thresholds/{thresholdId}':
677
678
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.6
    parameters:
679
680
681
682
683
684
685
686
687
688
      - 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
689
690
691
692
693
694
695
696
697
698
699
700
701
      - 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
702

703
    get:
rameshnaraya's avatar
rameshnaraya committed
704
      summary: Query a single threshold.
705
706
      description: >
        The client can use this method for reading an individual threshold.
rameshnaraya's avatar
rameshnaraya committed
707
708
709
        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.
710
711
712
713
714
715
716
717
718
719
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
720
721
          description: >
            200 OK
722

723
724
725
            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
726
          schema:
727
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
728
          headers:
rameshnaraya's avatar
rameshnaraya committed
729
            Content-Type:
730
              type: string
rameshnaraya's avatar
rameshnaraya committed
731
732
733
              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.
734
            WWW-Authenticate:
735
              type: string
736
737
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
738
739
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
740
741
              maximum: 1
              minimum: 0
742
743
744
745
746
747
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
748
        400:
749
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
750
        401:
751
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
752
        403:
753
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
754
755
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
756
        405:
757
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
758
        406:
759
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
760
        500:
761
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
762
        503:
763
764
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

765
    delete:
rameshnaraya's avatar
rameshnaraya committed
766
      summary: Delete a threshold.
767
768
769
770
771
772
773
774
775
776
777
778
      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:
779
          description: >
moscatelli's avatar
moscatelli committed
780
            204 NO CONTENT
781

782
783
784
785
            The threshold was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
786
              type: string
787
788
              description: >
                Challenge if the corresponding HTTP request has not provided
789
790
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
791
792
              maximum: 1
              minimum: 0
793
794
795
796
797
798
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
799
        400:
800
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
801
        401:
802
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
803
        403:
804
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
805
806
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
807
        405:
808
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
809
        406:
810
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
811
        500:
812
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
813
        503:
814
815
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

816
817
818
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
819
820
  '/subscriptions':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.7
821
822
823
824
825
826
827
828
829
830
831
832
833
834
    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
835

836
    post:
rameshnaraya's avatar
rameshnaraya committed
837
      summary: Subscribe to PM notifications.
838
839
840
841
      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
842
843
        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.
844
        Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
rameshnaraya's avatar
rameshnaraya committed
845
846
847
        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)
848
      parameters:
849
850
851
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
852
            Reference: IETF RFC 7231.
853
854
855
856
857
858
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
859
            Reference: IETF RFC 7231.
860
861
862
863
864
865
866
          in: header
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
867
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
868
869
            description: >
              Details of the subscription to be created.
870
871
      responses:
        201:
872
          description: >
873
            201 CREATED
874

875
876
877
878
879
            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
880
          schema:
881
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
882
          headers:
rameshnaraya's avatar
rameshnaraya committed
883
            Content-Type:
884
              type: string
rameshnaraya's avatar
rameshnaraya committed
885
886
887
888
889
              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
890
              minimum: 1
891
            WWW-Authenticate:
892
              type: string
893
894
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
895
896
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
897
              maximum: 1
898
899
900
901
902
903
904
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
905
        303:
906
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
907
        400:
908
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
909
        401:
910
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
911
        403:
912
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
913
914
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
915
        405:
916
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
917
        406:
918
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
919
        500:
920
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
921
        503:
922
923
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

924
    get:
925
      summary: Query PM related subscriptions.
926
      description: >
rameshnaraya's avatar