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

info: 
4
  version: "1.2.0"
moscatelli's avatar
moscatelli committed
5
  title: SOL002 - VNF Perfomance Management interface
6
  description: >
moscatelli's avatar
moscatelli committed
7
    SOL002 - VNF Performance Management interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
moscatelli's avatar
moscatelli committed
9
10
11
12
    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
13
  license:
moscatelli's avatar
moscatelli committed
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
16
17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20
21
  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
22

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

schemes: 
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json

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

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

            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:
95
96
97
98
99
100
101
102
103
104
            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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
            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"
125
126
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
moscatelli's avatar
moscatelli committed
127
        405:
128
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
moscatelli's avatar
moscatelli committed
129
130
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
131
132
133
134
135
136
        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
137
138
139
140
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
141
142
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
moscatelli's avatar
moscatelli committed
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    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
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
232
        - 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
233
234
235
      responses:
        200:
          description: > 
236
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
237

238
            Information about zero or more PM jobs was queried successfully.
239
240
241
242
            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.
243
          headers:
244
245
246
247
248
249
250
251
252
253
            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
254
255
256
257
258
259
260
261
            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
262
263
264
265
266
267
            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
268
269
270
271
272
          schema:
            type: array
            items:
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
        400:
273
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
274
275
276
277
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
278
279
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
280
        405:
281
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
282
283
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
284
285
286
287
288
289
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
290
291
292
293
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
294
295
296
297
298
299
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

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

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

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

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

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

  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
545
546
  '/thresholds':
    #SOL003 location: 6.4.5
547
548
549
550
551
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
552
        required: true
553
        type: string
554
555
556
557
558
559
560
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
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
588
    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: > 
589
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
590

591
592
593
594
595
            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:
596
597
598
599
600
601
602
603
604
605
            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
606
            Location:
607
              description: The resource URI of the created threshold
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
              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"
626
627
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
628
        405:
629
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
630
631
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
632
633
634
635
636
637
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
638
639
640
641
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
642
643
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
644
645
646
647
648
649
650
651
652
653
654
    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
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
694
        - 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
695
696
697
      responses:
        200:
          description: > 
698
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
699

700
701
            Information about zero or more thresholds was queried
            successfully.
702
703
704
705
            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.
706
          headers:
707
708
709
710
711
712
713
714
715
716
            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
717
718
719
720
721
722
723
724
            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
725
726
727
728
729
730
            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
731
732
733
734
735
          schema:
            type: array
            items: 
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
        400:
736
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
737
738
739
740
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
741
742
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
743
        405:
744
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
745
746
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
747
748
749
750
751
752
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
753
754
755
756
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
757
758
759
760
761
762
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
763
764
765
766
767
768
769
770
771
772
773
774
775
  '/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
776
777
778
779
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
780
        required: true
781
        type: string
782
783
784
785
786
787
788
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
789
790
791
792
793
794
795
796
797
798
799
800
801
802
    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: > 
803
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
804

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

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

  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
913
914
  '/subscriptions':
    #SOL003 location: 6.4.7
915
916
917
918
919
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
920
        required: true
921
        type: string
922
923
924
925
926
927
928
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
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
956
    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: > 
957
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
958

959
960
961
962
963
964
            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:
965
966
967
968
969
970
971
972
973
974
            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
975
976
977
978
979
980
981
982
983
984
985
986
987
988
            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"
989
990
991
992
993
994
995
996
997
998
        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"
999
1000
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
For faster browsing, not all history is shown. View entire blame