@itentialopensource/adapter-etsi_sol002 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CALLS.md +329 -0
  2. package/CHANGELOG.md +8 -0
  3. package/CONTRIBUTING.md +1 -160
  4. package/ENHANCE.md +2 -2
  5. package/README.md +32 -23
  6. package/adapter.js +157 -329
  7. package/adapterBase.js +549 -879
  8. package/changelogs/changelog.md +16 -0
  9. package/metadata.json +49 -0
  10. package/package.json +23 -25
  11. package/pronghorn.json +981 -642
  12. package/propertiesSchema.json +431 -31
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapter-openapi.json +3367 -0
  15. package/report/adapter-openapi.yaml +2548 -0
  16. package/report/adapterInfo.json +8 -8
  17. package/report/updateReport1691507414889.json +120 -0
  18. package/report/updateReport1692202448186.json +120 -0
  19. package/report/updateReport1694460767581.json +120 -0
  20. package/report/updateReport1698420537369.json +120 -0
  21. package/sampleProperties.json +63 -2
  22. package/test/integration/adapterTestBasicGet.js +2 -4
  23. package/test/integration/adapterTestConnectivity.js +91 -42
  24. package/test/integration/adapterTestIntegration.js +130 -2
  25. package/test/unit/adapterBaseTestUnit.js +388 -313
  26. package/test/unit/adapterTestUnit.js +338 -112
  27. package/utils/adapterInfo.js +1 -1
  28. package/utils/addAuth.js +1 -1
  29. package/utils/artifactize.js +1 -1
  30. package/utils/checkMigrate.js +1 -1
  31. package/utils/entitiesToDB.js +2 -2
  32. package/utils/findPath.js +1 -1
  33. package/utils/methodDocumentor.js +273 -0
  34. package/utils/modify.js +13 -15
  35. package/utils/packModificationScript.js +1 -1
  36. package/utils/pre-commit.sh +2 -0
  37. package/utils/taskMover.js +309 -0
  38. package/utils/tbScript.js +89 -34
  39. package/utils/tbUtils.js +41 -21
  40. package/utils/testRunner.js +1 -1
  41. package/utils/troubleshootingAdapter.js +9 -6
  42. package/workflows/README.md +0 -3
@@ -0,0 +1,2548 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: SOL002 - VNF Configuration interface
4
+ description: >
5
+ SOL002 - VNF Configuration Interface IMPORTANT: Please note that this file might be not aligned to the current
6
+
7
+ version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of
8
+
9
+ discrepancies the published ETSI Group Specification takes precedence.
10
+
11
+ Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
12
+ contact:
13
+ name: NFV-SOL WG
14
+ version: '1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1'
15
+ servers:
16
+ - url: http://127.0.0.1/vnfconfig/v1
17
+ variables: {}
18
+ - url: https://127.0.0.1/vnfconfig/v1
19
+ variables: {}
20
+ paths:
21
+ /api_versions:
22
+ get:
23
+ summary: Retrieve API version information
24
+ description: >
25
+ The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported.
26
+ operationId: RetrieveAPIversioninformation
27
+ parameters:
28
+ - name: Version
29
+ in: header
30
+ description: Version of the API requested to use when responding to this request.
31
+ required: true
32
+ style: simple
33
+ schema:
34
+ type: string
35
+ responses:
36
+ '200':
37
+ description: >-
38
+ 200 OK
39
+
40
+ API version information was read successfully. The response body shall contain 4.4 API version information, as defined in clause 4.4.1.13.
41
+ headers:
42
+ Version:
43
+ description: The used API version.
44
+ content:
45
+ text/plain:
46
+ schema:
47
+ type: string
48
+ description: The used API version.
49
+ content:
50
+ application/json:
51
+ schema:
52
+ allOf:
53
+ - $ref: '#/components/schemas/ApiVersionsResponse'
54
+ - description: >
55
+ This type represents API version information.
56
+ '400':
57
+ description: >-
58
+ 400 BAD REQUEST
59
+
60
+ 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned.
61
+
62
+ If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
63
+
64
+ If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
65
+
66
+ If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
67
+
68
+ If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
69
+
70
+ The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
71
+ headers:
72
+ WWW-Authenticate:
73
+ description: >
74
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
75
+ content:
76
+ text/plain:
77
+ schema:
78
+ type: string
79
+ description: >
80
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
81
+ Version:
82
+ description: >
83
+ Version of the API used in the response.
84
+ content:
85
+ text/plain:
86
+ schema:
87
+ type: string
88
+ description: >
89
+ Version of the API used in the response.
90
+ content:
91
+ application/json:
92
+ schema:
93
+ allOf:
94
+ - $ref: '#/components/schemas/ApiVersions400Error1'
95
+ - description: >
96
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
97
+ '401':
98
+ description: >-
99
+ 401 UNAUTHORIZED
100
+
101
+ If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
102
+ headers:
103
+ WWW-Authenticate:
104
+ description: >
105
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
106
+ content:
107
+ text/plain:
108
+ schema:
109
+ type: string
110
+ description: >
111
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
112
+ Version:
113
+ description: >
114
+ Version of the API used in the response.
115
+ content:
116
+ text/plain:
117
+ schema:
118
+ type: string
119
+ description: >
120
+ Version of the API used in the response.
121
+ content:
122
+ application/json:
123
+ schema:
124
+ allOf:
125
+ - $ref: '#/components/schemas/ApiVersions401Error1'
126
+ - description: >
127
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
128
+ '403':
129
+ description: >-
130
+ 403 FORBIDDEN
131
+
132
+ If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
133
+ headers:
134
+ WWW-Authenticate:
135
+ description: >
136
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
137
+ content:
138
+ text/plain:
139
+ schema:
140
+ type: string
141
+ description: >
142
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
143
+ Version:
144
+ description: >
145
+ Version of the API used in the response.
146
+ content:
147
+ text/plain:
148
+ schema:
149
+ type: string
150
+ description: >
151
+ Version of the API used in the response.
152
+ content:
153
+ application/json:
154
+ schema:
155
+ allOf:
156
+ - $ref: '#/components/schemas/ApiVersions403Error1'
157
+ - description: >
158
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
159
+ '404':
160
+ description: >-
161
+ 404 NOT FOUND
162
+
163
+ If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.
164
+
165
+ This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.
166
+ headers:
167
+ WWW-Authenticate:
168
+ description: >
169
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
170
+ content:
171
+ text/plain:
172
+ schema:
173
+ type: string
174
+ description: >
175
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
176
+ Version:
177
+ description: >
178
+ Version of the API used in the response.
179
+ content:
180
+ text/plain:
181
+ schema:
182
+ type: string
183
+ description: >
184
+ Version of the API used in the response.
185
+ content:
186
+ application/json:
187
+ schema:
188
+ allOf:
189
+ - $ref: '#/components/schemas/ApiVersions404Error1'
190
+ - description: >
191
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
192
+ '405':
193
+ description: >-
194
+ 405 METHOD NOT ALLOWED
195
+
196
+ If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
197
+ headers:
198
+ WWW-Authenticate:
199
+ description: >
200
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
201
+ content:
202
+ text/plain:
203
+ schema:
204
+ type: string
205
+ description: >
206
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
207
+ Version:
208
+ description: >
209
+ Version of the API used in the response.
210
+ content:
211
+ text/plain:
212
+ schema:
213
+ type: string
214
+ description: >
215
+ Version of the API used in the response.
216
+ content:
217
+ application/json:
218
+ schema:
219
+ allOf:
220
+ - $ref: '#/components/schemas/ApiVersions405Error1'
221
+ - description: >
222
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
223
+ '406':
224
+ description: >-
225
+ 406 NOT ACCEPTABLE
226
+
227
+ If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
228
+ headers:
229
+ WWW-Authenticate:
230
+ description: >
231
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
232
+ content:
233
+ text/plain:
234
+ schema:
235
+ type: string
236
+ description: >
237
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
238
+ Version:
239
+ description: >
240
+ Version of the API used in the response.
241
+ content:
242
+ text/plain:
243
+ schema:
244
+ type: string
245
+ description: >
246
+ Version of the API used in the response.
247
+ content:
248
+ application/json:
249
+ schema:
250
+ allOf:
251
+ - $ref: '#/components/schemas/ApiVersions406Error1'
252
+ - description: >
253
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
254
+ '413':
255
+ description: >-
256
+ 413 PAYLOAD TOO LARGE
257
+
258
+ If the payload body of a request is larger than the amount of data the API producer is willing or able to process, it shall respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted.
259
+ headers:
260
+ WWW-Authenticate:
261
+ description: >
262
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
263
+ content:
264
+ text/plain:
265
+ schema:
266
+ type: string
267
+ description: >
268
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
269
+ Version:
270
+ description: >
271
+ Version of the API used in the response.
272
+ content:
273
+ text/plain:
274
+ schema:
275
+ type: string
276
+ description: >
277
+ Version of the API used in the response.
278
+ content:
279
+ application/json:
280
+ schema:
281
+ allOf:
282
+ - $ref: '#/components/schemas/ApiVersions413Error1'
283
+ - description: >
284
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
285
+ '414':
286
+ description: >-
287
+ 414 URI TOO LONG
288
+
289
+ If the request URI of a request is longer than the API producer is willing or able to process, it shall respond with this response code. This condition can e.g. be caused by passing long queries in the request URI of a GET request. The "ProblemDetails" structure may be omitted.
290
+ headers:
291
+ WWW-Authenticate:
292
+ description: >
293
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
294
+ content:
295
+ text/plain:
296
+ schema:
297
+ type: string
298
+ description: >
299
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
300
+ Version:
301
+ description: >
302
+ Version of the API used in the response.
303
+ content:
304
+ text/plain:
305
+ schema:
306
+ type: string
307
+ description: >
308
+ Version of the API used in the response.
309
+ content:
310
+ application/json:
311
+ schema:
312
+ allOf:
313
+ - $ref: '#/components/schemas/ApiVersions414Error1'
314
+ - description: >
315
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
316
+ '416':
317
+ description: 416 Range Not Satisfiable
318
+ headers:
319
+ WWW-Authenticate:
320
+ description: >
321
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
322
+ content:
323
+ text/plain:
324
+ schema:
325
+ type: string
326
+ description: >
327
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
328
+ Version:
329
+ description: >
330
+ Version of the API used in the response.
331
+ content:
332
+ text/plain:
333
+ schema:
334
+ type: string
335
+ description: >
336
+ Version of the API used in the response.
337
+ content:
338
+ application/json:
339
+ schema:
340
+ allOf:
341
+ - $ref: '#/components/schemas/ApiVersions416Error1'
342
+ - description: >
343
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
344
+ '422':
345
+ description: >-
346
+ 422 UNPROCESSABLE ENTITY
347
+
348
+ If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
349
+
350
+ This error response code is only applicable for methods that have a request body.
351
+ headers:
352
+ WWW-Authenticate:
353
+ description: >
354
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
355
+ content:
356
+ text/plain:
357
+ schema:
358
+ type: string
359
+ description: >
360
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
361
+ Version:
362
+ description: >
363
+ Version of the API used in the response.
364
+ content:
365
+ text/plain:
366
+ schema:
367
+ type: string
368
+ description: >
369
+ Version of the API used in the response.
370
+ content:
371
+ application/json:
372
+ schema:
373
+ allOf:
374
+ - $ref: '#/components/schemas/ApiVersions422Error1'
375
+ - description: >
376
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
377
+ '429':
378
+ description: >-
379
+ 429 TOO MANY REQUESTS
380
+
381
+ If the API consumer has sent too many requests in a defined period of time and the API producer is able to detect that condition ("rate limiting"), the API producer shall respond with this response code, following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information about the source of the problem.
382
+
383
+ The period of time and allowed number of requests are configured within the API producer by means outside the scope of the present document.
384
+ headers:
385
+ WWW-Authenticate:
386
+ description: >
387
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
388
+ content:
389
+ text/plain:
390
+ schema:
391
+ type: string
392
+ description: >
393
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
394
+ Version:
395
+ description: >
396
+ Version of the API used in the response.
397
+ content:
398
+ text/plain:
399
+ schema:
400
+ type: string
401
+ description: >
402
+ Version of the API used in the response.
403
+ content:
404
+ application/json:
405
+ schema:
406
+ allOf:
407
+ - $ref: '#/components/schemas/ApiVersions429Error1'
408
+ - description: >
409
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
410
+ '500':
411
+ description: >-
412
+ 500 INTERNAL SERVER ERROR
413
+
414
+ If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
415
+ headers:
416
+ WWW-Authenticate:
417
+ description: >
418
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
419
+ content:
420
+ text/plain:
421
+ schema:
422
+ type: string
423
+ description: >
424
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
425
+ Version:
426
+ description: >
427
+ Version of the API used in the response.
428
+ content:
429
+ text/plain:
430
+ schema:
431
+ type: string
432
+ description: >
433
+ Version of the API used in the response.
434
+ content:
435
+ application/json:
436
+ schema:
437
+ allOf:
438
+ - $ref: '#/components/schemas/ApiVersions500Error1'
439
+ - description: >
440
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
441
+ '503':
442
+ description: >-
443
+ 503 SERVICE UNAVAILABLE
444
+
445
+ If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
446
+ headers:
447
+ WWW-Authenticate:
448
+ description: >
449
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
450
+ content:
451
+ text/plain:
452
+ schema:
453
+ type: string
454
+ description: >
455
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
456
+ Version:
457
+ description: >
458
+ Version of the API used in the response.
459
+ content:
460
+ text/plain:
461
+ schema:
462
+ type: string
463
+ description: >
464
+ Version of the API used in the response.
465
+ content:
466
+ application/json:
467
+ schema:
468
+ allOf:
469
+ - $ref: '#/components/schemas/ApiVersions503Error1'
470
+ - description: >
471
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
472
+ '504':
473
+ description: >-
474
+ 504 GATEWAY TIMEOUT
475
+
476
+ If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code.
477
+ headers:
478
+ WWW-Authenticate:
479
+ description: >
480
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
481
+ content:
482
+ text/plain:
483
+ schema:
484
+ type: string
485
+ description: >
486
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
487
+ Version:
488
+ description: >
489
+ Version of the API used in the response.
490
+ content:
491
+ text/plain:
492
+ schema:
493
+ type: string
494
+ description: >
495
+ Version of the API used in the response.
496
+ content:
497
+ application/json:
498
+ schema:
499
+ allOf:
500
+ - $ref: '#/components/schemas/ApiVersions504Error1'
501
+ - description: >
502
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
503
+ deprecated: false
504
+ /configuration:
505
+ get:
506
+ summary: Read VNF/VNFC configuration from VNF
507
+ description: >
508
+ The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
509
+ operationId: ReadVNF/VNFCconfigurationfromVNF
510
+ parameters:
511
+ - name: Version
512
+ in: header
513
+ description: Version of the API requested to use when responding to this request.
514
+ required: true
515
+ style: simple
516
+ schema:
517
+ type: string
518
+ - name: Authorization
519
+ in: header
520
+ description: 'The authorization token for the request. Reference: IETF RFC 7235.'
521
+ style: simple
522
+ schema:
523
+ type: string
524
+ responses:
525
+ '200':
526
+ description: >-
527
+ 200 OK
528
+
529
+ Shall be returned when configuration information about a VNF instance has been read successfully. The response
530
+
531
+ body shall contain a representation of the configuration resource.
532
+ headers:
533
+ Version:
534
+ description: The used API version.
535
+ content:
536
+ text/plain:
537
+ schema:
538
+ type: string
539
+ description: The used API version.
540
+ WWW-Authenticate:
541
+ description: >
542
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the
543
+
544
+ corresponding HTTP request has provided an invalid authorization token.
545
+ content:
546
+ text/plain:
547
+ schema:
548
+ type: string
549
+ description: >
550
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the
551
+
552
+ corresponding HTTP request has provided an invalid authorization token.
553
+ content:
554
+ application/json:
555
+ schema:
556
+ allOf:
557
+ - $ref: '#/components/schemas/Configuration.Get'
558
+ - description: >
559
+ This type represents configuration parameters of a VNF instance and its VNFC instances.
560
+ '400':
561
+ description: >-
562
+ 400 BAD REQUEST
563
+
564
+ 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned.
565
+
566
+ If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
567
+
568
+ If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
569
+
570
+ If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
571
+
572
+ If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
573
+
574
+ The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
575
+ headers:
576
+ WWW-Authenticate:
577
+ description: >
578
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
579
+ content:
580
+ text/plain:
581
+ schema:
582
+ type: string
583
+ description: >
584
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
585
+ Version:
586
+ description: >
587
+ Version of the API used in the response.
588
+ content:
589
+ text/plain:
590
+ schema:
591
+ type: string
592
+ description: >
593
+ Version of the API used in the response.
594
+ content:
595
+ application/json:
596
+ schema:
597
+ allOf:
598
+ - $ref: '#/components/schemas/Configuration400Error1'
599
+ - description: >
600
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
601
+ '401':
602
+ description: >-
603
+ 401 UNAUTHORIZED
604
+
605
+ If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
606
+ headers:
607
+ WWW-Authenticate:
608
+ description: >
609
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
610
+ content:
611
+ text/plain:
612
+ schema:
613
+ type: string
614
+ description: >
615
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
616
+ Version:
617
+ description: >
618
+ Version of the API used in the response.
619
+ content:
620
+ text/plain:
621
+ schema:
622
+ type: string
623
+ description: >
624
+ Version of the API used in the response.
625
+ content:
626
+ application/json:
627
+ schema:
628
+ allOf:
629
+ - $ref: '#/components/schemas/Configuration401Error1'
630
+ - description: >
631
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
632
+ '403':
633
+ description: >-
634
+ 403 FORBIDDEN
635
+
636
+ If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
637
+ headers:
638
+ WWW-Authenticate:
639
+ description: >
640
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
641
+ content:
642
+ text/plain:
643
+ schema:
644
+ type: string
645
+ description: >
646
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
647
+ Version:
648
+ description: >
649
+ Version of the API used in the response.
650
+ content:
651
+ text/plain:
652
+ schema:
653
+ type: string
654
+ description: >
655
+ Version of the API used in the response.
656
+ content:
657
+ application/json:
658
+ schema:
659
+ allOf:
660
+ - $ref: '#/components/schemas/Configuration403Error1'
661
+ - description: >
662
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
663
+ '404':
664
+ description: >-
665
+ 404 NOT FOUND
666
+
667
+ If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.
668
+
669
+ This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.
670
+ headers:
671
+ WWW-Authenticate:
672
+ description: >
673
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
674
+ content:
675
+ text/plain:
676
+ schema:
677
+ type: string
678
+ description: >
679
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
680
+ Version:
681
+ description: >
682
+ Version of the API used in the response.
683
+ content:
684
+ text/plain:
685
+ schema:
686
+ type: string
687
+ description: >
688
+ Version of the API used in the response.
689
+ content:
690
+ application/json:
691
+ schema:
692
+ allOf:
693
+ - $ref: '#/components/schemas/Configuration404Error1'
694
+ - description: >
695
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
696
+ '405':
697
+ description: >-
698
+ 405 METHOD NOT ALLOWED
699
+
700
+ If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
701
+ headers:
702
+ WWW-Authenticate:
703
+ description: >
704
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
705
+ content:
706
+ text/plain:
707
+ schema:
708
+ type: string
709
+ description: >
710
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
711
+ Version:
712
+ description: >
713
+ Version of the API used in the response.
714
+ content:
715
+ text/plain:
716
+ schema:
717
+ type: string
718
+ description: >
719
+ Version of the API used in the response.
720
+ content:
721
+ application/json:
722
+ schema:
723
+ allOf:
724
+ - $ref: '#/components/schemas/Configuration405Error1'
725
+ - description: >
726
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
727
+ '406':
728
+ description: >-
729
+ 406 NOT ACCEPTABLE
730
+
731
+ If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
732
+ headers:
733
+ WWW-Authenticate:
734
+ description: >
735
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
736
+ content:
737
+ text/plain:
738
+ schema:
739
+ type: string
740
+ description: >
741
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
742
+ Version:
743
+ description: >
744
+ Version of the API used in the response.
745
+ content:
746
+ text/plain:
747
+ schema:
748
+ type: string
749
+ description: >
750
+ Version of the API used in the response.
751
+ content:
752
+ application/json:
753
+ schema:
754
+ allOf:
755
+ - $ref: '#/components/schemas/Configuration406Error1'
756
+ - description: >
757
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
758
+ '422':
759
+ description: >-
760
+ 422 UNPROCESSABLE ENTITY
761
+
762
+ If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
763
+
764
+ This error response code is only applicable for methods that have a request body.
765
+ headers:
766
+ WWW-Authenticate:
767
+ description: >
768
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
769
+ content:
770
+ text/plain:
771
+ schema:
772
+ type: string
773
+ description: >
774
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
775
+ Version:
776
+ description: >
777
+ Version of the API used in the response.
778
+ content:
779
+ text/plain:
780
+ schema:
781
+ type: string
782
+ description: >
783
+ Version of the API used in the response.
784
+ content:
785
+ application/json:
786
+ schema:
787
+ allOf:
788
+ - $ref: '#/components/schemas/Configuration422Error1'
789
+ - description: >
790
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
791
+ '429':
792
+ description: >-
793
+ 429 TOO MANY REQUESTS
794
+
795
+ If the API consumer has sent too many requests in a defined period of time and the API producer is able to detect that condition ("rate limiting"), the API producer shall respond with this response code, following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information about the source of the problem.
796
+
797
+ The period of time and allowed number of requests are configured within the API producer by means outside the scope of the present document.
798
+ headers:
799
+ WWW-Authenticate:
800
+ description: >
801
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
802
+ content:
803
+ text/plain:
804
+ schema:
805
+ type: string
806
+ description: >
807
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
808
+ Version:
809
+ description: >
810
+ Version of the API used in the response.
811
+ content:
812
+ text/plain:
813
+ schema:
814
+ type: string
815
+ description: >
816
+ Version of the API used in the response.
817
+ content:
818
+ application/json:
819
+ schema:
820
+ allOf:
821
+ - $ref: '#/components/schemas/Configuration429Error1'
822
+ - description: >
823
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
824
+ '500':
825
+ description: >-
826
+ 500 INTERNAL SERVER ERROR
827
+
828
+ If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
829
+ headers:
830
+ WWW-Authenticate:
831
+ description: >
832
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
833
+ content:
834
+ text/plain:
835
+ schema:
836
+ type: string
837
+ description: >
838
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
839
+ Version:
840
+ description: >
841
+ Version of the API used in the response.
842
+ content:
843
+ text/plain:
844
+ schema:
845
+ type: string
846
+ description: >
847
+ Version of the API used in the response.
848
+ content:
849
+ application/json:
850
+ schema:
851
+ allOf:
852
+ - $ref: '#/components/schemas/Configuration500Error1'
853
+ - description: >
854
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
855
+ '503':
856
+ description: >-
857
+ 503 SERVICE UNAVAILABLE
858
+
859
+ If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
860
+ headers:
861
+ WWW-Authenticate:
862
+ description: >
863
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
864
+ content:
865
+ text/plain:
866
+ schema:
867
+ type: string
868
+ description: >
869
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
870
+ Version:
871
+ description: >
872
+ Version of the API used in the response.
873
+ content:
874
+ text/plain:
875
+ schema:
876
+ type: string
877
+ description: >
878
+ Version of the API used in the response.
879
+ content:
880
+ application/json:
881
+ schema:
882
+ allOf:
883
+ - $ref: '#/components/schemas/Configuration503Error1'
884
+ - description: >
885
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
886
+ '504':
887
+ description: >-
888
+ 504 GATEWAY TIMEOUT
889
+
890
+ If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code.
891
+ headers:
892
+ WWW-Authenticate:
893
+ description: >
894
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
895
+ content:
896
+ text/plain:
897
+ schema:
898
+ type: string
899
+ description: >
900
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
901
+ Version:
902
+ description: >
903
+ Version of the API used in the response.
904
+ content:
905
+ text/plain:
906
+ schema:
907
+ type: string
908
+ description: >
909
+ Version of the API used in the response.
910
+ content:
911
+ application/json:
912
+ schema:
913
+ allOf:
914
+ - $ref: '#/components/schemas/Configuration504Error1'
915
+ - description: >
916
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
917
+ deprecated: false
918
+ patch:
919
+ summary: Modify VNF/VNFC configuration.
920
+ description: This method sets or modifies a configuration resource.
921
+ operationId: ModifyVNF/VNFCconfiguration.
922
+ parameters:
923
+ - name: Version
924
+ in: header
925
+ description: Version of the API requested to use when responding to this request.
926
+ required: true
927
+ style: simple
928
+ schema:
929
+ type: string
930
+ - name: Authorization
931
+ in: header
932
+ description: 'The authorization token for the request. Reference: IETF RFC 7235.'
933
+ style: simple
934
+ schema:
935
+ type: string
936
+ requestBody:
937
+ description: The parameter for the configuration modification, as defined in clause 9.5.2.2.
938
+ content:
939
+ application/json:
940
+ schema:
941
+ anyOf:
942
+ - $ref: '#/components/schemas/ConfigurationRequest'
943
+ - $ref: '#/components/schemas/ConfigurationRequest1'
944
+ description: The parameter for the configuration modification, as defined in clause 9.5.2.2.
945
+ required: true
946
+ responses:
947
+ '200':
948
+ description: >-
949
+ 200 OK
950
+
951
+ Shall be returned when the request has been accepted and completed. The response body shall contain the
952
+
953
+ parameters of the configuration modification that was applied to the configuration resource.
954
+ headers:
955
+ Version:
956
+ description: The used API version.
957
+ content:
958
+ text/plain:
959
+ schema:
960
+ type: string
961
+ description: The used API version.
962
+ content:
963
+ application/json:
964
+ schema:
965
+ anyOf:
966
+ - $ref: '#/components/schemas/Configuration.Patch'
967
+ - $ref: '#/components/schemas/Configuration.Patch1'
968
+ description: >
969
+ This type represents request parameters for the "Set Configuration" operation.
970
+ * NOTE 1: At least one of "vnfConfigurationData" and "vnfcConfigurationData"
971
+ shall be present.
972
+ * NOTE 2: The VnfcConfiguration data type can only be used to modify the configuration
973
+ of existing VNFC instances.
974
+ '400':
975
+ description: >-
976
+ 400 BAD REQUEST
977
+
978
+ 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned.
979
+
980
+ If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
981
+
982
+ If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
983
+
984
+ If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
985
+
986
+ If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
987
+
988
+ The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
989
+ headers:
990
+ WWW-Authenticate:
991
+ description: >
992
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
993
+ content:
994
+ text/plain:
995
+ schema:
996
+ type: string
997
+ description: >
998
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
999
+ Version:
1000
+ description: >
1001
+ Version of the API used in the response.
1002
+ content:
1003
+ text/plain:
1004
+ schema:
1005
+ type: string
1006
+ description: >
1007
+ Version of the API used in the response.
1008
+ content:
1009
+ application/json:
1010
+ schema:
1011
+ allOf:
1012
+ - $ref: '#/components/schemas/Configuration400Error1'
1013
+ - description: >
1014
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1015
+ '401':
1016
+ description: >-
1017
+ 401 UNAUTHORIZED
1018
+
1019
+ If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
1020
+ headers:
1021
+ WWW-Authenticate:
1022
+ description: >
1023
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1024
+ content:
1025
+ text/plain:
1026
+ schema:
1027
+ type: string
1028
+ description: >
1029
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1030
+ Version:
1031
+ description: >
1032
+ Version of the API used in the response.
1033
+ content:
1034
+ text/plain:
1035
+ schema:
1036
+ type: string
1037
+ description: >
1038
+ Version of the API used in the response.
1039
+ content:
1040
+ application/json:
1041
+ schema:
1042
+ allOf:
1043
+ - $ref: '#/components/schemas/Configuration401Error1'
1044
+ - description: >
1045
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1046
+ '403':
1047
+ description: >-
1048
+ 403 FORBIDDEN
1049
+
1050
+ If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
1051
+ headers:
1052
+ WWW-Authenticate:
1053
+ description: >
1054
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1055
+ content:
1056
+ text/plain:
1057
+ schema:
1058
+ type: string
1059
+ description: >
1060
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1061
+ Version:
1062
+ description: >
1063
+ Version of the API used in the response.
1064
+ content:
1065
+ text/plain:
1066
+ schema:
1067
+ type: string
1068
+ description: >
1069
+ Version of the API used in the response.
1070
+ content:
1071
+ application/json:
1072
+ schema:
1073
+ allOf:
1074
+ - $ref: '#/components/schemas/Configuration403Error1'
1075
+ - description: >
1076
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1077
+ '404':
1078
+ description: >-
1079
+ 404 NOT FOUND
1080
+
1081
+ If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.
1082
+
1083
+ This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.
1084
+ headers:
1085
+ WWW-Authenticate:
1086
+ description: >
1087
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1088
+ content:
1089
+ text/plain:
1090
+ schema:
1091
+ type: string
1092
+ description: >
1093
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1094
+ Version:
1095
+ description: >
1096
+ Version of the API used in the response.
1097
+ content:
1098
+ text/plain:
1099
+ schema:
1100
+ type: string
1101
+ description: >
1102
+ Version of the API used in the response.
1103
+ content:
1104
+ application/json:
1105
+ schema:
1106
+ allOf:
1107
+ - $ref: '#/components/schemas/Configuration404Error1'
1108
+ - description: >
1109
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1110
+ '405':
1111
+ description: >-
1112
+ 405 METHOD NOT ALLOWED
1113
+
1114
+ If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
1115
+ headers:
1116
+ WWW-Authenticate:
1117
+ description: >
1118
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1119
+ content:
1120
+ text/plain:
1121
+ schema:
1122
+ type: string
1123
+ description: >
1124
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1125
+ Version:
1126
+ description: >
1127
+ Version of the API used in the response.
1128
+ content:
1129
+ text/plain:
1130
+ schema:
1131
+ type: string
1132
+ description: >
1133
+ Version of the API used in the response.
1134
+ content:
1135
+ application/json:
1136
+ schema:
1137
+ allOf:
1138
+ - $ref: '#/components/schemas/Configuration405Error1'
1139
+ - description: >
1140
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1141
+ '406':
1142
+ description: >-
1143
+ 406 NOT ACCEPTABLE
1144
+
1145
+ If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
1146
+ headers:
1147
+ WWW-Authenticate:
1148
+ description: >
1149
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1150
+ content:
1151
+ text/plain:
1152
+ schema:
1153
+ type: string
1154
+ description: >
1155
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1156
+ Version:
1157
+ description: >
1158
+ Version of the API used in the response.
1159
+ content:
1160
+ text/plain:
1161
+ schema:
1162
+ type: string
1163
+ description: >
1164
+ Version of the API used in the response.
1165
+ content:
1166
+ application/json:
1167
+ schema:
1168
+ allOf:
1169
+ - $ref: '#/components/schemas/Configuration406Error1'
1170
+ - description: >
1171
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1172
+ '412':
1173
+ description: >-
1174
+ 412 PRECONDITION FAILED
1175
+
1176
+ 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.
1177
+ headers:
1178
+ WWW-Authenticate:
1179
+ description: >
1180
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1181
+ content:
1182
+ text/plain:
1183
+ schema:
1184
+ type: string
1185
+ description: >
1186
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1187
+ Version:
1188
+ description: >
1189
+ Version of the API used in the response.
1190
+ content:
1191
+ text/plain:
1192
+ schema:
1193
+ type: string
1194
+ description: >
1195
+ Version of the API used in the response.
1196
+ content:
1197
+ application/json:
1198
+ schema:
1199
+ allOf:
1200
+ - $ref: '#/components/schemas/Configuration412Error1'
1201
+ - description: >
1202
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1203
+ '416':
1204
+ description: 416 Range Not Satisfiable
1205
+ headers:
1206
+ WWW-Authenticate:
1207
+ description: >
1208
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1209
+ content:
1210
+ text/plain:
1211
+ schema:
1212
+ type: string
1213
+ description: >
1214
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1215
+ Version:
1216
+ description: >
1217
+ Version of the API used in the response.
1218
+ content:
1219
+ text/plain:
1220
+ schema:
1221
+ type: string
1222
+ description: >
1223
+ Version of the API used in the response.
1224
+ content:
1225
+ application/json:
1226
+ schema:
1227
+ allOf:
1228
+ - $ref: '#/components/schemas/Configuration416Error1'
1229
+ - description: >
1230
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1231
+ '422':
1232
+ description: >-
1233
+ 422 UNPROCESSABLE ENTITY
1234
+
1235
+ If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
1236
+
1237
+ This error response code is only applicable for methods that have a request body.
1238
+ headers:
1239
+ WWW-Authenticate:
1240
+ description: >
1241
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1242
+ content:
1243
+ text/plain:
1244
+ schema:
1245
+ type: string
1246
+ description: >
1247
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1248
+ Version:
1249
+ description: >
1250
+ Version of the API used in the response.
1251
+ content:
1252
+ text/plain:
1253
+ schema:
1254
+ type: string
1255
+ description: >
1256
+ Version of the API used in the response.
1257
+ content:
1258
+ application/json:
1259
+ schema:
1260
+ allOf:
1261
+ - $ref: '#/components/schemas/Configuration422Error1'
1262
+ - description: >
1263
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1264
+ '429':
1265
+ description: >-
1266
+ 429 TOO MANY REQUESTS
1267
+
1268
+ If the API consumer has sent too many requests in a defined period of time and the API producer is able to detect that condition ("rate limiting"), the API producer shall respond with this response code, following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information about the source of the problem.
1269
+
1270
+ The period of time and allowed number of requests are configured within the API producer by means outside the scope of the present document.
1271
+ headers:
1272
+ WWW-Authenticate:
1273
+ description: >
1274
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1275
+ content:
1276
+ text/plain:
1277
+ schema:
1278
+ type: string
1279
+ description: >
1280
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1281
+ Version:
1282
+ description: >
1283
+ Version of the API used in the response.
1284
+ content:
1285
+ text/plain:
1286
+ schema:
1287
+ type: string
1288
+ description: >
1289
+ Version of the API used in the response.
1290
+ content:
1291
+ application/json:
1292
+ schema:
1293
+ allOf:
1294
+ - $ref: '#/components/schemas/Configuration429Error1'
1295
+ - description: >
1296
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1297
+ '500':
1298
+ description: >-
1299
+ 500 INTERNAL SERVER ERROR
1300
+
1301
+ If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
1302
+ headers:
1303
+ WWW-Authenticate:
1304
+ description: >
1305
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1306
+ content:
1307
+ text/plain:
1308
+ schema:
1309
+ type: string
1310
+ description: >
1311
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1312
+ Version:
1313
+ description: >
1314
+ Version of the API used in the response.
1315
+ content:
1316
+ text/plain:
1317
+ schema:
1318
+ type: string
1319
+ description: >
1320
+ Version of the API used in the response.
1321
+ content:
1322
+ application/json:
1323
+ schema:
1324
+ allOf:
1325
+ - $ref: '#/components/schemas/Configuration500Error1'
1326
+ - description: >
1327
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1328
+ '503':
1329
+ description: >-
1330
+ 503 SERVICE UNAVAILABLE
1331
+
1332
+ If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
1333
+ headers:
1334
+ WWW-Authenticate:
1335
+ description: >
1336
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1337
+ content:
1338
+ text/plain:
1339
+ schema:
1340
+ type: string
1341
+ description: >
1342
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1343
+ Version:
1344
+ description: >
1345
+ Version of the API used in the response.
1346
+ content:
1347
+ text/plain:
1348
+ schema:
1349
+ type: string
1350
+ description: >
1351
+ Version of the API used in the response.
1352
+ content:
1353
+ application/json:
1354
+ schema:
1355
+ allOf:
1356
+ - $ref: '#/components/schemas/Configuration503Error1'
1357
+ - description: >
1358
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1359
+ '504':
1360
+ description: >-
1361
+ 504 GATEWAY TIMEOUT
1362
+
1363
+ If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code.
1364
+ headers:
1365
+ WWW-Authenticate:
1366
+ description: >
1367
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1368
+ content:
1369
+ text/plain:
1370
+ schema:
1371
+ type: string
1372
+ description: >
1373
+ Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
1374
+ Version:
1375
+ description: >
1376
+ Version of the API used in the response.
1377
+ content:
1378
+ text/plain:
1379
+ schema:
1380
+ type: string
1381
+ description: >
1382
+ Version of the API used in the response.
1383
+ content:
1384
+ application/json:
1385
+ schema:
1386
+ allOf:
1387
+ - $ref: '#/components/schemas/Configuration504Error1'
1388
+ - description: >
1389
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1390
+ deprecated: false
1391
+ components:
1392
+ schemas:
1393
+ ApiVersionsResponse:
1394
+ title: ApiVersionsResponse
1395
+ required:
1396
+ - uriPrefix
1397
+ - apiVersions
1398
+ type: object
1399
+ properties:
1400
+ uriPrefix:
1401
+ type: string
1402
+ description: Specifies the URI prefix for the API, in the following form {apiRoot}/{apiName}/{apiMajorVersion}/.
1403
+ apiVersions:
1404
+ type: array
1405
+ items:
1406
+ $ref: '#/components/schemas/ApiVersion'
1407
+ description: Version(s) supported for the API signaled by the uriPrefix attribute.
1408
+ description: This type represents API version information.
1409
+ ApiVersion:
1410
+ title: ApiVersion
1411
+ required:
1412
+ - version
1413
+ type: object
1414
+ properties:
1415
+ version:
1416
+ type: string
1417
+ description: Identifies a supported version. The value of the version attribute shall be a version identifier as specified in clause 9.1 (SOL013).
1418
+ isDeprecated:
1419
+ type: boolean
1420
+ description: >-
1421
+ If such information is available, this attribute indicates whether use of the version signaled by the version attribute is deprecated (true) or not (false).
1422
+
1423
+ A deprecated version is still supported by the API producer but is recommended not to be used any longer. When a version is no longer supported, it does not appear in the response body.
1424
+ retirementDate:
1425
+ type: string
1426
+ description: 'Date-time stamp. Representation: String formatted according to IETF RFC 3339.'
1427
+ format: date-time
1428
+ ApiVersions400Error1:
1429
+ title: ApiVersions400Error1
1430
+ required:
1431
+ - status
1432
+ - detail
1433
+ type: object
1434
+ properties:
1435
+ type:
1436
+ type: string
1437
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1438
+ title:
1439
+ type: string
1440
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1441
+ status:
1442
+ type: integer
1443
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1444
+ format: int32
1445
+ detail:
1446
+ type: string
1447
+ description: A human-readable explanation specific to this occurrence of the problem.
1448
+ instance:
1449
+ type: string
1450
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1451
+ description: >
1452
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1453
+ ApiVersions401Error1:
1454
+ title: ApiVersions401Error1
1455
+ required:
1456
+ - status
1457
+ - detail
1458
+ type: object
1459
+ properties:
1460
+ type:
1461
+ type: string
1462
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1463
+ title:
1464
+ type: string
1465
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1466
+ status:
1467
+ type: integer
1468
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1469
+ format: int32
1470
+ detail:
1471
+ type: string
1472
+ description: A human-readable explanation specific to this occurrence of the problem.
1473
+ instance:
1474
+ type: string
1475
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1476
+ description: >
1477
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1478
+ ApiVersions403Error1:
1479
+ title: ApiVersions403Error1
1480
+ required:
1481
+ - status
1482
+ - detail
1483
+ type: object
1484
+ properties:
1485
+ type:
1486
+ type: string
1487
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1488
+ title:
1489
+ type: string
1490
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1491
+ status:
1492
+ type: integer
1493
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1494
+ format: int32
1495
+ detail:
1496
+ type: string
1497
+ description: A human-readable explanation specific to this occurrence of the problem.
1498
+ instance:
1499
+ type: string
1500
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1501
+ description: >
1502
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1503
+ ApiVersions404Error1:
1504
+ title: ApiVersions404Error1
1505
+ required:
1506
+ - status
1507
+ - detail
1508
+ type: object
1509
+ properties:
1510
+ type:
1511
+ type: string
1512
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1513
+ title:
1514
+ type: string
1515
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1516
+ status:
1517
+ type: integer
1518
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1519
+ format: int32
1520
+ detail:
1521
+ type: string
1522
+ description: A human-readable explanation specific to this occurrence of the problem.
1523
+ instance:
1524
+ type: string
1525
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1526
+ description: >
1527
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1528
+ ApiVersions405Error1:
1529
+ title: ApiVersions405Error1
1530
+ required:
1531
+ - status
1532
+ - detail
1533
+ type: object
1534
+ properties:
1535
+ type:
1536
+ type: string
1537
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1538
+ title:
1539
+ type: string
1540
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1541
+ status:
1542
+ type: integer
1543
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1544
+ format: int32
1545
+ detail:
1546
+ type: string
1547
+ description: A human-readable explanation specific to this occurrence of the problem.
1548
+ instance:
1549
+ type: string
1550
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1551
+ description: >
1552
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1553
+ ApiVersions406Error1:
1554
+ title: ApiVersions406Error1
1555
+ required:
1556
+ - status
1557
+ - detail
1558
+ type: object
1559
+ properties:
1560
+ type:
1561
+ type: string
1562
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1563
+ title:
1564
+ type: string
1565
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1566
+ status:
1567
+ type: integer
1568
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1569
+ format: int32
1570
+ detail:
1571
+ type: string
1572
+ description: A human-readable explanation specific to this occurrence of the problem.
1573
+ instance:
1574
+ type: string
1575
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1576
+ description: >
1577
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1578
+ ApiVersions413Error1:
1579
+ title: ApiVersions413Error1
1580
+ required:
1581
+ - status
1582
+ - detail
1583
+ type: object
1584
+ properties:
1585
+ type:
1586
+ type: string
1587
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1588
+ title:
1589
+ type: string
1590
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1591
+ status:
1592
+ type: integer
1593
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1594
+ format: int32
1595
+ detail:
1596
+ type: string
1597
+ description: A human-readable explanation specific to this occurrence of the problem.
1598
+ instance:
1599
+ type: string
1600
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1601
+ description: >
1602
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1603
+ ApiVersions414Error1:
1604
+ title: ApiVersions414Error1
1605
+ required:
1606
+ - status
1607
+ - detail
1608
+ type: object
1609
+ properties:
1610
+ type:
1611
+ type: string
1612
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1613
+ title:
1614
+ type: string
1615
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1616
+ status:
1617
+ type: integer
1618
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1619
+ format: int32
1620
+ detail:
1621
+ type: string
1622
+ description: A human-readable explanation specific to this occurrence of the problem.
1623
+ instance:
1624
+ type: string
1625
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1626
+ description: >
1627
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1628
+ ApiVersions416Error1:
1629
+ title: ApiVersions416Error1
1630
+ required:
1631
+ - status
1632
+ - detail
1633
+ type: object
1634
+ properties:
1635
+ type:
1636
+ type: string
1637
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1638
+ title:
1639
+ type: string
1640
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1641
+ status:
1642
+ type: integer
1643
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1644
+ format: int32
1645
+ detail:
1646
+ type: string
1647
+ description: A human-readable explanation specific to this occurrence of the problem.
1648
+ instance:
1649
+ type: string
1650
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1651
+ description: >
1652
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1653
+ ApiVersions422Error1:
1654
+ title: ApiVersions422Error1
1655
+ required:
1656
+ - status
1657
+ - detail
1658
+ type: object
1659
+ properties:
1660
+ type:
1661
+ type: string
1662
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1663
+ title:
1664
+ type: string
1665
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1666
+ status:
1667
+ type: integer
1668
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1669
+ format: int32
1670
+ detail:
1671
+ type: string
1672
+ description: A human-readable explanation specific to this occurrence of the problem.
1673
+ instance:
1674
+ type: string
1675
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1676
+ description: >
1677
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1678
+ ApiVersions429Error1:
1679
+ title: ApiVersions429Error1
1680
+ required:
1681
+ - status
1682
+ - detail
1683
+ type: object
1684
+ properties:
1685
+ type:
1686
+ type: string
1687
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1688
+ title:
1689
+ type: string
1690
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1691
+ status:
1692
+ type: integer
1693
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1694
+ format: int32
1695
+ detail:
1696
+ type: string
1697
+ description: A human-readable explanation specific to this occurrence of the problem.
1698
+ instance:
1699
+ type: string
1700
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1701
+ description: >
1702
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1703
+ ApiVersions500Error1:
1704
+ title: ApiVersions500Error1
1705
+ required:
1706
+ - status
1707
+ - detail
1708
+ type: object
1709
+ properties:
1710
+ type:
1711
+ type: string
1712
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1713
+ title:
1714
+ type: string
1715
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1716
+ status:
1717
+ type: integer
1718
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1719
+ format: int32
1720
+ detail:
1721
+ type: string
1722
+ description: A human-readable explanation specific to this occurrence of the problem.
1723
+ instance:
1724
+ type: string
1725
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1726
+ description: >
1727
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1728
+ ApiVersions503Error1:
1729
+ title: ApiVersions503Error1
1730
+ required:
1731
+ - status
1732
+ - detail
1733
+ type: object
1734
+ properties:
1735
+ type:
1736
+ type: string
1737
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1738
+ title:
1739
+ type: string
1740
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1741
+ status:
1742
+ type: integer
1743
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1744
+ format: int32
1745
+ detail:
1746
+ type: string
1747
+ description: A human-readable explanation specific to this occurrence of the problem.
1748
+ instance:
1749
+ type: string
1750
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1751
+ description: >
1752
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1753
+ ApiVersions504Error1:
1754
+ title: ApiVersions504Error1
1755
+ required:
1756
+ - status
1757
+ - detail
1758
+ type: object
1759
+ properties:
1760
+ type:
1761
+ type: string
1762
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1763
+ title:
1764
+ type: string
1765
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1766
+ status:
1767
+ type: integer
1768
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1769
+ format: int32
1770
+ detail:
1771
+ type: string
1772
+ description: A human-readable explanation specific to this occurrence of the problem.
1773
+ instance:
1774
+ type: string
1775
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1776
+ description: >
1777
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1778
+ Configuration.Get:
1779
+ title: Configuration.Get
1780
+ required:
1781
+ - vnfConfigurationData
1782
+ type: object
1783
+ properties:
1784
+ vnfConfigurationData:
1785
+ allOf:
1786
+ - $ref: '#/components/schemas/VnfConfigurationData'
1787
+ - description: This type represents configuration parameters of a VNF instance.
1788
+ vnfcConfigurationData:
1789
+ type: array
1790
+ items:
1791
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
1792
+ description: Configuration parameters of the VNFC instances.
1793
+ description: This type represents configuration parameters of a VNF instance and its VNFC instances.
1794
+ VnfConfigurationData:
1795
+ title: VnfConfigurationData
1796
+ type: object
1797
+ properties:
1798
+ extCpConfig:
1799
+ type: array
1800
+ items:
1801
+ $ref: '#/components/schemas/ExtCpConfig'
1802
+ description: Configuration parameters for the external CPs of the VNF instance.
1803
+ dhcpServer:
1804
+ type: string
1805
+ description: 'An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.'
1806
+ vnfSpecificData:
1807
+ type: object
1808
+ description: This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber", "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of different type.
1809
+ description: This type represents configuration parameters of a VNF instance.
1810
+ ExtCpConfig:
1811
+ title: ExtCpConfig
1812
+ required:
1813
+ - cpId
1814
+ - cpdId
1815
+ - addresses
1816
+ type: object
1817
+ properties:
1818
+ cpId:
1819
+ type: string
1820
+ description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.
1821
+ cpdId:
1822
+ type: string
1823
+ description: An identifier that is unique within a VNF descriptor.
1824
+ addresses:
1825
+ type: array
1826
+ items:
1827
+ oneOf:
1828
+ - $ref: '#/components/schemas/Address3'
1829
+ - $ref: '#/components/schemas/Address4'
1830
+ anyOf:
1831
+ - $ref: '#/components/schemas/Address'
1832
+ - $ref: '#/components/schemas/Address'
1833
+ description: Network address and port assigned to the CP.
1834
+ description: This type represents configuration parameters of a CP instance.
1835
+ Address:
1836
+ title: Address
1837
+ type: object
1838
+ properties:
1839
+ address:
1840
+ allOf:
1841
+ - $ref: '#/components/schemas/Address1'
1842
+ - description: Network address that has been configured on the CP. See NOTE 1.
1843
+ useDynamicAddress:
1844
+ type: boolean
1845
+ description: Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.
1846
+ port:
1847
+ type: integer
1848
+ description: The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).
1849
+ format: int32
1850
+ Address1:
1851
+ title: Address1
1852
+ type: object
1853
+ properties:
1854
+ macAddress:
1855
+ type: string
1856
+ description: 'A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.'
1857
+ ipAddress:
1858
+ type: string
1859
+ description: 'An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.'
1860
+ description: Network address that has been configured on the CP. See NOTE 1.
1861
+ Address3:
1862
+ title: Address3
1863
+ required:
1864
+ - address
1865
+ type: object
1866
+ properties:
1867
+ address:
1868
+ allOf:
1869
+ - $ref: '#/components/schemas/Address1'
1870
+ - description: Network address that has been configured on the CP. See NOTE 1.
1871
+ useDynamicAddress:
1872
+ type: boolean
1873
+ description: Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.
1874
+ port:
1875
+ type: integer
1876
+ description: The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).
1877
+ format: int32
1878
+ Address4:
1879
+ title: Address4
1880
+ required:
1881
+ - useDynamicAddress
1882
+ type: object
1883
+ properties:
1884
+ address:
1885
+ allOf:
1886
+ - $ref: '#/components/schemas/Address1'
1887
+ - description: Network address that has been configured on the CP. See NOTE 1.
1888
+ useDynamicAddress:
1889
+ type: boolean
1890
+ description: Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.
1891
+ port:
1892
+ type: integer
1893
+ description: The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).
1894
+ format: int32
1895
+ Address5:
1896
+ title: Address5
1897
+ type: object
1898
+ properties:
1899
+ address:
1900
+ allOf:
1901
+ - $ref: '#/components/schemas/Address1'
1902
+ - description: Network address that has been configured on the CP. See NOTE 1.
1903
+ useDynamicAddress:
1904
+ type: boolean
1905
+ description: Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.
1906
+ port:
1907
+ type: integer
1908
+ description: The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).
1909
+ format: int32
1910
+ description: >-
1911
+ This type represents configuration parameters of a CP instance address.
1912
+ * NOTE 1: Either "address" or "useDynamicAddress" shall be present.
1913
+ * NOTE 2: At least one of "macAddress" and "ipAddress" shall be present.
1914
+ VnfcConfigurationDatum:
1915
+ title: VnfcConfigurationDatum
1916
+ required:
1917
+ - vnfcInstanceId
1918
+ type: object
1919
+ properties:
1920
+ vnfcInstanceId:
1921
+ type: string
1922
+ description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.
1923
+ intCpConfig:
1924
+ type: array
1925
+ items:
1926
+ $ref: '#/components/schemas/IntCpConfig'
1927
+ description: Configuration parameters for the internal CPs of the VNFC instance.
1928
+ dhcpServer:
1929
+ type: string
1930
+ description: 'An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.'
1931
+ vnfcSpecificData:
1932
+ type: object
1933
+ description: This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber", "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of different type.
1934
+ description: This type represents configuration parameters of a VNFC instance.
1935
+ IntCpConfig:
1936
+ title: IntCpConfig
1937
+ required:
1938
+ - cpId
1939
+ - cpdId
1940
+ - addresses
1941
+ type: object
1942
+ properties:
1943
+ cpId:
1944
+ type: string
1945
+ description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.
1946
+ cpdId:
1947
+ type: string
1948
+ description: An identifier that is unique within a VNF descriptor.
1949
+ addresses:
1950
+ type: array
1951
+ items:
1952
+ oneOf:
1953
+ - $ref: '#/components/schemas/Address3'
1954
+ - $ref: '#/components/schemas/Address4'
1955
+ anyOf:
1956
+ - $ref: '#/components/schemas/Address'
1957
+ - $ref: '#/components/schemas/Address'
1958
+ description: Network address and port assigned to the CP.
1959
+ description: This type represents configuration parameters of a CP instance.
1960
+ Configuration400Error1:
1961
+ title: Configuration400Error1
1962
+ required:
1963
+ - status
1964
+ - detail
1965
+ type: object
1966
+ properties:
1967
+ type:
1968
+ type: string
1969
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1970
+ title:
1971
+ type: string
1972
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1973
+ status:
1974
+ type: integer
1975
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
1976
+ format: int32
1977
+ detail:
1978
+ type: string
1979
+ description: A human-readable explanation specific to this occurrence of the problem.
1980
+ instance:
1981
+ type: string
1982
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1983
+ description: >
1984
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
1985
+ Configuration401Error1:
1986
+ title: Configuration401Error1
1987
+ required:
1988
+ - status
1989
+ - detail
1990
+ type: object
1991
+ properties:
1992
+ type:
1993
+ type: string
1994
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
1995
+ title:
1996
+ type: string
1997
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
1998
+ status:
1999
+ type: integer
2000
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2001
+ format: int32
2002
+ detail:
2003
+ type: string
2004
+ description: A human-readable explanation specific to this occurrence of the problem.
2005
+ instance:
2006
+ type: string
2007
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2008
+ description: >
2009
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2010
+ Configuration403Error1:
2011
+ title: Configuration403Error1
2012
+ required:
2013
+ - status
2014
+ - detail
2015
+ type: object
2016
+ properties:
2017
+ type:
2018
+ type: string
2019
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2020
+ title:
2021
+ type: string
2022
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2023
+ status:
2024
+ type: integer
2025
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2026
+ format: int32
2027
+ detail:
2028
+ type: string
2029
+ description: A human-readable explanation specific to this occurrence of the problem.
2030
+ instance:
2031
+ type: string
2032
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2033
+ description: >
2034
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2035
+ Configuration404Error1:
2036
+ title: Configuration404Error1
2037
+ required:
2038
+ - status
2039
+ - detail
2040
+ type: object
2041
+ properties:
2042
+ type:
2043
+ type: string
2044
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2045
+ title:
2046
+ type: string
2047
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2048
+ status:
2049
+ type: integer
2050
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2051
+ format: int32
2052
+ detail:
2053
+ type: string
2054
+ description: A human-readable explanation specific to this occurrence of the problem.
2055
+ instance:
2056
+ type: string
2057
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2058
+ description: >
2059
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2060
+ Configuration405Error1:
2061
+ title: Configuration405Error1
2062
+ required:
2063
+ - status
2064
+ - detail
2065
+ type: object
2066
+ properties:
2067
+ type:
2068
+ type: string
2069
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2070
+ title:
2071
+ type: string
2072
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2073
+ status:
2074
+ type: integer
2075
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2076
+ format: int32
2077
+ detail:
2078
+ type: string
2079
+ description: A human-readable explanation specific to this occurrence of the problem.
2080
+ instance:
2081
+ type: string
2082
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2083
+ description: >
2084
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2085
+ Configuration406Error1:
2086
+ title: Configuration406Error1
2087
+ required:
2088
+ - status
2089
+ - detail
2090
+ type: object
2091
+ properties:
2092
+ type:
2093
+ type: string
2094
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2095
+ title:
2096
+ type: string
2097
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2098
+ status:
2099
+ type: integer
2100
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2101
+ format: int32
2102
+ detail:
2103
+ type: string
2104
+ description: A human-readable explanation specific to this occurrence of the problem.
2105
+ instance:
2106
+ type: string
2107
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2108
+ description: >
2109
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2110
+ Configuration422Error1:
2111
+ title: Configuration422Error1
2112
+ required:
2113
+ - status
2114
+ - detail
2115
+ type: object
2116
+ properties:
2117
+ type:
2118
+ type: string
2119
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2120
+ title:
2121
+ type: string
2122
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2123
+ status:
2124
+ type: integer
2125
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2126
+ format: int32
2127
+ detail:
2128
+ type: string
2129
+ description: A human-readable explanation specific to this occurrence of the problem.
2130
+ instance:
2131
+ type: string
2132
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2133
+ description: >
2134
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2135
+ Configuration429Error1:
2136
+ title: Configuration429Error1
2137
+ required:
2138
+ - status
2139
+ - detail
2140
+ type: object
2141
+ properties:
2142
+ type:
2143
+ type: string
2144
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2145
+ title:
2146
+ type: string
2147
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2148
+ status:
2149
+ type: integer
2150
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2151
+ format: int32
2152
+ detail:
2153
+ type: string
2154
+ description: A human-readable explanation specific to this occurrence of the problem.
2155
+ instance:
2156
+ type: string
2157
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2158
+ description: >
2159
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2160
+ Configuration500Error1:
2161
+ title: Configuration500Error1
2162
+ required:
2163
+ - status
2164
+ - detail
2165
+ type: object
2166
+ properties:
2167
+ type:
2168
+ type: string
2169
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2170
+ title:
2171
+ type: string
2172
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2173
+ status:
2174
+ type: integer
2175
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2176
+ format: int32
2177
+ detail:
2178
+ type: string
2179
+ description: A human-readable explanation specific to this occurrence of the problem.
2180
+ instance:
2181
+ type: string
2182
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2183
+ description: >
2184
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2185
+ Configuration503Error1:
2186
+ title: Configuration503Error1
2187
+ required:
2188
+ - status
2189
+ - detail
2190
+ type: object
2191
+ properties:
2192
+ type:
2193
+ type: string
2194
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2195
+ title:
2196
+ type: string
2197
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2198
+ status:
2199
+ type: integer
2200
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2201
+ format: int32
2202
+ detail:
2203
+ type: string
2204
+ description: A human-readable explanation specific to this occurrence of the problem.
2205
+ instance:
2206
+ type: string
2207
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2208
+ description: >
2209
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2210
+ Configuration504Error1:
2211
+ title: Configuration504Error1
2212
+ required:
2213
+ - status
2214
+ - detail
2215
+ type: object
2216
+ properties:
2217
+ type:
2218
+ type: string
2219
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2220
+ title:
2221
+ type: string
2222
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2223
+ status:
2224
+ type: integer
2225
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2226
+ format: int32
2227
+ detail:
2228
+ type: string
2229
+ description: A human-readable explanation specific to this occurrence of the problem.
2230
+ instance:
2231
+ type: string
2232
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2233
+ description: >
2234
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2235
+ ConfigurationRequest:
2236
+ title: ConfigurationRequest
2237
+ required:
2238
+ - vnfConfigurationData
2239
+ type: object
2240
+ properties:
2241
+ vnfConfigurationData:
2242
+ allOf:
2243
+ - $ref: '#/components/schemas/VnfConfigurationData'
2244
+ - description: This type represents configuration parameters of a VNF instance.
2245
+ vnfcConfigurationData:
2246
+ type: array
2247
+ items:
2248
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
2249
+ description: >-
2250
+ Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions:
2251
+ Modifying an attribute that is an array of objects of type "VnfcConfigurationData".
2252
+ Assumptions:
2253
+ 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList"
2254
+ is the "VnfcConfigurationData" array that contains the changes.
2255
+ 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
2256
+ 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that
2257
+ has the same content of the "vnfcInstanceId" attribute as the "newEntry";
2258
+ a "newEntry" has no corresponding entry if no such "oldEntry" exists.
2259
+ 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId"
2260
+ is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId").
2261
+ Provisions:
2262
+ 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
2263
+ the "oldList" array shall be modified by adding that "newEntry".
2264
+
2265
+ 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
2266
+ the value of "oldEntry" shall be updated with the value of "newEntry" according to
2267
+ the rules of JSON Merge PATCH (see IETF RFC 7396 ).
2268
+ vnfcConfigurationDataDeleteIds:
2269
+ type: array
2270
+ items:
2271
+ type: string
2272
+ description: List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used as "deleteIdList" as defined below this table.
2273
+ ConfigurationRequest1:
2274
+ title: ConfigurationRequest1
2275
+ required:
2276
+ - vnfcConfigurationData
2277
+ type: object
2278
+ properties:
2279
+ vnfConfigurationData:
2280
+ allOf:
2281
+ - $ref: '#/components/schemas/VnfConfigurationData'
2282
+ - description: This type represents configuration parameters of a VNF instance.
2283
+ vnfcConfigurationData:
2284
+ type: array
2285
+ items:
2286
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
2287
+ description: >-
2288
+ Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions:
2289
+ Modifying an attribute that is an array of objects of type "VnfcConfigurationData".
2290
+ Assumptions:
2291
+ 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList"
2292
+ is the "VnfcConfigurationData" array that contains the changes.
2293
+ 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
2294
+ 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that
2295
+ has the same content of the "vnfcInstanceId" attribute as the "newEntry";
2296
+ a "newEntry" has no corresponding entry if no such "oldEntry" exists.
2297
+ 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId"
2298
+ is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId").
2299
+ Provisions:
2300
+ 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
2301
+ the "oldList" array shall be modified by adding that "newEntry".
2302
+
2303
+ 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
2304
+ the value of "oldEntry" shall be updated with the value of "newEntry" according to
2305
+ the rules of JSON Merge PATCH (see IETF RFC 7396 ).
2306
+ vnfcConfigurationDataDeleteIds:
2307
+ type: array
2308
+ items:
2309
+ type: string
2310
+ description: List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used as "deleteIdList" as defined below this table.
2311
+ ConfigurationRequest2:
2312
+ title: ConfigurationRequest2
2313
+ type: object
2314
+ properties:
2315
+ vnfConfigurationData:
2316
+ allOf:
2317
+ - $ref: '#/components/schemas/VnfConfigurationData'
2318
+ - description: This type represents configuration parameters of a VNF instance.
2319
+ vnfcConfigurationData:
2320
+ type: array
2321
+ items:
2322
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
2323
+ description: >-
2324
+ Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions:
2325
+ Modifying an attribute that is an array of objects of type "VnfcConfigurationData".
2326
+ Assumptions:
2327
+ 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList"
2328
+ is the "VnfcConfigurationData" array that contains the changes.
2329
+ 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
2330
+ 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that
2331
+ has the same content of the "vnfcInstanceId" attribute as the "newEntry";
2332
+ a "newEntry" has no corresponding entry if no such "oldEntry" exists.
2333
+ 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId"
2334
+ is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId").
2335
+ Provisions:
2336
+ 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
2337
+ the "oldList" array shall be modified by adding that "newEntry".
2338
+
2339
+ 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
2340
+ the value of "oldEntry" shall be updated with the value of "newEntry" according to
2341
+ the rules of JSON Merge PATCH (see IETF RFC 7396 ).
2342
+ vnfcConfigurationDataDeleteIds:
2343
+ type: array
2344
+ items:
2345
+ type: string
2346
+ description: List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used as "deleteIdList" as defined below this table.
2347
+ description: >-
2348
+ This type represents request parameters for the "Set Configuration" operation.
2349
+ * NOTE 1: At least one of "vnfConfigurationData" and "vnfcConfigurationData"
2350
+ shall be present.
2351
+ * NOTE 2: The VnfcConfiguration data type can only be used to modify the configuration
2352
+ of existing VNFC instances.
2353
+ Configuration.Patch:
2354
+ title: Configuration.Patch
2355
+ required:
2356
+ - vnfConfigurationData
2357
+ type: object
2358
+ properties:
2359
+ vnfConfigurationData:
2360
+ allOf:
2361
+ - $ref: '#/components/schemas/VnfConfigurationData'
2362
+ - description: This type represents configuration parameters of a VNF instance.
2363
+ vnfcConfigurationData:
2364
+ type: array
2365
+ items:
2366
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
2367
+ description: >-
2368
+ Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions:
2369
+ Modifying an attribute that is an array of objects of type "VnfcConfigurationData".
2370
+ Assumptions:
2371
+ 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList"
2372
+ is the "VnfcConfigurationData" array that contains the changes.
2373
+ 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
2374
+ 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that
2375
+ has the same content of the "vnfcInstanceId" attribute as the "newEntry";
2376
+ a "newEntry" has no corresponding entry if no such "oldEntry" exists.
2377
+ 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId"
2378
+ is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId").
2379
+ Provisions:
2380
+ 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
2381
+ the "oldList" array shall be modified by adding that "newEntry".
2382
+
2383
+ 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
2384
+ the value of "oldEntry" shall be updated with the value of "newEntry" according to
2385
+ the rules of JSON Merge PATCH (see IETF RFC 7396 ).
2386
+ vnfcConfigurationDataDeleteIds:
2387
+ type: array
2388
+ items:
2389
+ type: string
2390
+ description: List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used as "deleteIdList" as defined below this table.
2391
+ Configuration.Patch1:
2392
+ title: Configuration.Patch1
2393
+ required:
2394
+ - vnfcConfigurationData
2395
+ type: object
2396
+ properties:
2397
+ vnfConfigurationData:
2398
+ allOf:
2399
+ - $ref: '#/components/schemas/VnfConfigurationData'
2400
+ - description: This type represents configuration parameters of a VNF instance.
2401
+ vnfcConfigurationData:
2402
+ type: array
2403
+ items:
2404
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
2405
+ description: >-
2406
+ Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions:
2407
+ Modifying an attribute that is an array of objects of type "VnfcConfigurationData".
2408
+ Assumptions:
2409
+ 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList"
2410
+ is the "VnfcConfigurationData" array that contains the changes.
2411
+ 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
2412
+ 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that
2413
+ has the same content of the "vnfcInstanceId" attribute as the "newEntry";
2414
+ a "newEntry" has no corresponding entry if no such "oldEntry" exists.
2415
+ 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId"
2416
+ is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId").
2417
+ Provisions:
2418
+ 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
2419
+ the "oldList" array shall be modified by adding that "newEntry".
2420
+
2421
+ 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
2422
+ the value of "oldEntry" shall be updated with the value of "newEntry" according to
2423
+ the rules of JSON Merge PATCH (see IETF RFC 7396 ).
2424
+ vnfcConfigurationDataDeleteIds:
2425
+ type: array
2426
+ items:
2427
+ type: string
2428
+ description: List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used as "deleteIdList" as defined below this table.
2429
+ Configuration.Patch2:
2430
+ title: Configuration.Patch2
2431
+ type: object
2432
+ properties:
2433
+ vnfConfigurationData:
2434
+ allOf:
2435
+ - $ref: '#/components/schemas/VnfConfigurationData'
2436
+ - description: This type represents configuration parameters of a VNF instance.
2437
+ vnfcConfigurationData:
2438
+ type: array
2439
+ items:
2440
+ $ref: '#/components/schemas/VnfcConfigurationDatum'
2441
+ description: >-
2442
+ Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions:
2443
+ Modifying an attribute that is an array of objects of type "VnfcConfigurationData".
2444
+ Assumptions:
2445
+ 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList"
2446
+ is the "VnfcConfigurationData" array that contains the changes.
2447
+ 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
2448
+ 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that
2449
+ has the same content of the "vnfcInstanceId" attribute as the "newEntry";
2450
+ a "newEntry" has no corresponding entry if no such "oldEntry" exists.
2451
+ 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId"
2452
+ is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId").
2453
+ Provisions:
2454
+ 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
2455
+ the "oldList" array shall be modified by adding that "newEntry".
2456
+
2457
+ 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
2458
+ the value of "oldEntry" shall be updated with the value of "newEntry" according to
2459
+ the rules of JSON Merge PATCH (see IETF RFC 7396 ).
2460
+ vnfcConfigurationDataDeleteIds:
2461
+ type: array
2462
+ items:
2463
+ type: string
2464
+ description: List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used as "deleteIdList" as defined below this table.
2465
+ description: >-
2466
+ This type represents request parameters for the "Set Configuration" operation.
2467
+ * NOTE 1: At least one of "vnfConfigurationData" and "vnfcConfigurationData"
2468
+ shall be present.
2469
+ * NOTE 2: The VnfcConfiguration data type can only be used to modify the configuration
2470
+ of existing VNFC instances.
2471
+ Configuration412Error1:
2472
+ title: Configuration412Error1
2473
+ required:
2474
+ - status
2475
+ - detail
2476
+ type: object
2477
+ properties:
2478
+ type:
2479
+ type: string
2480
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2481
+ title:
2482
+ type: string
2483
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2484
+ status:
2485
+ type: integer
2486
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2487
+ format: int32
2488
+ detail:
2489
+ type: string
2490
+ description: A human-readable explanation specific to this occurrence of the problem.
2491
+ instance:
2492
+ type: string
2493
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2494
+ description: >
2495
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2496
+ Configuration416Error:
2497
+ title: Configuration416Error
2498
+ required:
2499
+ - status
2500
+ - detail
2501
+ type: object
2502
+ properties:
2503
+ type:
2504
+ type: string
2505
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2506
+ title:
2507
+ type: string
2508
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2509
+ status:
2510
+ type: integer
2511
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2512
+ format: int32
2513
+ detail:
2514
+ type: string
2515
+ description: A human-readable explanation specific to this occurrence of the problem.
2516
+ instance:
2517
+ type: string
2518
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2519
+ description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2520
+ Configuration416Error1:
2521
+ title: Configuration416Error1
2522
+ required:
2523
+ - status
2524
+ - detail
2525
+ type: object
2526
+ properties:
2527
+ type:
2528
+ type: string
2529
+ description: A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
2530
+ title:
2531
+ type: string
2532
+ description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
2533
+ status:
2534
+ type: integer
2535
+ description: The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
2536
+ format: int32
2537
+ detail:
2538
+ type: string
2539
+ description: A human-readable explanation specific to this occurrence of the problem.
2540
+ instance:
2541
+ type: string
2542
+ description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
2543
+ description: >
2544
+ The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
2545
+ tags: []
2546
+ externalDocs:
2547
+ description: ETSI GS NFV-SOL 002 V3.3.1
2548
+ url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf