VNFPerformanceManagement.yaml 48.6 KB
Newer Older
1
2
3
swagger: "2.0"

info: 
4
  version: "1.2.0"
5
  title: "SOL002 - VNF Configuration interface"
6
  description: >
7
8
    VNF Configuration interface of ETSI NFV SOL002

9
    IMPORTANT: Please note that this file might be not aligned to the current
10
11
12
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

13
14
15
16
17
    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

18
externalDocs:
19
20
  description: ETSI GS NFV-SOL 002 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
21

22
basePath: /vnfpm/v1
23
24
25
26
27
28
29
30
31
32
33
34

schemes: 
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json

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

41
42
43
  ###############################################################################
  # PM jobs                                                                     #
  ###############################################################################
44
45
  '/pm_jobs':
    #SOL003 location: 6.4.2
46
47
48
49
50
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
51
        required: true
52
        type: string
53
54
55
56
57
58
59
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
    post:
      description: >
        The POST method creates a PM job.
      parameters:
        - name: CreatePmJobRequest
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
        - 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
moscatelli's avatar
moscatelli committed
84
85
86
      responses:
        201:
          description: > 
87
            201 CREATED
moscatelli's avatar
moscatelli committed
88
89
90
91
92
93

            The PM job was created successfully. The response body shall
            contain a representation of the created PM job resource.
            The HTTP response shall include a "Location" HTTP header that
            points to the created PM job resource.
          headers:
94
95
96
97
98
99
100
101
102
103
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
moscatelli's avatar
moscatelli committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
            Location:
              description: The resource URI of the created PM Job
              type: string
              format: url
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
124
125
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
moscatelli's avatar
moscatelli committed
126
        405:
127
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
moscatelli's avatar
moscatelli committed
128
129
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
130
131
132
133
134
135
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
moscatelli's avatar
moscatelli committed
136
137
138
139
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
140
141
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
moscatelli's avatar
moscatelli committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
    get:
      description: >
        The client can use this method to retrieve information about PM jobs.
      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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM may supply this parameter. All attribute names that appear in the PmJob
            and in data types referenced from it shall be supported by the VNFM in attribute-based filtering expression.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. The VNFM 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:
            -	reports
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response.
            Shall be supported by the VNFM if the VNFM supports alternative 2
            (paging) according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
232
233
234
      responses:
        200:
          description: > 
235
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
236

237
            Information about zero or more PM jobs was queried successfully.
238
239
240
241
            The response body shall contain in an array the representations of zero or more PM jobs,
            as defined in clause 6.5.2.7.
            If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
            inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
242
          headers:
243
244
245
246
247
248
249
250
251
252
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
253
254
255
256
257
258
259
260
            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.
              type: string
              maximum: 1
              minimum: 0
261
262
263
264
265
266
            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
267
268
269
270
271
          schema:
            type: array
            items:
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
        400:
272
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
273
274
275
276
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
277
278
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
279
        405:
280
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
281
282
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
283
284
285
286
287
288
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
289
290
291
292
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
293
294
295
296
297
298
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
299
300
301
302
303
304
305
306
307
308
309
310
311
  '/pm_jobs/{pmJobId}':
    #SOL003 location: 6.4.3
    parameters:
      - name: pmJobId
        description: >
          Identifier of the PM job.
          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.
        in: path
        type: string
        required: true
312
313
314
315
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
316
        required: true
317
        type: string
318
319
320
321
322
323
324
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
325
326
327
328
329
330
331
332
333
334
335
336
337
338
    get:
      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.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
          description: > 
339
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
340

341
342
343
344
            Information about an individual PM job was queried successfully.
            The response body shall contain a representation of the PM job
            resource.
          headers:
345
346
347
348
349
350
351
352
353
354
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
371
372
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
373
        405:
374
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
375
376
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
377
378
379
380
381
382
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
383
384
385
386
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
387
388
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
389
390
391
392
393
394
    delete:
      description: >
        This method terminates an individual PM job.
      responses:
        204:
          description: > 
395
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
396

397
398
399
            The PM job was deleted successfully.
            The response body shall be empty.
          headers:
400
401
402
403
404
405
406
407
408
409
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
410
411
412
413
414
415
416
417
418
419
420
421
422
423
            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.
              type: string
              maximum: 1
              minimum: 0
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
424
425
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
426
        405:
427
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
428
429
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
430
431
432
433
434
435
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
436
437
438
439
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
440
441
442
443
444
445
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual performance report                                               #
  ###############################################################################
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
  '/pm_jobs/{pmJobId}/reports/{reportId}':
    #SOL003 location: 6.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
461
462
463
464
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
465
        required: true
466
        type: string
467
468
469
470
471
472
473
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
    get:
      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.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
          description: > 
489
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
490

491
492
493
494
495
            Information of an individual performance report was read
            successfully.
            The response body shall contain a representation of the
            performance report resource.
          headers:
496
497
498
499
500
501
502
503
504
505
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
506
507
508
509
510
511
512
513
514
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
515
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport"
516
517
518
519
520
521
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
522
523
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
524
        405:
525
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
526
527
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
528
529
530
531
532
533
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
534
535
536
537
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
538
539
540
541
542
543
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
544
545
  '/thresholds':
    #SOL003 location: 6.4.5
546
547
548
549
550
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
551
        required: true
552
        type: string
553
554
555
556
557
558
559
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
    post:
      description: >
        The POST method can be used by the client to create a threshold.
      parameters:
        - name: CreateThresholdRequest
          description: >
            Request parameters to create a threshold resource.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
        - 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:
        201:
          description: > 
588
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
589

590
591
592
593
594
            A threshold was created successfully. The response body shall
            contain a representation of the created threshold resource.
            The HTTP response shall include a "Location" HTTP header that
            contains the resource URI of the created threshold resource.
          headers:
595
596
597
598
599
600
601
602
603
604
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
605
            Location:
606
              description: The resource URI of the created threshold
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
              type: string
              format: url
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
625
626
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
627
        405:
628
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
629
630
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
631
632
633
634
635
636
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
637
638
639
640
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
641
642
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
643
644
645
646
647
648
649
650
651
652
653
    get:
      description: >
        The client can use this method to query information about thresholds.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
moscatelli's avatar
moscatelli committed
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM may supply this parameter. All attribute names that appear in the Thresholds
            and in data types referenced from it shall be supported by the VNFM in attribute-based filtering expression.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response.
            Shall be supported by the VNFM if the VNFM supports alternative 2
            (paging) according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
694
695
696
      responses:
        200:
          description: > 
697
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
698

699
700
            Information about zero or more thresholds was queried
            successfully.
701
702
703
704
            The response body shall contain in an array the representations of zero or more thresholds,
            as defined in clause 6.5.2.9.
            If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
            inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
705
          headers:
706
707
708
709
710
711
712
713
714
715
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
716
717
718
719
720
721
722
723
            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.
              type: string
              maximum: 1
              minimum: 0
724
725
726
727
728
729
            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
730
731
732
733
734
          schema:
            type: array
            items: 
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
        400:
735
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
736
737
738
739
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
740
741
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
742
        405:
743
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
744
745
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
746
747
748
749
750
751
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
752
753
754
755
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
756
757
758
759
760
761
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
762
763
764
765
766
767
768
769
770
771
772
773
774
  '/thresholds/{thresholdId}':
    #SOL003 location: 6.4.6
    parameters: 
      - 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
775
776
777
778
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
779
        required: true
780
        type: string
781
782
783
784
785
786
787
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
788
789
790
791
792
793
794
795
796
797
798
799
800
801
    get:
      description: >
        The client can use this method for reading an individual threshold.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
          description: > 
802
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
803

804
805
806
807
            Information about an individual threshold was queried
            successfully. The response body shall contain a
            representation of the threshold.
          headers:
808
809
810
811
812
813
814
815
816
817
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
834
835
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
836
        405:
837
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
838
839
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
840
841
842
843
844
845
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
846
847
848
849
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
850
851
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
852
853
854
855
856
857
858
859
860
861
862
863
864
865
    delete:
      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:
          description: > 
866
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
867

868
869
870
            The threshold was deleted successfully.
            The response body shall be empty.
          headers:
871
872
873
874
875
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
876
877
878
879
880
881
882
883
884
885
886
887
888
889
            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.
              type: string
              maximum: 1
              minimum: 0
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
890
891
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
892
        405:
893
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
894
895
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
896
897
898
899
900
901
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
902
903
904
905
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
906
907
908
909
910
911
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
912
913
  '/subscriptions':
    #SOL003 location: 6.4.7
914
915
916
917
918
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
919
        required: true
920
        type: string
921
922
923
924
925
926
927
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
    post:
      description: >
        The POST method creates a new subscription.
      parameters:
        - name: PmSubscriptionRequest
          description: >
            Details of the subscription to be created.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
        - 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:
        201:
          description: > 
956
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
957

958
959
960
961
962
963
            The subscription was created successfully. A representation of the
            created subscription resource shall be returned in the response
            body.
            The HTTP response shall include a "Location" HTTP header that
            contains the resource URI of the created subscription resource.
          headers:
964
965
966
967
968
969
970
971
972
973
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
974
975
976
977
978
979
980
981
982
983
984
985
986
987
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
988
989
990
991
992
993
994
995
996
997
        303:
          description: >
            303 SEE OTHER

            A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM
            is to not create redundant subscriptions.
            The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
            subscription resource.
            The response body shall be empty.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
998
999
1000
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
For faster browsing, not all history is shown. View entire blame