VNFPerformanceManagement.yaml 54 KB
Newer Older
1
openapi: 3.0.2
2 3

info:
4
  title: SOL003 - VNF Performance Management interface
5
  description: |
6 7
    SOL003 - VNF Performance Management interface

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

12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
13 14
  contact:
    name: NFV-SOL WG
15
  license:
16
    name: ETSI Forge copyright notice
17
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
18
  version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
19

20
externalDocs:
21
  description: ETSI GS NFV-SOL 003 V2.7.1
22
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf
23

24 25 26
servers:
  - url: http://127.0.0.1/vnfpm/v2
  - url: https://127.0.0.1/vnfpm/v2
27 28 29


paths:
30 31 32
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
33
  /api-versions:
34
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
35

36 37 38
  ###############################################################################
  # PM jobs                                                                     #
  ###############################################################################
39
  /pm_jobs:
40
    #SOL003 location: 6.4.2
41 42 43 44
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
45
    post:
46
      description: |
47
        Create PM Job.
48
        The POST method creates a PM job.
49 50 51 52
        This method shall follow the provisions specified in the tables 6.4.2.3.1-1 and 6.4.2.3.1-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, a new "Individual PM job" resource as defined
        in clause 6.4.3 shall have been created.
53
      parameters:
Samir Medjiah's avatar
Samir Medjiah committed
54
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
55 56
      requestBody:
        $ref: '#/components/requestBodies/CreatePmJobRequest'
57 58
      responses:
        201:
59
          $ref: '#/components/responses/PMJobs.Post.201'
60
        400:
f.moscatelli's avatar
f.moscatelli committed
61
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
62
        401:
f.moscatelli's avatar
f.moscatelli committed
63
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
64
        403:
f.moscatelli's avatar
f.moscatelli committed
65
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
66
        404:
f.moscatelli's avatar
f.moscatelli committed
67
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
68
        405:
f.moscatelli's avatar
f.moscatelli committed
69
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
70
        406:
f.moscatelli's avatar
f.moscatelli committed
71
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
72
        422:
f.moscatelli's avatar
f.moscatelli committed
73
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
74
        500:
f.moscatelli's avatar
f.moscatelli committed
75
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
76
        503:
f.moscatelli's avatar
f.moscatelli committed
77
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
78
        504:
f.moscatelli's avatar
f.moscatelli committed
79
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
80

81
    get:
82
      description: |
83
        Query PM Job.
84
        The API consumer can use this method to retrieve information about PM jobs.
85 86
        This method shall follow the provisions specified in the tables 6.4.2.3.2-1 and 6.4.2.3.2-2
        for URI query parameters, request and response data structures, and response codes.
87
        The API consumer can use this method to retrieve information about PM jobs.
88
      parameters:
89 90 91 92 93 94
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
95 96
      responses:
        200:
97
          $ref: '#/components/responses/PMJobs.Get.200'
98
        400:
f.moscatelli's avatar
f.moscatelli committed
99
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
100
        401:
f.moscatelli's avatar
f.moscatelli committed
101
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
102
        403:
f.moscatelli's avatar
f.moscatelli committed
103
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
104
        404:
f.moscatelli's avatar
f.moscatelli committed
105
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
106
        405:
f.moscatelli's avatar
f.moscatelli committed
107
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
108
        406:
f.moscatelli's avatar
f.moscatelli committed
109
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
110
        422:
f.moscatelli's avatar
f.moscatelli committed
111
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
112
        500:
f.moscatelli's avatar
f.moscatelli committed
113
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
114
        503:
f.moscatelli's avatar
f.moscatelli committed
115
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
116
        504:
f.moscatelli's avatar
f.moscatelli committed
117
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
118

119 120 121
  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
122
  /pm_jobs/{pmJobId}:
123 124
    #SOL003 location: 6.4.3
    parameters:
125 126 127
      - $ref: '#/components/parameters/PmJobId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
128
    get:
129
      description: |
130
        Query PM Job.
131
        The API consumer can use this method for reading an individual PM job.
132 133
        This method shall follow the provisions specified in the tables 6.4.3.3.2-1 and 6.4.3.3.2-2
        for URI query parameters, request and response data structures, and response codes.
134
      parameters:
135
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
136 137
      responses:
        200:
138
          $ref: '#/components/responses/IndividualPMJob.Get.200'
139
        400:
f.moscatelli's avatar
f.moscatelli committed
140
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
141
        401:
f.moscatelli's avatar
f.moscatelli committed
142
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
143
        403:
f.moscatelli's avatar
f.moscatelli committed
144
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
145
        404:
f.moscatelli's avatar
f.moscatelli committed
146
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
147
        405:
f.moscatelli's avatar
f.moscatelli committed
148
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
149
        406:
f.moscatelli's avatar
f.moscatelli committed
150
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
151
        422:
f.moscatelli's avatar
f.moscatelli committed
152
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
153
        500:
f.moscatelli's avatar
f.moscatelli committed
154
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
155
        503:
f.moscatelli's avatar
f.moscatelli committed
156
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
157
        504:
f.moscatelli's avatar
f.moscatelli committed
158
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
159

160
    patch:
161
      description: |
162
        This method allows to modify an "Individual PM job" resource.
163 164 165 166 167
        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.
      responses:
        200:
168
          $ref: '#/components/responses/IndividualPMJob.Patch.200'
169
        400:
f.moscatelli's avatar
f.moscatelli committed
170
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
171
        401:
f.moscatelli's avatar
f.moscatelli committed
172
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
173
        403:
f.moscatelli's avatar
f.moscatelli committed
174
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
175
        404:
f.moscatelli's avatar
f.moscatelli committed
176
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
177
        405:
f.moscatelli's avatar
f.moscatelli committed
178
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
179
        406:
f.moscatelli's avatar
f.moscatelli committed
180
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
181
        412:
f.moscatelli's avatar
f.moscatelli committed
182
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
183
        422:
f.moscatelli's avatar
f.moscatelli committed
184
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
185
        500:
f.moscatelli's avatar
f.moscatelli committed
186
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
187
        503:
f.moscatelli's avatar
f.moscatelli committed
188
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
189
        504:
f.moscatelli's avatar
f.moscatelli committed
190
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
191

192
    delete:
193
      description: |
194
        Delete PM Job.
195
        This method terminates an individual PM job.
196 197 198
        This method shall follow the provisions specified in the tables 6.4.3.3.5-1 and 6.4.3.3.5-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, the "Individual PM job" resource shall not exist any longer.
199 200
      responses:
        204:
201
          $ref: '#/components/responses/IndividualPMJob.Delete.200'
202
        400:
f.moscatelli's avatar
f.moscatelli committed
203
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
204
        401:
f.moscatelli's avatar
f.moscatelli committed
205
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
206
        403:
f.moscatelli's avatar
f.moscatelli committed
207
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
208
        404:
f.moscatelli's avatar
f.moscatelli committed
209
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
210
        405:
f.moscatelli's avatar
f.moscatelli committed
211
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
212
        406:
f.moscatelli's avatar
f.moscatelli committed
213
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
214
        422:
f.moscatelli's avatar
f.moscatelli committed
215
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
216
        500:
f.moscatelli's avatar
f.moscatelli committed
217
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
218
        503:
f.moscatelli's avatar
f.moscatelli committed
219
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
220
        504:
f.moscatelli's avatar
f.moscatelli committed
221
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
222

223 224 225
  ###############################################################################
  # Individual performance report                                               #
  ###############################################################################
226
  /pm_jobs/{pmJobId}/reports/{reportId}:
227 228
    #SOL003 location: 6.4.4
    parameters:
229 230
      - $ref: '#/components/parameters/PmJobId'
      - $ref: '#/components/parameters/ReportId'
231
    get:
232
      description: |
233
        The API consumer can use this method for reading an individual performance report.
234 235
        This method shall follow the provisions specified in the tables 6.4.4.3.2-1 and 6.4.4.3.2-2
        for URI query parameters, request and response data structures, and response codes.
236
      parameters:
237 238 239
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
240 241
      responses:
        200:
242
          $ref: '#/components/responses/IndividualPerformanceReport.Get.200'
243
        400:
f.moscatelli's avatar
f.moscatelli committed
244
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
245
        401:
f.moscatelli's avatar
f.moscatelli committed
246
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
247
        403:
f.moscatelli's avatar
f.moscatelli committed
248
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
249
        404:
f.moscatelli's avatar
f.moscatelli committed
250
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
251
        405:
f.moscatelli's avatar
f.moscatelli committed
252
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
253
        406:
f.moscatelli's avatar
f.moscatelli committed
254
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
255
        422:
f.moscatelli's avatar
f.moscatelli committed
256
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
257
        500:
f.moscatelli's avatar
f.moscatelli committed
258
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
259
        503:
f.moscatelli's avatar
f.moscatelli committed
260
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
261
        504:
f.moscatelli's avatar
f.moscatelli committed
262
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
263

264 265 266
  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
267
  /thresholds:
268
    #SOL003 location: 6.4.5
269 270 271 272
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
273
    post:
274
      description: |
275
        Create Threshold.
276
        The POST method can be used by the API consumer to create a threshold.
277 278 279 280
        This method shall follow the provisions specified in the tables 6.4.5.3.1-1 and 6.4.5.3.1-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, a new "Individual threshold" resource
        as defined in clause 6.4.6 shall have been created.
281
      parameters:
Samir Medjiah's avatar
Samir Medjiah committed
282
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
283 284
      requestBody:
        $ref: '#/components/requestBodies/CreateThresholdRequest'
285 286
      responses:
        201:
287
          $ref: '#/components/responses/Thresholds.Post.201'
288
        400:
f.moscatelli's avatar
f.moscatelli committed
289
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
290
        401:
f.moscatelli's avatar
f.moscatelli committed
291
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
292
        403:
f.moscatelli's avatar
f.moscatelli committed
293
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
294
        404:
f.moscatelli's avatar
f.moscatelli committed
295
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
296
        405:
f.moscatelli's avatar
f.moscatelli committed
297
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
298
        406:
f.moscatelli's avatar
f.moscatelli committed
299
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
300
        422:
f.moscatelli's avatar
f.moscatelli committed
301
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
302
        500:
f.moscatelli's avatar
f.moscatelli committed
303
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
304
        503:
f.moscatelli's avatar
f.moscatelli committed
305
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
306
        504:
f.moscatelli's avatar
f.moscatelli committed
307
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
308

309
    get:
310
      description: |
311
        Query Threshold.
312
        The API consumer can use this method to query information about thresholds.
313 314
        This method shall follow the provisions specified in the tables 6.4.5.3.2-1 and 6.4.5.3.2-2
        for URI query parameters, request and response data structures, and response codes.
315
      parameters:
316 317
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
318 319
      responses:
        200:
320
          $ref: '#/components/responses/Thresholds.Get.200'
321
        400:
f.moscatelli's avatar
f.moscatelli committed
322
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
323
        401:
f.moscatelli's avatar
f.moscatelli committed
324
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
325
        403:
f.moscatelli's avatar
f.moscatelli committed
326
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
327
        404:
f.moscatelli's avatar
f.moscatelli committed
328
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
329
        405:
f.moscatelli's avatar
f.moscatelli committed
330
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
331
        406:
f.moscatelli's avatar
f.moscatelli committed
332
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
333
        422:
f.moscatelli's avatar
f.moscatelli committed
334
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
335
        500:
f.moscatelli's avatar
f.moscatelli committed
336
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
337
        503:
f.moscatelli's avatar
f.moscatelli committed
338
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
339
        504:
f.moscatelli's avatar
f.moscatelli committed
340
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
341

342 343 344
  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
345
  /thresholds/{thresholdId}:
346
    #SOL003 location: 6.4.6
347
    parameters:
348 349 350
      - $ref: '#/components/parameters/ThresholdId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
351
    get:
352
      description: |
353
        Query Threshold.
354
        The API consumer can use this method for reading an individual threshold
355 356
        This method shall follow the provisions specified in the tables 6.4.6.3.2-1 and 6.4.6.3.2-2
        for URI query parameters, request and response data structures, and response codes.
357
      parameters:
358
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
359 360
      responses:
        200:
361
          $ref: '#/components/responses/IndividualThreshold.Get.200'
362
        400:
f.moscatelli's avatar
f.moscatelli committed
363
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
364
        401:
f.moscatelli's avatar
f.moscatelli committed
365
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
366
        403:
f.moscatelli's avatar
f.moscatelli committed
367
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
368
        404:
f.moscatelli's avatar
f.moscatelli committed
369
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
370
        405:
f.moscatelli's avatar
f.moscatelli committed
371
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
372
        406:
f.moscatelli's avatar
f.moscatelli committed
373
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
374
        422:
f.moscatelli's avatar
f.moscatelli committed
375
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
376
        500:
f.moscatelli's avatar
f.moscatelli committed
377
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
378
        503:
f.moscatelli's avatar
f.moscatelli committed
379
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
380
        504:
f.moscatelli's avatar
f.moscatelli committed
381
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
382

383
    patch:
384
      description: |
385 386 387 388
        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.
389 390
      responses:
        200:
391
          $ref: '#/components/responses/IndividualThreshold.Patch.200'
392
        400:
f.moscatelli's avatar
f.moscatelli committed
393
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
394
        401:
f.moscatelli's avatar
f.moscatelli committed
395
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
396
        403:
f.moscatelli's avatar
f.moscatelli committed
397
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
398
        404:
f.moscatelli's avatar
f.moscatelli committed
399
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
400
        405:
f.moscatelli's avatar
f.moscatelli committed
401
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
402
        406:
f.moscatelli's avatar
f.moscatelli committed
403
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
404
        412:
f.moscatelli's avatar
f.moscatelli committed
405
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
406
        422:
f.moscatelli's avatar
f.moscatelli committed
407
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
408
        500:
f.moscatelli's avatar
f.moscatelli committed
409
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
410
        503:
f.moscatelli's avatar
f.moscatelli committed
411
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
412
        504:
f.moscatelli's avatar
f.moscatelli committed
413
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
414

415
    delete:
416
      description: |
417 418 419
        Delete Threshold.
        This method allows to delete a threshold.
        This method shall follow the provisions specified in the tables 6.4.6.3.5-1 and 6.4.6.3.5-2
420
        for URI query parameters, request and response data structures, and response codes.
421 422
        As the result of successfully executing this method, the "Individual threshold" resource
        shall not exist any longer.
423 424
      responses:
        204:
425
          $ref: '#/components/responses/IndividualThreshold.Delete.200'
426
        400:
f.moscatelli's avatar
f.moscatelli committed
427
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
428
        401:
f.moscatelli's avatar
f.moscatelli committed
429
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
430
        403:
f.moscatelli's avatar
f.moscatelli committed
431
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
432
        404:
f.moscatelli's avatar
f.moscatelli committed
433
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
434
        405:
f.moscatelli's avatar
f.moscatelli committed
435
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
436
        406:
f.moscatelli's avatar
f.moscatelli committed
437
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
438
        422:
f.moscatelli's avatar
f.moscatelli committed
439
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
440
        500:
f.moscatelli's avatar
f.moscatelli committed
441
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
442
        503:
f.moscatelli's avatar
f.moscatelli committed
443
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
444
        504:
f.moscatelli's avatar
f.moscatelli committed
445
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
446 447 448 449 450 451 452

#  ##############################################################################
#  # Subscriptions                                                              #
#  ##############################################################################
#  '/subscriptions':
#    #SOL003 location: 6.4.7
#    post:
453
#      description: |
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
#        Subscribe.
#        The POST method creates a new subscription.
#        This method shall follow the provisions specified in the tables 6.4.7.3.1-1 and 6.4.7.3.1-2
#        for URI query parameters, request and response data structures, and response codes.
#        As the result of successfully executing this method, a new "Individual subscription" resource
#        as defined in clause 6.4.8 shall have been created. This method shall not trigger any notification.
#        Creation of two "Individual subscription" resources with the same callbackURI and the same filter
#        can result in performance degradation and will provide duplicates of notifications to the NFVO,
#        and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
#        a new "Individual subscription" resource if another "Individual subscription" resource with the same
#        filter and callbackUri already exists (in which case it shall return the "201 Created" response code),
#        or may decide to not create a duplicate "Individual subscription" resource (in which case it shall
#        return a "303 See Other" response code referencing the existing "Individual subscription" resource
#        with the same filter and callbackUri).
#      parameters:
#        - name: PmSubscriptionRequest
470
#          description: |
471 472 473 474 475 476
#            Details of the subscription to be created.
#          in: body
#          required: true
#          schema:
#            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
#        - name: Accept
477
#          description: |
478 479 480 481 482 483
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231
#          in: header
#          required: true
#          type: string
#        - name: Authorization
484
#          description: |
485 486 487 488 489 490
#            The authorization token for the request.
#            Reference: IETF RFC 7235
#          in: header
#          required: false
#          type: string
#        - name: Content-Type
491
#          description: |
492 493 494 495 496 497
#            The MIME type of the body of the request.
#            Reference: IETF RFC 7231
#          in: header
#          required: true
#          type: string
#        - name: Version
498
#          description: |
499 500 501 502 503 504
#            Version of the API requested to use when responding to this request.
#          in: header
#          required: true
#          type: string
#      responses:
#        201:
505
#          description: |
506 507 508 509 510 511 512 513 514 515 516 517 518
#            201 CREATED
#
#            Shall be returned when the subscription has been created successfully.
#            A representation of the created "Individual subscription" resource shall be
#            returned in the response body, as defined in clause 6.5.2.3.
#            The HTTP response shall include a "Location" HTTP header that contains the
#            resource URI of the created "Individual subscription" resource.
#          headers:
#            Location:
#              description: The resource URI of the created VNF instance
#              type: string
#              format: url
#            Content-Type:
519
#              description: |
520 521 522 523 524 525
#                The MIME type of the body of the request.
#                Reference: IETF RFC 7231
#              type: string
#              maximum: 1
#              minimum: 1
#            WWW-Authenticate:
526
#              description: |
527 528 529 530 531 532 533
#                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
#            Version:
534
#              description: |
535 536 537 538 539 540 541
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#          schema:
#            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
#        303:
f.moscatelli's avatar
f.moscatelli committed
542
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
543
#        400:
f.moscatelli's avatar
f.moscatelli committed
544
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
545
#        401:
f.moscatelli's avatar
f.moscatelli committed
546
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
547
#        403:
f.moscatelli's avatar
f.moscatelli committed
548
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
549
#        404:
f.moscatelli's avatar
f.moscatelli committed
550
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
551
#        405:
f.moscatelli's avatar
f.moscatelli committed
552
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
553
#        406:
f.moscatelli's avatar
f.moscatelli committed
554
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
555
#        422:
f.moscatelli's avatar
f.moscatelli committed
556
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
557
#        500:
f.moscatelli's avatar
f.moscatelli committed
558
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
559
#        503:
f.moscatelli's avatar
f.moscatelli committed
560
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
561
#        504:
f.moscatelli's avatar
f.moscatelli committed
562
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
563 564
#
#    get:
565
#      description: |
566 567 568 569 570 571 572
#        Query Subscription Information.
#        TThe client can use this method to query the list of active subscriptions
#        to Performance management notifications subscribed by the client.
#        This method shall follow the provisions specified in the tables 6.4.7.3.2-1 and 6.4.7.3.2-2
#        for URI query parameters, request and response data structures, and response codes.
#      parameters:
#        - name: Accept
573
#          description: |
574 575 576 577 578 579
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231
#          in: header
#          required: true
#          type: string
#        - name: Authorization
580
#          description: |
581 582 583 584 585 586
#            The authorization token for the request.
#            Reference: IETF RFC 7235
#          in: header
#          required: false
#          type: string
#        - name: filter
587
#          description: |
588 589 590 591 592 593 594 595 596 597
#            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
#            The VNFM shall support receiving this parameter as part of the
#            URI query string. The NFVO may supply this parameter.
#            All attribute names that appear in the PmSubscription and in
#            data types referenced from it shall be supported by the VNFM
#            in the filter expression.
#          in: query
#          required: false
#          type: string
#        - name: nextpage_opaque_marker
598
#          description: |
599 600 601 602 603 604 605
#            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 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
#          in: query
#          required: false
#          type: string
#        - name: Version
606
#          description: |
607 608 609 610 611 612
#            Version of the API requested to use when responding to this request.
#          in: header
#          required: true
#          type: string
#      responses:
#        200:
613
#          description: |
614 615 616 617 618 619 620 621 622 623 624 625 626
#            200 OK
#
#            Shall be returned when the list of subscriptions has been queried successfully.
#            The response body shall contain in an array the representations of all active subscriptions
#            of the functional block that invokes the method, i.e. zero or more representations of
#            PM subscriptions as defined in clause 6.5.2.3.
#            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.
#            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.
#          headers:
#            Content-Type:
627
#              description: |
628 629 630 631 632 633
#                The MIME type of the body of the request.
#                Reference: IETF RFC 7231
#              type: string
#              maximum: 1
#              minimum: 1
#            WWW-Authenticate:
634
#              description: |
635 636 637 638 639 640 641
#                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
#            Version:
642
#              description: |
643 644 645 646 647
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#            Link:
648
#              description: |
649 650 651 652 653 654 655 656 657
#                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
#              type: string
#              maximum: 1
#              minimum: 0
#          schema:
#            type: array
#            items:
#              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
#        400:
f.moscatelli's avatar
f.moscatelli committed
658
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
659
#        401:
f.moscatelli's avatar
f.moscatelli committed
660
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
661
#        403:
f.moscatelli's avatar
f.moscatelli committed
662
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
663
#        404:
f.moscatelli's avatar
f.moscatelli committed
664
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
665
#        405:
f.moscatelli's avatar
f.moscatelli committed
666
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
667
#        406:
f.moscatelli's avatar
f.moscatelli committed
668
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
669
#        422:
f.moscatelli's avatar
f.moscatelli committed
670
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
671
#        500:
f.moscatelli's avatar
f.moscatelli committed
672
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
673
#        503:
f.moscatelli's avatar
f.moscatelli committed
674
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
675
#        504:
f.moscatelli's avatar
f.moscatelli committed
676
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
677 678 679 680 681 682 683 684
#
#  ###############################################################################
#  # Individual subscription                                                     #
#  ###############################################################################
#  '/subscriptions/{subscriptionId}':
#    #SOL003 location: 6.4.8
#    parameters:
#      - name: subscriptionId
685
#        description: |
686 687 688 689 690 691 692 693
#          This identifier can be retrieved from the resource referenced by the
#          "Location" HTTP header in the response to a POST request creating a
#          new "Individual subscription" resource. It can also be retrieved from the "id"
#          attribute in the payload body of that response.
#        in: path
#        type: string
#        required: true
#    get:
694
#      description: |
695 696 697 698 699 700 701
#        Query Subscription Information.
#        The client can use this method for reading an individual subscription about
#        Performance management notifications subscribed by the client.
#        This method shall follow the provisions specified in the tables 6.4.8.3.2-1 and 6.4.8.3.2-2
#        for URI query parameters, request and response data structures, and response codes.
#      parameters:
#        - name: Accept
702
#          description: |
703 704 705 706 707 708
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231
#          in: header
#          required: true
#          type: string
#        - name: Authorization
709
#          description: |
710 711 712 713 714 715
#            The authorization token for the request.
#            Reference: IETF RFC 7235
#          in: header
#          required: false
#          type: string
#        - name: Version
716
#          description: |
717 718 719 720 721 722
#            Version of the API requested to use when responding to this request.
#          in: header
#          required: true
#          type: string
#      responses:
#        200:
723
#          description: |
724 725 726 727 728 729 730
#            200 OK
#
#            Shall be returned when the subscription has been read successfully.
#            The response body shall contain a representation of the "Individual subscription" resource,
#            as defined in clause 6.5.2.3.
#          headers:
#            Content-Type:
731
#              description: |
732 733 734 735 736 737
#                The MIME type of the body of the request.
#                Reference: IETF RFC 7231
#              type: string
#              maximum: 1
#              minimum: 1
#            WWW-Authenticate:
738
#              description: |
739 740 741 742 743 744 745
#                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
#            Version:
746
#              description: |
747 748 749 750 751 752 753
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#          schema:
#            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
#        400:
f.moscatelli's avatar
f.moscatelli committed
754
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
755
#        401:
f.moscatelli's avatar
f.moscatelli committed
756
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
757
#        403:
f.moscatelli's avatar
f.moscatelli committed
758
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
759
#        404:
f.moscatelli's avatar
f.moscatelli committed
760
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
761
#        405:
f.moscatelli's avatar
f.moscatelli committed
762
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
763
#        406:
f.moscatelli's avatar
f.moscatelli committed
764
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
765
#        422:
f.moscatelli's avatar
f.moscatelli committed
766
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
767
#        500:
f.moscatelli's avatar
f.moscatelli committed
768
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
769
#        503:
f.moscatelli's avatar
f.moscatelli committed
770
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
771
#        504:
f.moscatelli's avatar
f.moscatelli committed
772
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
773 774
#
#    delete:
775
#      description: |
776 777 778 779 780 781 782 783 784 785 786 787
#        Terminate Subscription.
#        This method terminates an individual subscription.
#        This method shall follow the provisions specified in the tables 6.4.8.3.5-1 and 6.4.8.3.5-2
#        for URI query parameters, request and response data structures, and response codes.
#        As the result of successfully executing this method, the "Individual subscription" resource
#        shall not exist any longer. This means that no notifications for that subscription shall
#        be sent to the formerly-subscribed API consumer.
#
#          NOTE:	Due to race conditions, some notifications might still be received by the formerly-subscribed
#                API consumer for a certain time period after the deletion.
#      parameters:
#        - name: Authorization
788
#          description: |
789 790 791 792 793 794
#            The authorization token for the request.
#            Reference: IETF RFC 7235
#          in: header
#          required: false
#          type: string
#        - name: Version
795
#          description: |
796 797 798 799 800 801
#            Version of the API requested to use when responding to this request.
#          in: header
#          required: true
#          type: string
#      responses:
#        204:
802
#          description: |
803 804 805 806 807 808
#            204 NO CONTENT
#
#            Shall be returned when the "Individual subscription" resource has been deleted successfully.
#            The response body shall be empty.
#          headers:
#            WWW-Authenticate:
809
#              description: |
810 811 812 813 814 815 816
#                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
#            Version:
817
#              description: |
818 819 820 821 822
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#        400:
f.moscatelli's avatar
f.moscatelli committed
823
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
824
#        401:
f.moscatelli's avatar
f.moscatelli committed
825
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
826
#        403:
f.moscatelli's avatar
f.moscatelli committed
827
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
828
#        404:
f.moscatelli's avatar
f.moscatelli committed
829
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
830
#        405:
f.moscatelli's avatar
f.moscatelli committed
831
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
832
#        406:
f.moscatelli's avatar
f.moscatelli committed
833
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
834
#        422:
f.moscatelli's avatar
f.moscatelli committed
835
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
836
#        500:
f.moscatelli's avatar
f.moscatelli committed
837
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
838
#        503:
f.moscatelli's avatar
f.moscatelli committed
839
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
840
#        504:
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 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 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
#          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"


