VNFPerformanceManagement.yaml 35.3 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
moscatelli's avatar
moscatelli committed
4
  title: SOL002 - VNF Perfomance Management interface
5
  description: |
Giacomo Bernini's avatar
Giacomo Bernini committed
6
7
8
9
10
11
    SOL002 - VNF 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. 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
Giacomo Bernini's avatar
Giacomo Bernini committed
13

14
15
  contact:
    name: NFV-SOL WG
16
  license:
moscatelli's avatar
moscatelli committed
17
    name: ETSI Forge copyright notice
18
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
19
  version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
20

21
externalDocs:
Sana Zulfiqar's avatar
Sana Zulfiqar committed
22
23
  description: ETSI GS NFV-SOL 002 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.05.01_60/gs_NFV-SOL002v030501p.pdf
24

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

paths:
30
31
  /api_versions:
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
32

33
  /pm_jobs:
34
    parameters:
35
36
37
38
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
39
        The API consumer can use this method to retrieve information about PM jobs. See clause 6.4.2.3.2.
40
41
42
43
44
45
46
47
48
49
50
51
52
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
        - $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
      responses:
        "200":
          $ref: '#/components/responses/PmJobs.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
53
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
54
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
55
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
56
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
57
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
58
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
59
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
60
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
61
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
62
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
63
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
64
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
65
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
66
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
67
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
68
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
69
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
70
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
71
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
72
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
73
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
74
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
75
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
76

77
    post:
78
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
79
        The POST method creates a PM job. See clause 6.4.2.3.1.
80
      parameters:
81
82
83
84
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/PmJobCreationRequest'
85
      responses:
86
87
88
        "201":
          $ref: '#/components/responses/PmJobs.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
89
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
90
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
91
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
92
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
93
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
94
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
95
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
96
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
97
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
98
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
99
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
100
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
101
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
102
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
103
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
104
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
105
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
106
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
107
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
108
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
109
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
110
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
111
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
moscatelli's avatar
moscatelli committed
112

113
114
115
116
117
  /pm_jobs/{pmJobId}:
    parameters:
      - $ref: '#/components/parameters/PmJobId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
118
    get:
119
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
120
        The API consumer can use this method for reading an individual PM job. See clause 6.4.3.3.2.
121
      parameters:
122
123
124
125
126
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      responses:
        "200":
          $ref: '#/components/responses/IndividualPmJob.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
127
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
128
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
129
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
130
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
131
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
132
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
133
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
134
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
135
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
136
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
137
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
138
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
139
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
140
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
141
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
142
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
143
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
144
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
145
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
146
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
147
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
148
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
149
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
150

151
152
    delete:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
153
        This method terminates an individual PM job. See clause 6.4.3.3.5.
154
155
156
157
      responses:
        "204":
          $ref: '#/components/responses/IndividualPmJob.Delete'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
158
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
159
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
160
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
161
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
162
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
163
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
164
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
165
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
166
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
167
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
168
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
169
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
170
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
171
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
172
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
173
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
174
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
175
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
176
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
177
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
178
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
179
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
180
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
181

182
183
    patch:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
184
        This method allows to modify an "individual PM job" resource. See clause 6.4.3.3.4.
185
186
187
188
189
190
      requestBody:
        $ref: '#/components/requestBodies/PmJobModificationRequest'
      responses:
        "200":
          $ref: '#/components/responses/IndividualPmJob.Patch'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
191
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
192
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
193
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
194
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
195
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
196
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
197
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
198
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
199
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
200
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
201
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
202
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
203
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
204
        "412":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
205
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
206
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
207
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
208
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
209
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
210
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
211
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
212
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
213
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
214
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
215
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
216
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
217
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
218

219
220
221
222
223
224
225
226
  /pm_jobs/{pmJobId}/reports/{reportId}:
    parameters:
      - $ref: '#/components/parameters/PmJobId'
      - $ref: '#/components/parameters/ReportId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
227
        The API consumer can use this method for reading an individual performance report. See clause 6.4.4.3.2.
228
229
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
230
      responses:
231
232
233
        "200":
          $ref: '#/components/responses/IndividualPmJobReport.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
