NFVManoPerformanceManagement.yaml 66 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  title: SOL009 - NFV-MANO Performance Management Interface
  description: >
    SOL009 - NFV-MANO Performance Management Interface

    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    name: NFV-SOL WG
externalDocs:
Giacomo Bernini's avatar
Giacomo Bernini committed
19
20
  description: ETSI GS NFV-SOL 009 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

servers:
  - url: http://0.0.0.0/nfvmanopm/v1
    description: >
      API HTTP Server
  - url: https://0.0.0.0/nfvmanopm/v1
    description: >
      API HTTPS Server

paths:
  /api_versions:
    $ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
    
  /pm_jobs:
    post:
      description: >
        Creates a PM job.

        This method shall follow the provisions specified in the tables 
        6.5.3.3.1-1 and 6.5.3.3.1-2 for URI query parameters, request and 
        response data structures, and response codes.
      parameters:
43
44
45
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
46
47
48
49
50
51
      requestBody:
        $ref: "#/components/requestBodies/CreatePMJobRequest"
      responses:
        "201": 
          $ref: "#/components/responses/pm_jobs.post.201"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
52
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
53
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
54
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
55
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
56
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
57
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
58
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
59
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
60
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
61
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
62
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
63
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
64
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
65
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
66
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
67
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
68
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
69
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
70
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
71
72
73
74
75
    get:
      description: >
        The client can use this method to retrieve information about PM jobs.
      parameters:
        - $ref: "#/components/parameters/filter.PmJob"
76
77
78
        - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/fields"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields"
79
        - $ref: "#/components/parameters/exclude_default.PmJob"
80
81
82
83
        - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
84
85
86
87
88
89
      responses:
        "200": 
          $ref: "#/components/responses/pm_jobs.get.200"
        "400": 
          $ref: "#/components/responses/pm_jobs.get.400"
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
90
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
91
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
92
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
93
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
94
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
95
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
96
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
97
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
98
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
99
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
100
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
101
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
102
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
103
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
104
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
105
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
106
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
107
108

  /pm_jobs/{pmJobId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
109
110
    parameters:
      - $ref: "#/components/parameters/pmJobId"
111
112
113
114
    get:
      description: >
        The client can use this method for reading an individual PM job. 
      parameters:
115
116
117
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
118
119
120
121
      responses:
        "200": 
          $ref: "#/components/responses/pm_job.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
122
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
123
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
124
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
125
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
126
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
127
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
128
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
129
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
130
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
131
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
132
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
133
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
134
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
135
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
136
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
137
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
138
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
139
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
140
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
Sana Zulfiqar's avatar
Sana Zulfiqar committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
    patch:
      description: >
        This method allows to modify an "individual PM job" resource.

        This method shall follow the provisions specified in the tables 6.5.4.3.4-1
        and 6.5.4.3.4-2 for URI query parameters, request and response data structures,
        and response codes.
      parameters:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      requestBody:
        $ref: "#/components/requestBodies/PmJobModificationRequest"
      responses:
        "200":
          $ref: "#/components/responses/threshold.patch.200"
        "412":
          $ref: "#/components/responses/threshold.patch.412"
        "422":
          $ref: "#/components/responses/threshold.patch.422"
        "400":
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
        "401":
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
        "403":
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
        "404":
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
        "405":
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
        "406":
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
        "409":
          $ref: ../components/SOL009_resp.yaml#/components/responses/409
        "500":
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
        "503":
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
        "504":
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
181
182
183
184
    delete:
      description: >
        This method terminates an individual PM job.
      parameters:
185
186
187
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
188
189
190
191
      responses:
        "204": 
          $ref: "#/components/responses/pm_job.delete.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
192
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
193
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
194
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
195
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
196
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
197
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
198
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
199
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
200
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
201
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
202
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
203
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
204
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
205
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
206
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
207
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
208
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
209
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
210
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
211
212
  
  /pm_jobs/{pmJobId}/reports/{reportId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
213
214
215
    parameters:
      - $ref: "#/components/parameters/pmJobId"
      - $ref: "#/components/parameters/reportId"
216
217
218
219
220
    get:
      description: >
        The client can use this method for reading an individual 
        performance report. 
      parameters:
221
222
223
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
224
225
226
227
      responses:
        "200": 
          $ref: "#/components/responses/pm_job.report.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
228
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
229
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
230
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
231
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
232
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
233
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
234
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
235
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
236
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
237
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
238
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
239
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
240
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
241
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
242
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
243
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
244
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
245
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
246
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
247
248
249
250
251
252

  /thresholds:
    post:
      description: >
        The POST method can be used by the client to create a threshold.
      parameters:
253
254
255
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
256
257
258
259
260
261
      requestBody:
        $ref: "#/components/requestBodies/CreateThesholdRequest"
      responses:
        "201": 
          $ref: "#/components/responses/thresholds.post.201"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
262
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
263
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
264
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
265
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
266
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
267
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
268
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
269
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
270
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
271
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
272
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
273
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
274
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
275
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
276
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
277
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
278
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
279
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
280
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
281
282
283
284
285
    get:
      description: >
        The client can use this method to query information about thresholds.
      parameters:
        - $ref: "#/components/parameters/filter.Threshold"
286
287
288
289
        - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
290
291
292
293
294
295
      responses:
        "200": 
          $ref: "#/components/responses/thresholds.get.200"
        "400": 
          $ref: "#/components/responses/thresholds.get.400"
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
296
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
297
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
298
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
299
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
300
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
301
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
302
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
303
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
304
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
305
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
306
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
307
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
308
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
309
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
310
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
311
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
312
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
313
314
    
  /thresholds/{thresholdId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
315
316
    parameters:
      - $ref: "#/components/parameters/thresholdId"
317
318
319
320
    get:
      description: >
        The client can use this method for reading an individual threshold 
      parameters:
321
322
323
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
324
325
326
327
      responses:
        "200": 
          $ref: "#/components/responses/threshold.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
328
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
329
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
330
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
331
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
332
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
333
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
334
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
335
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
336
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
337
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
338
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
339
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
340
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
341
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
342
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
343
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
344
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
345
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
346
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
Sana Zulfiqar's avatar
Sana Zulfiqar committed
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
    patch:
      description: >
        This method allows to modify an "Individual threshold" resource.
        This method shall follow the provisions specified in the tables
        6.5.7.3.4-1 and 6.5.7.3.4-2 for URI query parameters, request and
        response data structures, and response codes
      parameters:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      requestBody:
        $ref: "#/components/requestBodies/ThresholdModificationRequest"
      responses:
        "200":
          $ref: "#/components/responses/threshold.patch.200"
        "412":
          $ref: "#/components/responses/threshold.patch.412"
        "422":
          $ref: "#/components/responses/threshold.patch.422"
        "400":
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
        "401":
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
        "403":
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
        "404":
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
        "405":
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
        "406":
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
        "409":
          $ref: ../components/SOL009_resp.yaml#/components/responses/409
        "500":
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
        "503":
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
        "504":
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
386
387
388
389
    delete:
      description: >
        This method allows to delete a threshold.
      parameters:
390
391
392
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
393
394
395
396
      responses:
        "204": 
          $ref: "#/components/responses/threshold.delete.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
397
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
398
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
399
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
400
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
401
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
402
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
403
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
404
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
405
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
406
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
407
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
408
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
409
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
410
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
411
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
412
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
413
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
414
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
415
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
416
417
418
419
420

components:
  schemas:
    CreatePmJobRequest:
      description: >
421
        This type represents a request to create a PM job. 
422
423
      type: object
      properties:
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
        objectType:
          description: >
            Type of measured object. The applicable measured object type for a measurement 
            is defined in clause 8.2 of ETSI GS NFV-IFA 031.
          type: string
        objectInstanceIds:
          description: >
            Identifiers of the measured object instance for which performance information 
            is requested to be collected. This attribute shall contain the identifier of 
            the instance of the measure object according to their type.
            See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
            If more than one identifier is provided, values shall all refer to measured 
            object instances of the same type, for which the same criteria is then applicable.
          type: array
          items:
439
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
440
441
442
443
444
445
446
447
448
449
450
451
452
453
          minItems: 1
        subObjectInstanceIds:
          description: >
            Identifiers of the sub-object instances of the measured object instance for 
            which performance information is requested to be collected. 
            May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
            for the related measured object type.
            If this attribute is present, the cardinality of the "objectInstanceIds" 
            attribute shall be 1.
            If this attribute is absent and a sub-object is defined in clause 8.2 of 
            ETSI GS NFV-IFA 031 for the related measured object type, measurements will 
            be taken for all sub-object instances of the measured object instance.
          type: array
          items:
454
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
455
456
457
458
        criteria:
          description: >
            Criteria of the collection of performance information.
          $ref: "#/components/schemas/PmJobCriteria"
459
460
461
462
463
464
465
466
467
468
469
470
471
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        authentication:
          description: >
            Authentication parameters to configure the use of Authorization when
            sending notifications corresponding to this subscription, as defined
            in clause 8.3.4 of ETSI GS NFV-SOL 013.

            This attribute shall only be present if the subscriber requires
            authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
472
      required:
473
474
475
        - objectType
        - objectInstanceIds
        - criteria
476
        - callbackUri
477
478
479

    PmJob:
      description: >
480
        This type represents a PM job. 
481
482
      type: object
      properties:
483
484
485
        id:
          description: >
            Identifier of this PM job.
486
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
487
488
489
490
491
492
493
494
495
496
497
498
499
        objectType:
          description: >
            Type of measured object. The applicable measured object type for a measurement is 
            defined in clause 8.2 of ETSI GS NFV-IFA 031.
          type: string
        objectInstanceIds:
          description: >
            Identifiers of the measured object instance for which performance information 
            is collected. This attribute shall contain the identifier of the instance of 
            the measure object according to their type.
            See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
          type: array 
          items:
500
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
501
502
503
504
505
506
507
508
509
510
511
512
513
514
          minItems: 1
        subObjectInstanceIds:
          description: >
            Identifiers of the sub-object instances of the measured object instance for 
            which performance information is requested to be collected. 
            May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
            for the related measured object type.
            If this attribute is present, the cardinality of the "objectInstanceIds" 
            attribute shall be 1.
            If this attribute is absent and a sub-object is defined in clause 8.2 of 
            ETSI GS NFV-IFA 031 for the related measured object type, measurements will 
            be taken for all sub-object instances of the measured object instance.
          type: array 
          items:
515
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
516
517
518
519
        criteria:
          description: >
            Criteria of the collection of performance information.
          $ref: "#/components/schemas/PmJobCriteria"
520
521
522
523
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
524
525
526
527
528
529
530
531
532
533
        reports:
          description: >
            Information about available reports collected by this PM job.
          type: array 
          items:
            type: object 
            properties:
              href:
                description: >
                  The Uri where the report can be obtained.
534
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
535
536
537
              readyTime:
                description: >
                  The time when the report was made available.
538
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
539
540
541
              expiryTime:
                description: >
                  The time when the report will expire.
542
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
543
544
545
              fileSize:
                description: >
                  The size of the report file in bytes, if known.
546
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
547
548
549
550
551
552
553
554
555
556
557
            required:
              - href
              - readyTime
        _links:
          description: >
            Links for this resource.
          type: object
          properties:
            self:
              description: >
                  URI of this resource.
558
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
559
560
561
562
563
564
565
            objects:
              description: >
                Links to resources representing the measured object instances for which 
                performance information is collected. Shall be present if the measured 
                object instance information is accessible as a resource.
              type: array
              items:
566
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
567
568
          required:
            - self
569
      required:
570
571
572
573
574
        - id
        - objectType
        - objectInstanceIds
        - criteria
        - _links
575
        - callbackUri
576
577
578

    CreateThresholdRequest :
      description: >
579
        This type represents a request to create a threshold. 
580
581
      type: object
      properties:
582
583
584
585
586
587
588
589
590
591
592
        objectType:
          description: >
            Type of measured object. The applicable measured object type for a measurement 
            is defined in clause 8.2 of ETSI GS NFV-IFA 031.
          type: string
        objectInstanceId:
          description: >
            Identifier of the measured object instance associated with this threshold. 
            This attribute shall contain the identifier of the instance of the measure 
            object according to their type.
            See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
593
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
594
595
596
597
598
599
600
601
602
603
604
        subjObjectInstanceIds:
          description: >
            Identifiers of the sub-object instances of the measured object instance 
            associated with this threshold. 
            May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
            for the related measured object type.
            If this attribute is absent and a sub-object is defined in clause 8.2 of ETSI 
            GS NFV-IFA 031 for the related measured object type, thresholds will be set 
            for all sub-object instances of the measured object instance.
          type: array
          items:
605
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
606
607
608
609
        criteria:
          description: >
            Criteria that define this threshold.
          $ref: "#/components/schemas/ThresholdCriteria"
610
611
612
613
614
615
616
617
618
619
620
621
622
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        authentication:
          description: >
            Authentication parameters to configure the use of Authorization when
            sending notifications corresponding to this subscription, as defined
            in clause 8.3.4 of ETSI GS NFV-SOL 013.

            This attribute shall only be present if the subscriber requires
            authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
623
      required:
624
625
626
        - objectType
        - objectInstanceId
        - criteria
627
        - callbackUri
628
629
630
631
632
633

    Threshold:
      description: >

      type: object
      properties:
634
635
636
        id:
          description: >
            Identifier of this threshold resource.
637
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
638
639
640
641
642
643
644
645
646
647
648
        objectType:
          description: 
            Type of measured object. The applicable measured object type for a measurement 
            is defined in clause 8.2 of ETSI GS NFV-IFA 031.
          type: string
        objectInstanceId:
          description: >
            Identifier of the measured object instance associated with the threshold. 
            This attribute shall contain the identifier of the instance of the measure 
            object according to their type.
            See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
649
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
650
651
652
653
654
655
656
657
658
659
660
        subjObjectInstanceIds:
          description: >
            Identifiers of the sub-object instances of the measured object instance 
            associated with this threshold. 
            May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
            for the related measured object type.
            If this attribute is absent and a sub-object is defined in clause 8.2 of ETSI 
            GS NFV-IFA 031 for the related measured object type, thresholds are set for 
            all sub-object instances of the measured object instance.
          type: array 
          items:
661
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
662
663
664
665
        criteria:
          description: >
            Criteria that define this threshold.
          $ref: "#/components/schemas/ThresholdCriteria"
666
667
668
669
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
670
671
672
673
674
675
676
677
        _links:
          description: >
            Links for this resource.
          type: object
          properties:
            self:
              description: >
                URI for this resource.
678
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
679
680
681
682
683
            object:
              description: >
                Link to a resource representing the measured object instance for which performance 
                information is collected. Shall be present if the measured object instance information 
                is accessible as a resource.
684
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
685
686
687
688
689
690
691
692
693
          required:
            - self
      required:
        - id
        - objectType
        - objectInstanceId
        - subjObjectInstanceIds
        - criteria
        - _links
694
        - callbackUri
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
    
    PerformanceReport:
      description: >
        This type defines the format of a performance report provided by the NFV-MANO functional 
        entity to the API consumer as a result of collecting performance information as part 
        of a PM job. 
      type: object
      properties:
        entries: 
          description: >
            List of performance information entries. Each performance report entry is for a given 
            metric of a given object (i.e. measured object instance) corresponding to the related 
            measured object types, but can include multiple collected values.
          type: array
          items:
            type: object
            properties:
              objectType:
                description: >
                  Type of measured object. The applicable measured object type for a measurement is 
                  defined in clause 8.2 of ETSI GS NFV-IFA 031.
                type: string
              objectInstanceId:
                description: >
                  The object instance (i.e. measured object instance) for which the performance metric 
                  is reported. This attribute shall contain the identifier of the instance of the 
                  measure object according to their type.
                  See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
723
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
724
725
726
727
728
              subObjectInstanceId:
                description: >
                  Identifier of the sub-object instance of the measured object instance for which the 
                  performance metric is reported. Shall be present if this is required in clause 8.2 
                  of ETSI GS NFV-IFA 031 [1] for the related measured object type.
729
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
              performanceMetric:
                description: >
                  Name of the metric collected. This attribute shall contain the related 
                  "Measurement Name" value as defined in clause 8.4 of ETSI GS NFV-IFA 031.
                type: string
              performanceValues:
                description: >
                  List of performance values with associated timestamp.
                type: array
                items:
                  type: object
                  properties:
                    timeStamp:
                      description: >
                        Time stamp indicating when the data was collected.
745
                      $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
746
747
748
749
750
751
752
753
                    value:
                      description: >
                        Value of the metric collected. The type of this attribute shall correspond to 
                        the related "Measurement Unit" as defined in clause 8.4 of ETSI GS NFV-IFA 031.
                    context:
                      description: >
                        Measurement context information related to the measured value. The set of 
                        applicable keys is defined per measurement in clause 8.4 of ETSI GS NFV-IFA 031.
754
                      $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
755
756
757
758
759
760
761
762
763
764
                  required:
                    - timeStamp
                    - value
                minItems: 1
            required:
              - objectType
              - objectInstanceId
              - performanceMetric
              - performanceValues
          minItems: 1
765
      required:
766
        - entries
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
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
    PmJobModifications:
      description: >
        This type represents modifications to a PM job.
      type: object
      properties:
        callbackUri:
          description: >
            New value of the "callbackUri" attribute.The value "null" is not permitted.

            NOTE: At least one of the attributes defined in this type
            shall be present in request bodies.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        authentication:
          description: >
            New value of the "authentication" attribute, or "null" to remove the attribute.
            If present in a request body, these modifications shall be applied according
            to the rules of JSONMerge PATCH (see IETF RFC 7396).

            This attribute shall not be present in response bodies.

            NOTE: At least one of the attributes defined in this type
            shall be present in request bodies..
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"

    ThresholdModifications:
      description: >
        This type represents modifications to a threshold.
      type: object
      properties:
        callbackUri:
          description: >
            New value of the "callbackUri" attribute.The value "null" is not permitted.

            NOTE: At least one of the attributes defined in this type
            shall be present in request bodies.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        authentication:
          description: >
            New value of the "authentication" attribute, or "null" to remove the attribute.
            If present in a request body, these modifications shall be applied according
            to the rules of JSONMerge PATCH (see IETF RFC 7396).

            This attribute shall not be present in response bodies.

            NOTE: At least one of the attributes defined in this type
            shall be present in request bodies..
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"

816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
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
    #----------

    PmJobCriteria:
      description: >
        This type represents collection criteria for PM jobs.
      type: object
      properties:
        performanceMetric: 
          description: >
            This defines the types of performance metrics for the specified measured 
            object(s). This attribute’s value shall contain the related "Measurement Name" 
            values as defined in clause 8.4 of ETSI GS NFV-IFA 031. 
            At least one of the two attributes (performance metric or group) shall be present.
          type: array
          items:
            type: string
        performanceMetricGroup:
          description: >
            Group of performance metrics.
            A metric group is a pre-defined list of metrics, known to the producer that it 
            can decompose to individual metrics. This attribute’s value shall contain the 
            related "Measurement Group" values as defined in clause 8.4 of ETSI GS 
            NFV-IFA 031.
            At least one of the two attributes (performance metric or group) shall be present.
          type: array
          items:
            type: string
        collectionPeriod:
          description: >
            Specifies the periodicity at which the producer will collect performance 
            information. The unit shall be seconds. 

            At the end of each reportingPeriod, the producer will inform the API consumer 
            about availability of the performance data collected for each completed 
            collection period during this reportingPeriod. The reportingPeriod should 
            be equal to or a multiple of the collectionPeriod. In the latter case, the 
            performance data for the collection periods within one reporting period 
            are reported together. 

            In particular when choosing short collection and reporting periods, the 
            number of PM jobs that can be supported depends on the capability of the 
            producing entity.
          type: integer
        reportingPeriod:
          description: >
            Specifies the periodicity at which the producer will report to the API consumer 
            about performance information. The unit shall be seconds.

            At the end of each reportingPeriod, the producer will inform the API consumer 
            about availability of the performance data collected for each completed 
            collection period during this reportingPeriod. The reportingPeriod should 
            be equal to or a multiple of the collectionPeriod. In the latter case, the 
            performance data for the collection periods within one reporting period 
            are reported together. 

            In particular when choosing short collection and reporting periods, the 
            number of PM jobs that can be supported depends on the capability of the 
            producing entity.
          type: integer
        reportingBoundary:
          description: >
            Identifies a time boundary after which the reporting will stop.
            The boundary shall allow a single reporting as well as periodic reporting up to 
            the boundary.
880
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
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
      required:
        - collectionPeriod
        - reportingPeriod

    ThresholdCriteria:
      description: >
        This type represents criteria that define a threshold.
      type: object
      properties:
        performanceMetric:
          description: >
            Defines the performance metric associated with the threshold. 
            This attribute’s value shall contain the related "Measurement Name" values 
            as defined in clause 8.4 of ETSI GS NFV-IFA 031 
          type: string
        thresholdType:
          description: >
            Type of threshold. This attribute determines which other attributes are 
            present in the data structure.
            Permitted values:
              - SIMPLE: Single-valued static threshold
            
            In the present document, simple thresholds are defined. The definition 
            of additional threshold types is left for future specification.
          type: string
          enum:
            - SIMPLE
        simpleThresholdDetails:
          description: >
            Details of a simple threshold. Shall be present if thresholdType="SIMPLE".
          type: object
          properties:
            thresholdValue:
              description: >
                The threshold value. Shall be represented as a floating point number. 
916
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Number"
917
918
919
920
921
922
923
924
925
926
927
928
929
            hysteresis:
              description: >
                The hysteresis of the threshold. 
                Shall be represented as a non-negative floating point number.
                A notification with crossing direction "UP" will be generated if the 
                measured value reaches or exceeds "thresholdValue" + "hysteresis". 
                A notification with crossing direction "DOWN" will be generated if 
                the measured value reaches or undercuts "thresholdValue" - "hysteresis". 

                The hysteresis is defined to prevent storms of threshold crossing notifications.
                When processing a request to create a threshold, implementations should enforce 
                a suitable minimum value for this attribute (e.g. override the value or reject 
                the request). 
930
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Number"
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
          required: 
            - thresholdValue
            - hysteresis
      required:
        - performanceMetric
        - thresholdType

    #----------------
    # common types to SOL009
    #----------------

  responses:
    pm_jobs.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.6.2.7.

        The HTTP response shall include a "Location" HTTP header that 
        points to the created "Individual PM job" resource.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PmJob"
971
972
973
974
975
976
977
978
979
980
981
982
983
984
    pm_jobs.post.422:
      description: >
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type
        of the payload body is supported and the payload body of a request
        contains syntactically correct data but the data cannot be processed.

        The general cause for this error and its handling is specified in
        clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
        of the response body.

        Specifically in case of this resource, the response code 422 shall also
        be returned if the API producer has tested the Notification endpoint as
985
        described in clause 6.5.10.3.2 and the test has failed.
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006

        In this case, the "detail" attribute in the "ProblemDetails" structure
        shall convey more information about the error.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"

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
    pm_jobs.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.6.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 NFV-MANO functional entity 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:
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
        Link:
          description: >
            Reference to other resources. Link HTTP header in this response 
            shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/PmJob"
    pm_jobs.get.400:
      description: >
        400 BAD REQUEST

        Shall be returned upon the following errors: 
          - Invalid attribute-based filtering expression.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Invalid attribute selector.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Response too big.
            If the NFV-MANO functional entity supports alternative N°1 (error) 
            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, 
            this error response shall follow the provisions in clause 5.4.2.2 of 
            ETSI GS NFV-SOL 013.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
1086
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
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

    pm_job.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.6.2.7.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PmJob"
Sana Zulfiqar's avatar
Sana Zulfiqar committed
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
    pm_job.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:
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PmJobModifications"
    pm_job.patch.412:
      description: >
        412 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.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
    pm_job.patch.422:
      description: >
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type
        of the payload body is supported and the payload body of a request
        contains syntactically correct data but the data cannot be processed.

        The general cause for this error and its handling is specified in
        clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
        of the response body.

        Specifically in case of this resource, the response code 422 shall also
        be returned if the API producer has tested the Notification endpoint as
        described in clause 6.5.10.3.2 and the test has failed.

        In this case, the "detail" attribute in the "ProblemDetails" structure
        shall convey more information about the error.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
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
    pm_job.delete.204:
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

    pm_job.report.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.6.2.10.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/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.6.2.9.

        The HTTP response shall include a "Location" HTTP header that 
        contains the resource URI of the created "Individual threshold" 
        resource.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
        Location:
          description: >
            The resource URI of the created "Individual change state 
            operation occurence" resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Threshold"
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
    thresholds.post.422:
      description: >
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type
        of the payload body is supported and the payload body of a request
        contains syntactically correct data but the data cannot be processed.

        The general cause for this error and its handling is specified in
        clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
        of the response body.

        Specifically in case of this resource, the response code 422 shall also
        be returned if the API producer has tested the Notification endpoint as
        described in clause 6.5.10.3.2 and the test has failed.

        In this case, the "detail" attribute in the "ProblemDetails" structure
        shall convey more information about the error.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"

1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
    thresholds.get.200:
      description: >
        200 OK

        Shall be returned when information about zero or more thresholds 
        has been queried successfully.

        The response body shall contain in an array the representations 
        of zero or more thresholds, as defined in clause 6.6.2.9.

        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 NFV-MANO functional entity 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:
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/Threshold"
    thresholds.get.400:
      description: >
        400 BAD REQUEST

        Shall be returned upon the following errors: 
          - Invalid attribute-based filtering expression.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Response too big.
            If the NFV-MANO functional entity supports alternative N°1 (error) 
            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, 
            this error response shall follow the provisions in clause 5.4.2.2 of 
            ETSI GS NFV-SOL 013.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
1391
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418

    threshold.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.6.2.9.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Threshold"
Sana Zulfiqar's avatar
Sana Zulfiqar committed
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508

    threshold.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:
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ThresholdModifications"
    threshold.patch.412:
      description: >
        412 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.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
    threshold.patch.422:
      description: >
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type
        of the payload body is supported and the payload body of a request
        contains syntactically correct data but the data cannot be processed.

        The general cause for this error and its handling is specified in
        clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
        of the response body.

        Specifically in case of this resource, the response code 422 shall also
        be returned if the API producer has tested the Notification endpoint as
        described in clause 6.5.10.3.2 and the test has failed.

        In this case, the "detail" attribute in the "ProblemDetails" structure
        shall convey more information about the error.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"

1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
    threshold.delete.204:
      description: >
        204 NO CONTENT
        
        Shall be returned when the threshold 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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

  parameters:

    filter.PmJob :
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of 
        ETSI GS NFV-SOL 013. 

        The NFV-MANO functional entity shall support receiving this parameter 
        as part of the URI query string. The API consumer may supply this 
        parameter. 

        All attribute names that appear in the PmJob  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    filter.Threshold :
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of 
        ETSI GS NFV-SOL 013. 

        The NFV-MANO functional entity shall support receiving this parameter 
        as part of the URI query string. The API consumer may supply this 
        parameter. 

        All attribute names that appear in the Threshold  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    exclude_default.PmJob :
      name: exclude_default
      description: >
        Indicates to exclude the following complex attributes from the 
        response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
        The NFV-MANO functional entity shall support this parameter.

        The following attributes shall be excluded from the PmJob 
        structure in the response body if this parameter is provided, or none of 
        the parameters "all_fields," "fields", "exclude_fields", "exclude_default" 
        are provided:
        - none
      in: query
      required: false
      schema:
        type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605