components:
  parameters:
    PmJobId:
      name: pmJobId
      in: path
      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 "Individual PM job" resource. It can also be retrieved from the "id"
        attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ReportId:
      name: reportId
      in: path
      description: |
        Identifier of the performance report.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ThresholdId:
      name: thresholdId
      in: path
      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 "Individual threshold" resource. It can also be retrieved from the "id"
        attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

  requestBodies:
    CreatePmJobRequest:
      description: The VNF creation parameters
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
      required: true
    
    CreateThresholdRequest:
      description: Request parameters to create a threshold resource.
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
      required: true

  responses:
    PMJobs.Post.201:
      description: |
        201 CREATED

        Shall be returned when the PM job has been created successfully.
        The response body shall contain a representation of the created "Individual PM job" resource,
        as defined in clause 6.5.2.7.
        The HTTP response shall include a "Location" HTTP header that points to the created
        "Individual PM job" resource.
      headers:
        Location:
          description: The resource URI of the created PM Job
          style: simple
          explode: false
          schema:
            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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"

    PMJobs.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more PM jobs has been queried successfully.
        The response body shall contain in an array the representations of zero or more PM jobs,
        as defined in clause 6.5.2.7.
        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 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.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"

    IndividualPMJob.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual PM job has been read successfully.
        The response body shall contain a representation of the "Individual PM job" resource,
        as defined in clause 6.5.2.7.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"

    IndividualPMJob.Patch.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. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications"

    IndividualPMJob.Delete.200:
      description: |
        204 NO CONTENT

        Shall be returned when the PM job has been deleted successfully.
        The response body shall be empty.
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPerformanceReport.Get.200:
      description: |
        200 OK

        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,
        as defined in clause 6.5.2.10.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport"

    Thresholds.Post.201:
      description: |
        201 CREATED

        Shall be returned when a threshold has been created successfully.
        The response body shall contain a representation of the created "Individual threshold" resource,
        as defined in clause 6.5.2.9.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
        created threshold resource.
      headers:
        Location:
          description: TThe resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"

    Thresholds.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more thresholds has been queried successfully.
        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.
      headers:
        Location:
          description: The resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"

    IndividualThreshold.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual threshold has been read successfully.
        The response body shall contain a representation of the threshold, as defined in clause 6.5.2.9.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"

    IndividualThreshold.Patch.200:
      description: |
        200 OK

        Shall be returned when the request has been processed successfully.
        The response body shall contain a data structure of type "ThresholdModifications".
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications"

    IndividualThreshold.Delete.200:
      description: |
        204 NO CONTENT

        The threshold was deleted successfully.
        The response body shall be empty.
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string