234
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
235
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
236
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
237
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
238
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
239
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
240
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
241
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
242
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
243
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
244
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
245
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
246
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
247
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
248
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
249
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
250
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
251
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
252
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
253
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
254
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
255
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
256
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
Gergely Csatari's avatar
Gergely Csatari committed
257

258
  /thresholds:
259
    parameters:
260
261
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
262
    get:
263
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
264
        The API cosumer can use this method to query information about thresholds. See clause 6.4.5.3.2.
265
      parameters:
266
267
268
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
269
      responses:
270
271
272
        "200":
          $ref: '#/components/responses/Thresholds.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
273
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
274
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
275
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
276
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
277
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
278
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
279
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
280
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
281
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
282
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
283
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
284
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
285
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
286
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
287
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
288
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
289
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
290
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
291
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
292
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
293
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
294
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
295
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
Gergely Csatari's avatar
Gergely Csatari committed
296

297
298
    post:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
299
        The POST method can be used by API consumer to create a threshold. See clause 6.4.5.3.1.
300
      parameters:
301
302
303
304
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/ThresholdCreationRequest'
305
      responses:
306
307
308
        "201":
          $ref: '#/components/responses/Thresholds.Post'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
309
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
310
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
311
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
312
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
313
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
314
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
315
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
316
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
317
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
318
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
319
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
320
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
321
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
322
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
323
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
324
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
325
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
326
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
327
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
328
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
329
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
330
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
331
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
332
333
334
335
336
337
338
339

  /thresholds/{thresholdId}:
    parameters:
      - $ref: '#/components/parameters/ThresholdId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
340
        The client can use this method for reading an individual threshold. See clause 6.4.6.3.2.
341
342
343
344
345
346
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      responses:
        "200":
          $ref: '#/components/responses/IndividualThreshold.Get'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
347
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
348
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
349
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
350
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
351
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
352
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
353
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
354
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
355
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
356
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
357
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
358
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
359
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
360
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
361
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
362
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
363
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
364
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
365
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
366
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
367
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
368
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
369
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
370

371
    delete:
372
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
373
        This method allows to delete a threshold. See clause 6.4.6.3.5.
374
375
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
376
      responses:
377
378
379
        "204":
          $ref: '#/components/responses/IndividualThreshold.Delete'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
380
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
381
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
382
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
383
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
384
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
385
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
386
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
387
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
388
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
389
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
390
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
391
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
392
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
393
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
394
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
395
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
396
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
397
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
398
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
399
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
400
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
401
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
402
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
Gergely Csatari's avatar
Gergely Csatari committed
403

404
405
    patch:
      description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
406
        This method allows to modify an "Individual threshold" resource. See clause 6.4.6.3.4.
407
408
409
410
411
412
      requestBody:
        $ref: '#/components/requestBodies/ThresholdModificationRequest'
      responses:
        "200":
          $ref: '#/components/responses/IndividualThreshold.Patch'
        "400":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
413
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
414
        "401":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
415
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
416
        "403":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
417
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
418
        "404":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
419
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
420
        "405":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
421
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
422
        "406":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
423
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
424
        "409":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
425
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
426
        "412":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
427
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
428
        "416":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
429
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
430
        "422":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
431
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
432
        "429":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
433
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
434
        "500":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
435
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
436
        "503":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
437
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
438
        "504":
Francesca Moscatelli's avatar
Francesca Moscatelli committed
439
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
440

441
442
443
444
445
446
447
448
449
450
451
452
453
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 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:
454
        type: string
455
456
457
458
459
460
461
462
463
464

    ReportId:
      name: reportId
      in: path
      description: |
        Identifier of the performance report.
      required: true
      style: simple
      explode: false
      schema:
465
        type: string
466
467
468
469
470
471
472
473
474
475
476
477

    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 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:
478
        type: string
Gergely Csatari's avatar
Gergely Csatari committed
479

480
481
482
483
484
  requestBodies:
    PmJobCreationRequest:
      description: The VNF creation parameters
      content:
        application/json:
485
          schema:
486
487
488
489
490
491
492
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest
      required: true

    PmJobModificationRequest:
      description: Parameters for the PM job modification
      content:
        application/json:
493
          schema:
494
495
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications
      required: true
Gergely Csatari's avatar
Gergely Csatari committed
496

