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

3
info:
4
  version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
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.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
22

23
basePath: /vnfpm/v2
24

25
schemes:
26
27
28
  - http
  - https

29
consumes:
30
31
  - application/json

32
produces:
33
34
35
  - 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
    post:
      description: >
        The POST method creates a PM job.
64
65
66
        As the result of successful executing this method, a new 
        "Individual PM job" resource as defined in clause 6.4.3 shall 
        have been created.
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
      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
      responses:
        201:
90
          description: >
91
            201 CREATED
moscatelli's avatar
moscatelli committed
92

93
94
95
            Shall be returned when the PM job has been created successfully. 
            The response body shall contain a representation of the created 
            PM job resource.
96
            The HTTP response shall include a "Location" HTTP header that
97
            points to the created "Individual PM job" resource.
98
          headers:
99
100
101
102
103
104
105
106
107
108
            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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
            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"
129
130
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
131
132
133
134
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
135
136
137
138
139
140
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
141
142
143
144
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
145
146
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    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
165
166
        - name: filter
          description: >
167
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
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
            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.
200
201
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
            The VNFM shall support this parameter.
202
203
204
205
206
207
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
208
209
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
            The VNFM should support this parameter.
210
211
212
213
214
215
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
216
217
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
            The VNFM should support this parameter.
218
219
220
221
222
223
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
224
225
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
            The VNFM shall support this parameter.
226
227
228
229
230
231
232
233
234
235
236
            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
237
            (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
238
239
240
          in: query
          required: false
          type: string
241
242
      responses:
        200:
243
          description: >
244
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
245

246
            Shall be returned when information about zero or more PM jobs was queried successfully.
247
248
            The response body shall contain in an array the representations of zero or more PM jobs,
            as defined in clause 6.5.2.7.
249
250
251
252
253
254
255
            If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), 
            "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in 
            the request, the data in the response body shall have been transformed according to 
            the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
            If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of 
            ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this 
            response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
256
          headers:
257
258
259
260
261
262
263
264
265
266
            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
267
268
269
270
271
272
273
274
            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
275
276
277
278
279
280
            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
281
282
283
284
285
          schema:
            type: array
            items:
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
        400:
286
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
287
288
289
290
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
291
292
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
293
294
295
296
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
297
298
299
300
301
302
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
303
304
305
306
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
307
308
309
310
311
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
312
  '/pm_jobs/{pmJobId}':
313
    #SOL002 location: 6.4.3
314
315
316
317
318
319
320
321
322
323
324
    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
325
326
327
328
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
329
        required: true
330
        type: string
331
332
333
334
335
336
337
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
338
339
340
341
342
343
344
345
346
347
348
349
350
    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:
351
          description: >
352
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
353

354
355
356
            Shall be returned when information about an individual PM job has been 
            ueried successfully.
            The response body shall contain a representation of the "Individual PM job"
357
358
            resource.
          headers:
359
360
361
362
363
364
365
366
367
368
            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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
            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"
385
386
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
387
388
389
390
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
391
392
393
394
395
396
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
397
398
399
400
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
401
402
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
    patch:
      description: >
        This method allows to modify an "individual PM job" resource.
        This method shall follow the provisions specified in the tables 6.4.3.3.4-1 and 6.4.3.3.4-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: PmJobModifications
          description: Parameters for the PM job modification
          required: true
          in: body
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications"
      responses:
        200:
          description: >
            200 OK

            Shall be returned when the request has been
            processed successfully.
            The response body shall contain a data structure of
            type "PmJobModifications".
          headers:
            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
            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/PmJobModifications"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        412:
          # description: >
          #   PRECONDITION FAILED
            
          #   Shall be returned upon the following error
          #   A precondition given in an HTTP request header is
          #   not fulfilled.
          #   Typically, this is due to an ETag mismatch,
          #   indicating that the resource was modified by another
          #   entity.
          #   The response body should contain a ProblemDetails
          #   structure, in which the "detail" attribute should
          #   convey more information about the error.
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
486
487
488
    delete:
      description: >
        This method terminates an individual PM job.
489
490
        As the result of successfully executing this method, the "Individual PM job" 
        resource shall not exist any longer.
491
492
      responses:
        204:
493
          description: >
494
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
495

496
            Shall be returned when the PM job has been deleted successfully.
497
498
            The response body shall be empty.
          headers:
499
500
501
502
503
504
505
506
507
508
            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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
            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"
523
524
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
525
526
527
528
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        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"

  ###############################################################################
  # Individual performance report                                               #
  ###############################################################################
545
  '/pm_jobs/{pmJobId}/reports/{reportId}':
546
    #SOL002 location: 6.4.4
547
548
549
550
551
552
553
554
555
556
557
558
559
    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
560
561
562
563
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
564
        required: true
565
        type: string
566
567
568
569
570
571
572
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
573
574
575
576
577
578
579
580
581
582
583
584
585
586
    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:
587
          description: >
588
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
589

590
591
592
593
            Shall be returned when information of an individual performance report 
            has been read successfully.
            The response body shall contain a representation of the "Individual 
            performance report" resource.
594
          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
606
607
608
609
610
611
612
613
            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:
614
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport"
615
616
617
618
619
620
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
621
622
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
623
624
625
626
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
627
628
629
630
631
632
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
633
634
635
636
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
637
638
639
640
641
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
642
643
  '/thresholds':
    #SOL003 location: 6.4.5
644
645
646
647
648
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
649
        required: true
650
        type: string
651
652
653
654
655
656
657
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
658
659
660
    post:
      description: >
        The POST method can be used by the client to create a threshold.
661
662
663
        As the result of successfully executing this method, a new 
        "Individual threshold" resource as defined in clause 6.4.6 shall 
        have been created.
664
665
666
      parameters:
        - name: CreateThresholdRequest
          description: >
667
            Request parameters to create a new "Individual threshold" resource.
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
          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:
688
          description: >
689
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
690

691
692
693
            Shall be returned when a threshold has been created successfully. 
            The response body shall contain a representation of the created 
            "Individual threshold" resource.
694
            The HTTP response shall include a "Location" HTTP header that
695
            contains the resource URI of the created resource.
696
          headers:
697
698
699
700
701
702
703
704
705
706
            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
707
            Location:
708
              description: The resource URI of the created threshold
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
              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"
727
728
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
729
730
731
732
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
733
734
735
736
737
738
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
739
740
741
742
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
743
744
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
745
746
747
748
749
750
751
752
753
754
755
    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
756
        - name: filter
757
          description: >
758
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
moscatelli's avatar
moscatelli committed
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
            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
792
793
            (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for 
            this resource.
moscatelli's avatar
moscatelli committed
794
795
          in: query
          required: false
796
797
798
          type: string
      responses:
        200:
799
          description: >
800
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
801

802
803
            Information about zero or more thresholds was queried
            successfully.
804
805
806
807
808
809
810
811
812
813
814
          
            If the "filter" URI parameter was supplied in the request, 
            the data in the response body shall have been transformed 
            according to the rules specified in clause 5.2.2 of 
            ETSI GS NFV SOL 013.
            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 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion 
            of the Link HTTP header in this response shall follow the provisions 
            in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
815
          headers:
816
817
            Content-Type:
              description: The MIME type of the body of the response.
818
              type: string
819
820
821
822
823
824
825
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
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
834
835
836
837
838
839
            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
840
841
          schema:
            type: array
842
            items:
843
844
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
        400:
845
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
846
847
848
849
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
850
851
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
852
853
854
855
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
856
857
858
859
860
861
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
862
863
864
865
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
866
867
868
869
870
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
871
872
  '/thresholds/{thresholdId}':
    #SOL003 location: 6.4.6
873
    parameters:
874
875
876
877
878
879
880
881
882
883
      - 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
884
885
886
887
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
888
        required: true
889
        type: string
890
891
892
893
894
895
896
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
897
898
899
900
901
902
903
904
905
906
907
908
909
    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:
910
          description: >
911
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
912

913
914
915
            Shall be returned when information about an individual threshold 
            has been queried successfully. 
            The response body shall contain a representation of the threshold.
916
          headers:
917
918
919
920
921
922
923
924
925
926
            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
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
            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"
943
944
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
945
946
947
948
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
949
950
951
952
953
954
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
955
956
957
958
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
959
960
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
961
    patch:
962
      description: >
963
964
965
        This method allows to modify an "Individual threshold" resource.
        This method shall follow the provisions specified in the tables 6.4.6.3.4-1 and 6.4.6.3.4-2 for URI query parameters,
        request and response data structures, and response codes.
966
      parameters:
967
968
        - name: ThresholdModifications
          description: Parameters for the threshold modification.
969
970
971
          required: true
          in: body
          schema:
972
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications"
973
974
      responses:
        200:
975
          description: >
976
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
977

978
979
980
981
            Shall be returned when the request has been
            processed successfully.
            The response body shall contain a data structure of
            type "ThresholdModifications".
982
983
          headers:
            Content-Type:
984
985
986
987
988
989
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
990
991
992
993
994
995
996
997
998
999
1000
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
For faster browsing, not all history is shown. View entire blame