497
498
499
500
501
    ThresholdCreationRequest:
      description: |
        Request parameters to create a new "Individual threshold" resource.
      content:
        application/json:
502
          schema:
503
504
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest
      required: true
moscatelli's avatar
moscatelli committed
505

506
507
508
509
510
511
512
    ThresholdModificationRequest:
      description: Parameters for the threshold modification.
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications
      required: true
moscatelli's avatar
moscatelli committed
513

514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
  responses:
    PmJobs.Get:
      description: |
        200 OK
        Shall be returned when information about zero or more PM jobs was 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 013for this resource, inclusion of the Link HTTP header in this  response shall follow
        the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: The used API version.
          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
        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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob
moscatelli's avatar
moscatelli committed
560

561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
    PmJobs.Post:
      description: |
        201 CREATED
        Shall be returned when the PM job has been created successfully.  The response body shall contain a
        representation of the created  PM job resource. The HTTP response shall include a "Location" HTTP header that
        points to the created "Individual PM job" resource.
      headers:
        Version:
          description: The used API version.
          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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: The resource URI of the created PM Job
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob
moscatelli's avatar
moscatelli committed
599

600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
    IndividualPmJob.Get:
      description: |
        200 OK
        Shall be returned when information about an individual PM job has been  ueried successfully. The response
        body shall contain a representation of the "Individual PM job" resource.
      headers:
        Version:
          description: The used API version.
          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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob
moscatelli's avatar
moscatelli committed
630

631
632
633
634
635
636
637
638
639
640
641
642
643
    IndividualPmJob.Delete:
      description: |
        204 NO CONTENT
        Shall be returned when the PM job has been deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
644
645
            Challenge if the corresponding HTTP request has not provided authorization, or error details
            if the corresponding HTTP request has provided an invalid authorization token.
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualPmJob.Patch:
      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:
        Version:
          description: The used API version.
          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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications

    IndividualPmJobReport.Get:
      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.
      headers:
        Version:
          description: The used API version.
          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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport
Gergely Csatari's avatar
Gergely Csatari committed
719

720
721
722
723
    Thresholds.Get:
      description: |
        200 OK
        Information about zero or more thresholds was queried successfully.
Sana Zulfiqar's avatar
Sana Zulfiqar committed
724
725
726
727
728
729
        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.
730
731
732
733
734
735
736
737
738
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
739
740
            Challenge if the corresponding HTTP request has not provided authorization, or error details if
            the corresponding HTTP request has provided an invalid authorization token.
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
          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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
760
761
          schema:
            type: array
762
            items:
763
              $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold
Gergely Csatari's avatar
Gergely Csatari committed
764

765
766
767
    Thresholds.Post:
      description: |
        201 CREATED
Sana Zulfiqar's avatar
Sana Zulfiqar committed
768
769
770
        Shall be returned when a threshold has been created successfully.  The response body shall contain a
        representation of the created  "Individual threshold" resource. The HTTP response shall include a
        "Location" HTTP header that contains the resource URI of the created resource.
771
772
773
774
775
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
776
          schema:
777
778
779
            type: string
        WWW-Authenticate:
          description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
780
781
            Challenge if the corresponding HTTP request has not provided authorization, or error details if
            the corresponding HTTP request has provided an invalid authorization token.
782
783
          style: simple
          explode: false
784
          schema:
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: The resource URI of the created threshold
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold
Gergely Csatari's avatar
Gergely Csatari committed
803

804
805
806
807
808
809
810
811
812
813
    IndividualThreshold.Get:
      description: |
        200 OK
        Shall be returned when information about an individual threshold  has been queried successfully.
        The response body shall contain a representation of the threshold.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
814
          schema:
815
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
            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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold

    IndividualThreshold.Delete:
      description: |
        204 NO CONTENT
        Shall be returned when the threshold was deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
Sana Zulfiqar's avatar
Sana Zulfiqar committed
848
849
            Challenge if the corresponding HTTP request has not provided authorization, or error details if
            the corresponding HTTP request has provided an invalid authorization token.
850
851
852
853
854
          style: simple
          explode: false
          schema:
            type: string
      content: {}
Gergely Csatari's avatar
Gergely Csatari committed
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
    IndividualThreshold.Patch:
      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:
        Version:
          description: The used API version.
          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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications