Gitiles
Code Review Sign In
osm.etsi.org / osm / SOL005 / fe8c59fc46b8180f72b75cb985e7ccc8be64d6c9 / . / osm-openapi.yaml
blob: a8ad2bef59488a4c74997a64dab80a3dc17bc303 [file] [log] [blame]
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]1openapi: 3.0.0
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]3servers:
4 - description: OSM NB API
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]5 url: 'https://osm.etsi.org/nbapi/v1.0.0'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]6
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]7info:
8 description: |
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
Felipe Vicens69385fc2019-10-09 10:58:57 +0200[diff] [blame]10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]13 version: "1.0.0"
14 title: OSM NB API featuring ETSI NFV SOL005
15 contact:
16 email: OSM_TECH@list.etsi.org
17 license:
18 name: Apache 2.0
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]20
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]21tags:
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
24 - name: 'NS packages'
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]32 - name: 'NS Performance Management'
33 description: Management operations related to Performance Mangement of NS instances
34 - name: 'Physical Data Units (PDU)'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]35 description: Management operations of PDUs
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]36 - name: 'Authentication'
37 description: Authentication operations
38 - name: 'Identity'
39 description: Management operations of users, projects and roles
40 - name: 'Infrastructure'
41 description: Management operations of VIM, VIM accounts, WIM and SDN controllers
42 - name: 'Repositories'
43 description: Management operations of repositories
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]44 - name: 'Admin'
45 description: Management operations of Administration items
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame^]46 - name: 'K8s Cluster'
47 description: Management operations of k8s Cluster
48 - name: 'KSU'
49 description: Management operations of KSU
50 - name: 'OKA packages'
51 description: Management operations of OKA packages
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]52
53security:
54 - bearerAuth: []
55
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]56paths:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]57
58# BEGIN NS Packages
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]59 '/nsd/v1/ns_descriptors':
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]60 get:
61 tags:
62 - "NS packages"
63 summary: Query information about multiple NS descriptor resources
64 description: Query information about multiple NS descriptor resources
65 operationId: getNSDs
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]66 responses:
67 '200':
68 description: OK
69 content:
70 application/json:
71 schema:
72 $ref: '#/components/schemas/ArrayOfNsdInfo'
73 application/yaml:
74 schema:
75 $ref: '#/components/schemas/ArrayOfNsdInfo'
76 '400':
77 $ref: '#/components/responses/BadRequest'
78 '401':
79 $ref: '#/components/responses/Unauthorized'
80 '403':
81 $ref: '#/components/responses/Forbidden'
82 '404':
83 $ref: '#/components/responses/NotFound'
84 '405':
85 $ref: '#/components/responses/MethodNotAllowed'
86 '406':
87 $ref: '#/components/responses/NotAcceptable'
88 '409':
89 $ref: '#/components/responses/Conflict'
90 '422':
91 $ref: '#/components/responses/UnprocessableEntity'
92 '500':
93 $ref: '#/components/responses/InternalServerError'
94 '503':
95 $ref: '#/components/responses/ServiceUnavailable'
96 '5XX':
97 $ref: '#/components/responses/UnexpectedError'
98 default:
99 $ref: '#/components/responses/UnexpectedError'
100 post:
101 tags:
102 - "NS packages"
103 summary: Create a new NS descriptor resource
104 description: Create a new NS descriptor resource
105 operationId: addNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]106 requestBody:
107 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
108 responses:
109 '201':
110 description: Created
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]111 headers:
112 Location:
113 schema:
114 type: string
115 format: uri
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]116 content:
117 application/json:
118 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]119 $ref: '#/components/schemas/ObjectId'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]120 application/yaml:
121 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]122 $ref: '#/components/schemas/ObjectId'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]123 '400':
124 $ref: '#/components/responses/BadRequest'
125 '401':
126 $ref: '#/components/responses/Unauthorized'
127 '403':
128 $ref: '#/components/responses/Forbidden'
129 '404':
130 $ref: '#/components/responses/NotFound'
131 '405':
132 $ref: '#/components/responses/MethodNotAllowed'
133 '406':
134 $ref: '#/components/responses/NotAcceptable'
135 '409':
136 $ref: '#/components/responses/Conflict'
137 '422':
138 $ref: '#/components/responses/UnprocessableEntity'
139 '500':
140 $ref: '#/components/responses/InternalServerError'
141 '503':
142 $ref: '#/components/responses/ServiceUnavailable'
143 '5XX':
144 $ref: '#/components/responses/UnexpectedError'
145 default:
146 $ref: '#/components/responses/UnexpectedError'
147 '/nsd/v1/ns_descriptors/{nsdInfoId}':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]148 parameters:
149 - name: nsdInfoId
150 in: path
151 required: true
152 description: NSD Info ID
153 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]154 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]155 get:
156 tags:
157 - "NS packages"
158 summary: Read information about an individual NS descriptor resource
159 description: Read information about an individual NS descriptor resource
160 operationId: getNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]161 responses:
162 '200':
163 description: OK
164 content:
165 application/json:
166 schema:
167 $ref: '#/components/schemas/NsdInfo'
168 application/yaml:
169 schema:
170 $ref: '#/components/schemas/NsdInfo'
171 '400':
172 $ref: '#/components/responses/BadRequest'
173 '401':
174 $ref: '#/components/responses/Unauthorized'
175 '403':
176 $ref: '#/components/responses/Forbidden'
177 '404':
178 $ref: '#/components/responses/NotFound'
179 '405':
180 $ref: '#/components/responses/MethodNotAllowed'
181 '406':
182 $ref: '#/components/responses/NotAcceptable'
183 '409':
184 $ref: '#/components/responses/Conflict'
185 '422':
186 $ref: '#/components/responses/UnprocessableEntity'
187 '500':
188 $ref: '#/components/responses/InternalServerError'
189 '503':
190 $ref: '#/components/responses/ServiceUnavailable'
191 '5XX':
192 $ref: '#/components/responses/UnexpectedError'
193 default:
194 $ref: '#/components/responses/UnexpectedError'
195 delete:
196 tags:
197 - "NS packages"
198 summary: Delete an individual NS descriptor resource
199 description: Delete an individual NS descriptor resource
200 operationId: deleteNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]201 responses:
202 '204':
203 description: No Content
204 '400':
205 $ref: '#/components/responses/BadRequest'
206 '401':
207 $ref: '#/components/responses/Unauthorized'
208 '403':
209 $ref: '#/components/responses/Forbidden'
210 '404':
211 $ref: '#/components/responses/NotFound'
212 '405':
213 $ref: '#/components/responses/MethodNotAllowed'
214 '406':
215 $ref: '#/components/responses/NotAcceptable'
216 '409':
217 $ref: '#/components/responses/Conflict'
218 '422':
219 $ref: '#/components/responses/UnprocessableEntity'
220 '500':
221 $ref: '#/components/responses/InternalServerError'
222 '503':
223 $ref: '#/components/responses/ServiceUnavailable'
224 '5XX':
225 $ref: '#/components/responses/UnexpectedError'
226 default:
227 $ref: '#/components/responses/UnexpectedError'
228 patch:
229 tags:
230 - "NS packages"
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]231 summary: Modify the data of an individual NS descriptor resource
232 description: Modify the data of an individual NS descriptor resource
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]233 operationId: updateNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]234 requestBody:
235 $ref: '#/components/requestBodies/NsdInfoModifications'
236 responses:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]237 '204':
238 description: No Content
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]239 '400':
240 $ref: '#/components/responses/BadRequest'
241 '401':
242 $ref: '#/components/responses/Unauthorized'
243 '403':
244 $ref: '#/components/responses/Forbidden'
245 '404':
246 $ref: '#/components/responses/NotFound'
247 '405':
248 $ref: '#/components/responses/MethodNotAllowed'
249 '406':
250 $ref: '#/components/responses/NotAcceptable'
251 '409':
252 $ref: '#/components/responses/Conflict'
253 '422':
254 $ref: '#/components/responses/UnprocessableEntity'
255 '500':
256 $ref: '#/components/responses/InternalServerError'
257 '503':
258 $ref: '#/components/responses/ServiceUnavailable'
259 '5XX':
260 $ref: '#/components/responses/UnexpectedError'
261 default:
262 $ref: '#/components/responses/UnexpectedError'
263 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]264 parameters:
265 - name: nsdInfoId
266 in: path
267 required: true
268 description: NSD Info ID
269 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]270 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]271 get:
272 tags:
273 - "NS packages"
274 summary: Fetch the content of a NSD
275 description: Fetch the content of a NSD
276 operationId: getNSDcontent
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]277 responses:
278 '200':
279 description: OK
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]280 content:
281 application/zip:
282 schema:
283 $ref: '#/components/schemas/NsPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]284 '206':
285 description: Partial Content
286 headers:
287 Content-Range:
288 schema:
289 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]290 content:
291 application/zip:
292 schema:
293 $ref: '#/components/schemas/NsPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]294 '400':
295 $ref: '#/components/responses/BadRequest'
296 '401':
297 $ref: '#/components/responses/Unauthorized'
298 '403':
299 $ref: '#/components/responses/Forbidden'
300 '404':
301 $ref: '#/components/responses/NotFound'
302 '405':
303 $ref: '#/components/responses/MethodNotAllowed'
304 '406':
305 $ref: '#/components/responses/NotAcceptable'
306 '409':
307 $ref: '#/components/responses/Conflict'
308 '422':
309 $ref: '#/components/responses/UnprocessableEntity'
310 '500':
311 $ref: '#/components/responses/InternalServerError'
312 '503':
313 $ref: '#/components/responses/ServiceUnavailable'
314 '5XX':
315 $ref: '#/components/responses/UnexpectedError'
316 default:
317 $ref: '#/components/responses/UnexpectedError'
318 put:
319 tags:
320 - "NS packages"
321 summary: Upload the content of a NSD
322 description: Upload the content of a NSD
323 operationId: updateNSDcontent
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]324 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]325 $ref: '#/components/requestBodies/NsPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]326 responses:
327 '202':
328 description: Accepted
329 '204':
330 description: No Content
331 '400':
332 $ref: '#/components/responses/BadRequest'
333 '401':
334 $ref: '#/components/responses/Unauthorized'
335 '403':
336 $ref: '#/components/responses/Forbidden'
337 '404':
338 $ref: '#/components/responses/NotFound'
339 '405':
340 $ref: '#/components/responses/MethodNotAllowed'
341 '406':
342 $ref: '#/components/responses/NotAcceptable'
343 '409':
344 $ref: '#/components/responses/Conflict'
345 '422':
346 $ref: '#/components/responses/UnprocessableEntity'
347 '500':
348 $ref: '#/components/responses/InternalServerError'
349 '503':
350 $ref: '#/components/responses/ServiceUnavailable'
351 '5XX':
352 $ref: '#/components/responses/UnexpectedError'
353 default:
354 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]355 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
356 parameters:
357 - name: nsdInfoId
358 in: path
359 required: true
360 description: NS Package ID
361 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]362 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]363 - name: artifactPath
364 in: path
365 required: true
366 description: Artifact Path
367 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]368 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]369 get:
370 tags:
371 - "NS packages"
372 summary: Fetch individual NS package artifact
373 description: Fetch individual NS package artifact
374 operationId: getNsPkgArtifact
375 responses:
376 '200':
377 description: OK
378 content:
379 application/octet-stream:
380 schema:
381 type: string
382 format: binary
383 '206':
384 description: Partial Content
385 headers:
386 Content-Range:
387 schema:
388 type: string
389 content:
390 application/octet-stream:
391 schema:
392 type: string
393 format: binary
394 '400':
395 $ref: '#/components/responses/BadRequest'
396 '401':
397 $ref: '#/components/responses/Unauthorized'
398 '403':
399 $ref: '#/components/responses/Forbidden'
400 '404':
401 $ref: '#/components/responses/NotFound'
402 '405':
403 $ref: '#/components/responses/MethodNotAllowed'
404 '406':
405 $ref: '#/components/responses/NotAcceptable'
406 '409':
407 $ref: '#/components/responses/Conflict'
408 '422':
409 $ref: '#/components/responses/UnprocessableEntity'
410 '500':
411 $ref: '#/components/responses/InternalServerError'
412 '503':
413 $ref: '#/components/responses/ServiceUnavailable'
414 '5XX':
415 $ref: '#/components/responses/UnexpectedError'
416 default:
417 $ref: '#/components/responses/UnexpectedError'
418 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
419 parameters:
420 - name: nsdInfoId
421 in: path
422 required: true
423 description: NS Package ID
424 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]425 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]426 get:
427 tags:
428 - "NS packages"
429 summary: Read NSD of an on-boarded NS package
430 description: Read NSD of an on-boarded NS package
431 operationId: getNsPkgNsd
432 responses:
433 '200':
434 description: OK
435 content:
436 text/plain:
437 schema:
438 $ref: '#/components/schemas/NsDescriptor'
439 '400':
440 $ref: '#/components/responses/BadRequest'
441 '401':
442 $ref: '#/components/responses/Unauthorized'
443 '403':
444 $ref: '#/components/responses/Forbidden'
445 '404':
446 $ref: '#/components/responses/NotFound'
447 '405':
448 $ref: '#/components/responses/MethodNotAllowed'
449 '406':
450 $ref: '#/components/responses/NotAcceptable'
451 '409':
452 $ref: '#/components/responses/Conflict'
453 '422':
454 $ref: '#/components/responses/UnprocessableEntity'
455 '500':
456 $ref: '#/components/responses/InternalServerError'
457 '503':
458 $ref: '#/components/responses/ServiceUnavailable'
459 '5XX':
460 $ref: '#/components/responses/UnexpectedError'
461 default:
462 $ref: '#/components/responses/UnexpectedError'
463 '/nsd/v1/ns_descriptors_content':
464 post:
465 tags:
466 - "NS packages"
467 summary: Upload a NS package by providing the content of the NS package
468 description: Upload a NS package by providing the content of the NS package
469 operationId: uploadNsPkgsContent
470 requestBody:
471 content:
472 application/zip:
473 schema:
474 $ref: '#/components/schemas/NsPackage'
475 responses:
476 '201':
477 description: Created
478 headers:
479 Location:
480 schema:
481 type: string
482 format: uri
483 content:
484 application/json:
485 schema:
486 $ref: '#/components/schemas/ObjectId'
487 application/yaml:
488 schema:
489 $ref: '#/components/schemas/ObjectId'
490 '202':
491 description: Accepted
492 '204':
493 description: No Content
494 '400':
495 $ref: '#/components/responses/BadRequest'
496 '401':
497 $ref: '#/components/responses/Unauthorized'
498 '403':
499 $ref: '#/components/responses/Forbidden'
500 '404':
501 $ref: '#/components/responses/NotFound'
502 '405':
503 $ref: '#/components/responses/MethodNotAllowed'
504 '406':
505 $ref: '#/components/responses/NotAcceptable'
506 '409':
507 $ref: '#/components/responses/Conflict'
508 '422':
509 $ref: '#/components/responses/UnprocessableEntity'
510 '500':
511 $ref: '#/components/responses/InternalServerError'
512 '503':
513 $ref: '#/components/responses/ServiceUnavailable'
514 '5XX':
515 $ref: '#/components/responses/UnexpectedError'
516 default:
517 $ref: '#/components/responses/UnexpectedError'
518 get:
519 tags:
520 - "NS packages"
521 summary: Query information about multiple NS package resources
522 description: Query information about multiple NS package resources
523 operationId: getNsPkgsContent
524 responses:
525 '200':
526 description: OK
527 content:
528 application/json:
529 schema:
530 $ref: '#/components/schemas/ArrayOfNsdInfo'
531 application/yaml:
532 schema:
533 $ref: '#/components/schemas/ArrayOfNsdInfo'
534 '206':
535 description: Partial Content
536 headers:
537 Content-Range:
538 schema:
539 type: string
540 content:
541 application/octet-stream:
542 schema:
543 type: string
544 format: binary
545 '400':
546 $ref: '#/components/responses/BadRequest'
547 '401':
548 $ref: '#/components/responses/Unauthorized'
549 '403':
550 $ref: '#/components/responses/Forbidden'
551 '404':
552 $ref: '#/components/responses/NotFound'
553 '405':
554 $ref: '#/components/responses/MethodNotAllowed'
555 '406':
556 $ref: '#/components/responses/NotAcceptable'
557 '409':
558 $ref: '#/components/responses/Conflict'
559 '422':
560 $ref: '#/components/responses/UnprocessableEntity'
561 '500':
562 $ref: '#/components/responses/InternalServerError'
563 '503':
564 $ref: '#/components/responses/ServiceUnavailable'
565 '5XX':
566 $ref: '#/components/responses/UnexpectedError'
567 default:
568 $ref: '#/components/responses/UnexpectedError'
569 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
570 parameters:
571 - name: nsdInfoId
572 in: path
573 required: true
574 description: NS Package ID
575 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]576 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]577 get:
578 tags:
579 - "NS packages"
580 summary: Read information about an individual NS package resource
581 description: Read information about an individual NS package resource
582 operationId: getNsPkgsIdContent
583 responses:
584 '200':
585 description: OK
586 content:
587 application/json:
588 schema:
589 $ref: '#/components/schemas/NsdInfo'
590 application/yaml:
591 schema:
592 $ref: '#/components/schemas/NsdInfo'
593 '400':
594 $ref: '#/components/responses/BadRequest'
595 '401':
596 $ref: '#/components/responses/Unauthorized'
597 '403':
598 $ref: '#/components/responses/Forbidden'
599 '404':
600 $ref: '#/components/responses/NotFound'
601 '405':
602 $ref: '#/components/responses/MethodNotAllowed'
603 '406':
604 $ref: '#/components/responses/NotAcceptable'
605 '409':
606 $ref: '#/components/responses/Conflict'
607 '422':
608 $ref: '#/components/responses/UnprocessableEntity'
609 '500':
610 $ref: '#/components/responses/InternalServerError'
611 '503':
612 $ref: '#/components/responses/ServiceUnavailable'
613 '5XX':
614 $ref: '#/components/responses/UnexpectedError'
615 default:
616 $ref: '#/components/responses/UnexpectedError'
617 put:
618 tags:
619 - "NS packages"
620 summary: Modify an individual NS package resource
621 description: Modify an individual NS package resource
622 operationId: updateNsPkgsIdContent
623 requestBody:
624 $ref: '#/components/requestBodies/NsdInfoModifications'
625 responses:
626 '204':
627 description: No Content
628 '400':
629 $ref: '#/components/responses/BadRequest'
630 '401':
631 $ref: '#/components/responses/Unauthorized'
632 '403':
633 $ref: '#/components/responses/Forbidden'
634 '404':
635 $ref: '#/components/responses/NotFound'
636 '405':
637 $ref: '#/components/responses/MethodNotAllowed'
638 '406':
639 $ref: '#/components/responses/NotAcceptable'
640 '409':
641 $ref: '#/components/responses/Conflict'
642 '422':
643 $ref: '#/components/responses/UnprocessableEntity'
644 '500':
645 $ref: '#/components/responses/InternalServerError'
646 '503':
647 $ref: '#/components/responses/ServiceUnavailable'
648 '5XX':
649 $ref: '#/components/responses/UnexpectedError'
650 default:
651 $ref: '#/components/responses/UnexpectedError'
652 delete:
653 tags:
654 - "NS packages"
655 summary: Delete an individual NS package resource
656 description: Delete an individual NS package resource
657 operationId: deleteNSPkgsIdContent
658 responses:
659 '204':
660 description: No Content
661 '400':
662 $ref: '#/components/responses/BadRequest'
663 '401':
664 $ref: '#/components/responses/Unauthorized'
665 '403':
666 $ref: '#/components/responses/Forbidden'
667 '404':
668 $ref: '#/components/responses/NotFound'
669 '405':
670 $ref: '#/components/responses/MethodNotAllowed'
671 '406':
672 $ref: '#/components/responses/NotAcceptable'
673 '409':
674 $ref: '#/components/responses/Conflict'
675 '422':
676 $ref: '#/components/responses/UnprocessableEntity'
677 '500':
678 $ref: '#/components/responses/InternalServerError'
679 '503':
680 $ref: '#/components/responses/ServiceUnavailable'
681 '5XX':
682 $ref: '#/components/responses/UnexpectedError'
683 default:
684 $ref: '#/components/responses/UnexpectedError'
685# END NS Packages
686
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]687# BEGIN Ns Config Templates
688 '/nsd/v1/ns_config_template':
689 get:
690 tags:
691 - "Ns packages"
692 summary: Query information about multiple Ns config templates
693 description: Query information about multiple Ns config templates
694 operationId: getNsconfigtemplates
695 responses:
696 '200':
697 description: OK
698 content:
699 application/json:
700 schema:
701 $ref: '#/components/schemas/ArrayOfNsConfigTemplateInfo'
702 application/yaml:
703 schema:
704 $ref: '#/components/schemas/ArrayOfNsConfigTemplateInfo'
705 '400':
706 $ref: '#/components/responses/BadRequest'
707 '401':
708 $ref: '#/components/responses/Unauthorized'
709 '403':
710 $ref: '#/components/responses/Forbidden'
711 '404':
712 $ref: '#/components/responses/NotFound'
713 '405':
714 $ref: '#/components/responses/MethodNotAllowed'
715 '406':
716 $ref: '#/components/responses/NotAcceptable'
717 '409':
718 $ref: '#/components/responses/Conflict'
719 '422':
720 $ref: '#/components/responses/UnprocessableEntity'
721 '500':
722 $ref: '#/components/responses/InternalServerError'
723 '503':
724 $ref: '#/components/responses/ServiceUnavailable'
725 '5XX':
726 $ref: '#/components/responses/UnexpectedError'
727 default:
728 $ref: '#/components/responses/UnexpectedError'
729 post:
730 tags:
731 - "Ns packages"
732 summary: Create a new Ns config template
733 description: |
734 NS config templates are specific configuration templates
735 (instantiation parameters) to be applied to NS packages.
736 when they are instantiated.
737 Template consist of NSD ID, template name and instantiation parameters.
738 operationId: addNsconfigtemplate
739 requestBody:
740 $ref: '#/components/requestBodies/CreateNsConfigTemplateInfoRequest'
741 responses:
742 '201':
743 description: Created
744 headers:
745 Location:
746 schema:
747 type: string
748 format: uri
749 content:
750 application/json:
751 schema:
752 $ref: '#/components/schemas/ObjectId'
753 application/yaml:
754 schema:
755 $ref: '#/components/schemas/ObjectId'
756 '400':
757 $ref: '#/components/responses/BadRequest'
758 '401':
759 $ref: '#/components/responses/Unauthorized'
760 '403':
761 $ref: '#/components/responses/Forbidden'
762 '404':
763 $ref: '#/components/responses/NotFound'
764 '405':
765 $ref: '#/components/responses/MethodNotAllowed'
766 '406':
767 $ref: '#/components/responses/NotAcceptable'
768 '409':
769 $ref: '#/components/responses/Conflict'
770 '422':
771 $ref: '#/components/responses/UnprocessableEntity'
772 '500':
773 $ref: '#/components/responses/InternalServerError'
774 '503':
775 $ref: '#/components/responses/ServiceUnavailable'
776 '5XX':
777 $ref: '#/components/responses/UnexpectedError'
778 default:
779 $ref: '#/components/responses/UnexpectedError'
780 '/nsd/v1/ns_config_template/{nsconfigTemplateId}':
781 parameters:
782 - name: nsconfigTemplateId
783 in: path
784 required: true
785 description: Ns config template ID
786 schema:
787 type: string
788 get:
789 tags:
790 - "Ns packages"
791 summary: Read information about an individual Ns config template resource
792 description: Read information about an individual Ns config template resource
793 operationId: getNsconfigtemplate
794 responses:
795 '200':
796 description: OK
797 content:
798 application/json:
799 schema:
800 $ref: '#/components/schemas/NsConfigTemplateInfo'
801 application/yaml:
802 schema:
803 $ref: '#/components/schemas/NsConfigTemplateInfo'
804 '400':
805 $ref: '#/components/responses/BadRequest'
806 '401':
807 $ref: '#/components/responses/Unauthorized'
808 '403':
809 $ref: '#/components/responses/Forbidden'
810 '404':
811 $ref: '#/components/responses/NotFound'
812 '405':
813 $ref: '#/components/responses/MethodNotAllowed'
814 '406':
815 $ref: '#/components/responses/NotAcceptable'
816 '409':
817 $ref: '#/components/responses/Conflict'
818 '422':
819 $ref: '#/components/responses/UnprocessableEntity'
820 '500':
821 $ref: '#/components/responses/InternalServerError'
822 '503':
823 $ref: '#/components/responses/ServiceUnavailable'
824 '5XX':
825 $ref: '#/components/responses/UnexpectedError'
826 default:
827 $ref: '#/components/responses/UnexpectedError'
828 delete:
829 tags:
830 - "Ns packages"
831 summary: Delete an individual NS config template
832 description: Delete an individual NS config template
833 operationId: deleteNsconfigtemplate
834 responses:
835 '204':
836 description: No Content
837 '400':
838 $ref: '#/components/responses/BadRequest'
839 '401':
840 $ref: '#/components/responses/Unauthorized'
841 '403':
842 $ref: '#/components/responses/Forbidden'
843 '404':
844 $ref: '#/components/responses/NotFound'
845 '405':
846 $ref: '#/components/responses/MethodNotAllowed'
847 '406':
848 $ref: '#/components/responses/NotAcceptable'
849 '409':
850 $ref: '#/components/responses/Conflict'
851 '422':
852 $ref: '#/components/responses/UnprocessableEntity'
853 '500':
854 $ref: '#/components/responses/InternalServerError'
855 '503':
856 $ref: '#/components/responses/ServiceUnavailable'
857 '5XX':
858 $ref: '#/components/responses/UnexpectedError'
859 default:
860 $ref: '#/components/responses/UnexpectedError'
861 '/nsd/v1/ns_config_template/{nsconfigTemplateId}/template_content':
862 parameters:
863 - name: nsconfigTemplateId
864 in: path
865 required: true
866 description: Ns config template ID
867 schema:
868 type: string
869 get:
870 tags:
871 - "Ns packages"
872 summary: Fetch the content of a Ns config template
873 description: Fetch the content of a Ns config template
874 operationId: getTemplatecontent
875 responses:
876 '200':
877 description: OK
878 content:
879 application/json:
880 schema:
881 $ref: '#/components/schemas/NsConfigTemplateInfo'
882 application/yaml:
883 schema:
884 $ref: '#/components/schemas/NsConfigTemplateInfo'
885 '206':
886 description: Partial Content
887 headers:
888 Content-Range:
889 schema:
890 type: string
891 content:
892 application/json:
893 schema:
894 $ref: '#/components/schemas/NsConfigTemplateInfo'
895 application/yaml:
896 schema:
897 $ref: '#/components/schemas/NsConfigTemplateInfo'
898 '400':
899 $ref: '#/components/responses/BadRequest'
900 '401':
901 $ref: '#/components/responses/Unauthorized'
902 '403':
903 $ref: '#/components/responses/Forbidden'
904 '404':
905 $ref: '#/components/responses/NotFound'
906 '405':
907 $ref: '#/components/responses/MethodNotAllowed'
908 '406':
909 $ref: '#/components/responses/NotAcceptable'
910 '409':
911 $ref: '#/components/responses/Conflict'
912 '422':
913 $ref: '#/components/responses/UnprocessableEntity'
914 '500':
915 $ref: '#/components/responses/InternalServerError'
916 '503':
917 $ref: '#/components/responses/ServiceUnavailable'
918 '5XX':
919 $ref: '#/components/responses/UnexpectedError'
920 default:
921 $ref: '#/components/responses/UnexpectedError'
922 put:
923 tags:
924 - "Ns packages"
925 summary: Modify the content of a Ns config template
926 description: |
927 Template name and instantiation parameters
928 can be modified.
929 operationId: updateTemplatecontent
930 requestBody:
931 $ref: '#/components/requestBodies/NsConfigTemplateInfoModifications'
932 responses:
933 '202':
934 description: Accepted
935 '204':
936 description: No Content
937 '400':
938 $ref: '#/components/responses/BadRequest'
939 '401':
940 $ref: '#/components/responses/Unauthorized'
941 '403':
942 $ref: '#/components/responses/Forbidden'
943 '404':
944 $ref: '#/components/responses/NotFound'
945 '405':
946 $ref: '#/components/responses/MethodNotAllowed'
947 '406':
948 $ref: '#/components/responses/NotAcceptable'
949 '409':
950 $ref: '#/components/responses/Conflict'
951 '422':
952 $ref: '#/components/responses/UnprocessableEntity'
953 '500':
954 $ref: '#/components/responses/InternalServerError'
955 '503':
956 $ref: '#/components/responses/ServiceUnavailable'
957 '5XX':
958 $ref: '#/components/responses/UnexpectedError'
959 default:
960 $ref: '#/components/responses/UnexpectedError'
961# END Ns Config Templates
962
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]963# BEGIN VNF Packages
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]964 '/vnfpkgm/v1/vnf_packages':
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]965 get:
966 tags:
967 - "VNF packages"
968 summary: Query information about multiple VNF package resources
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]969 description: Query information about multiple VNF package resources
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]970 operationId: getVnfPkgs
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]971 responses:
972 '200':
973 description: OK
974 content:
975 application/json:
976 schema:
977 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
978 application/yaml:
979 schema:
980 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
981 '400':
982 $ref: '#/components/responses/BadRequest'
983 '401':
984 $ref: '#/components/responses/Unauthorized'
985 '403':
986 $ref: '#/components/responses/Forbidden'
987 '404':
988 $ref: '#/components/responses/NotFound'
989 '405':
990 $ref: '#/components/responses/MethodNotAllowed'
991 '406':
992 $ref: '#/components/responses/NotAcceptable'
993 '409':
994 $ref: '#/components/responses/Conflict'
995 '422':
996 $ref: '#/components/responses/UnprocessableEntity'
997 '500':
998 $ref: '#/components/responses/InternalServerError'
999 '503':
1000 $ref: '#/components/responses/ServiceUnavailable'
1001 '5XX':
1002 $ref: '#/components/responses/UnexpectedError'
1003 default:
1004 $ref: '#/components/responses/UnexpectedError'
1005 post:
1006 tags:
1007 - "VNF packages"
1008 summary: Create a new VNF package resource
1009 description: Create a new VNF package resource
1010 operationId: addVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1011 requestBody:
1012 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
1013 responses:
1014 '201':
1015 description: Created
1016 headers:
1017 Location:
1018 schema:
1019 type: string
1020 format: uri
1021 content:
1022 application/json:
1023 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1024 $ref: '#/components/schemas/ObjectId'
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1025 application/yaml:
1026 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1027 $ref: '#/components/schemas/ObjectId'
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1028 '400':
1029 $ref: '#/components/responses/BadRequest'
1030 '401':
1031 $ref: '#/components/responses/Unauthorized'
1032 '403':
1033 $ref: '#/components/responses/Forbidden'
1034 '404':
1035 $ref: '#/components/responses/NotFound'
1036 '405':
1037 $ref: '#/components/responses/MethodNotAllowed'
1038 '406':
1039 $ref: '#/components/responses/NotAcceptable'
1040 '409':
1041 $ref: '#/components/responses/Conflict'
1042 '422':
1043 $ref: '#/components/responses/UnprocessableEntity'
1044 '500':
1045 $ref: '#/components/responses/InternalServerError'
1046 '503':
1047 $ref: '#/components/responses/ServiceUnavailable'
1048 '5XX':
1049 $ref: '#/components/responses/UnexpectedError'
1050 default:
1051 $ref: '#/components/responses/UnexpectedError'
1052 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1053 parameters:
1054 - name: vnfPkgId
1055 in: path
1056 required: true
1057 description: VNF Package ID
1058 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1059 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1060 get:
1061 tags:
1062 - "VNF packages"
1063 summary: Read information about an individual VNF package resource
1064 description: Read information about an individual VNF package resource
1065 operationId: getVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1066 responses:
1067 '200':
1068 description: OK
1069 content:
1070 application/json:
1071 schema:
1072 $ref: '#/components/schemas/VnfPkgInfo'
1073 application/yaml:
1074 schema:
1075 $ref: '#/components/schemas/VnfPkgInfo'
1076 '400':
1077 $ref: '#/components/responses/BadRequest'
1078 '401':
1079 $ref: '#/components/responses/Unauthorized'
1080 '403':
1081 $ref: '#/components/responses/Forbidden'
1082 '404':
1083 $ref: '#/components/responses/NotFound'
1084 '405':
1085 $ref: '#/components/responses/MethodNotAllowed'
1086 '406':
1087 $ref: '#/components/responses/NotAcceptable'
1088 '409':
1089 $ref: '#/components/responses/Conflict'
1090 '422':
1091 $ref: '#/components/responses/UnprocessableEntity'
1092 '500':
1093 $ref: '#/components/responses/InternalServerError'
1094 '503':
1095 $ref: '#/components/responses/ServiceUnavailable'
1096 '5XX':
1097 $ref: '#/components/responses/UnexpectedError'
1098 default:
1099 $ref: '#/components/responses/UnexpectedError'
1100 delete:
1101 tags:
1102 - "VNF packages"
1103 summary: Delete an individual VNF package resource
1104 description: Delete an individual VNF package resource
1105 operationId: deleteVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1106 responses:
1107 '204':
1108 description: No Content
1109 '400':
1110 $ref: '#/components/responses/BadRequest'
1111 '401':
1112 $ref: '#/components/responses/Unauthorized'
1113 '403':
1114 $ref: '#/components/responses/Forbidden'
1115 '404':
1116 $ref: '#/components/responses/NotFound'
1117 '405':
1118 $ref: '#/components/responses/MethodNotAllowed'
1119 '406':
1120 $ref: '#/components/responses/NotAcceptable'
1121 '409':
1122 $ref: '#/components/responses/Conflict'
1123 '422':
1124 $ref: '#/components/responses/UnprocessableEntity'
1125 '500':
1126 $ref: '#/components/responses/InternalServerError'
1127 '503':
1128 $ref: '#/components/responses/ServiceUnavailable'
1129 '5XX':
1130 $ref: '#/components/responses/UnexpectedError'
1131 default:
1132 $ref: '#/components/responses/UnexpectedError'
1133 patch:
1134 tags:
1135 - "VNF packages"
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1136 summary: Modify an individual VNF package resource
1137 description: Modify an individual VNF package resource
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1138 operationId: updateVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1139 requestBody:
1140 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1141 responses:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1142 '204':
1143 description: No Content
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1144 '400':
1145 $ref: '#/components/responses/BadRequest'
1146 '401':
1147 $ref: '#/components/responses/Unauthorized'
1148 '403':
1149 $ref: '#/components/responses/Forbidden'
1150 '404':
1151 $ref: '#/components/responses/NotFound'
1152 '405':
1153 $ref: '#/components/responses/MethodNotAllowed'
1154 '406':
1155 $ref: '#/components/responses/NotAcceptable'
1156 '409':
1157 $ref: '#/components/responses/Conflict'
1158 '422':
1159 $ref: '#/components/responses/UnprocessableEntity'
1160 '500':
1161 $ref: '#/components/responses/InternalServerError'
1162 '503':
1163 $ref: '#/components/responses/ServiceUnavailable'
1164 '5XX':
1165 $ref: '#/components/responses/UnexpectedError'
1166 default:
1167 $ref: '#/components/responses/UnexpectedError'
1168 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1169 parameters:
1170 - name: vnfPkgId
1171 in: path
1172 required: true
1173 description: VNF Package ID
1174 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1175 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1176 get:
1177 tags:
1178 - "VNF packages"
1179 summary: Read VNFD of an on-boarded VNF package
1180 description: Read VNFD of an on-boarded VNF package
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1181 operationId: getVnfPkgVnfd
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1182 responses:
1183 '200':
1184 description: OK
1185 content:
1186 text/plain:
1187 schema:
1188 $ref: '#/components/schemas/VnfDescriptor'
1189 '400':
1190 $ref: '#/components/responses/BadRequest'
1191 '401':
1192 $ref: '#/components/responses/Unauthorized'
1193 '403':
1194 $ref: '#/components/responses/Forbidden'
1195 '404':
1196 $ref: '#/components/responses/NotFound'
1197 '405':
1198 $ref: '#/components/responses/MethodNotAllowed'
1199 '406':
1200 $ref: '#/components/responses/NotAcceptable'
1201 '409':
1202 $ref: '#/components/responses/Conflict'
1203 '422':
1204 $ref: '#/components/responses/UnprocessableEntity'
1205 '500':
1206 $ref: '#/components/responses/InternalServerError'
1207 '503':
1208 $ref: '#/components/responses/ServiceUnavailable'
1209 '5XX':
1210 $ref: '#/components/responses/UnexpectedError'
1211 default:
1212 $ref: '#/components/responses/UnexpectedError'
1213 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1214 parameters:
1215 - name: vnfPkgId
1216 in: path
1217 required: true
1218 description: VNF Package ID
1219 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1220 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1221 get:
1222 tags:
1223 - "VNF packages"
1224 summary: Fetch an on-boarded VNF package
1225 description: Fetch an on-boarded VNF package
1226 operationId: getVnfPkgContent
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1227 responses:
1228 '200':
1229 description: OK
1230 content:
1231 application/zip:
1232 schema:
1233 $ref: '#/components/schemas/VnfPackage'
1234 '206':
1235 description: Partial Content
1236 headers:
1237 Content-Range:
1238 schema:
1239 type: string
1240 content:
1241 application/zip:
1242 schema:
1243 $ref: '#/components/schemas/VnfPackage'
1244 '400':
1245 $ref: '#/components/responses/BadRequest'
1246 '401':
1247 $ref: '#/components/responses/Unauthorized'
1248 '403':
1249 $ref: '#/components/responses/Forbidden'
1250 '404':
1251 $ref: '#/components/responses/NotFound'
1252 '405':
1253 $ref: '#/components/responses/MethodNotAllowed'
1254 '406':
1255 $ref: '#/components/responses/NotAcceptable'
1256 '409':
1257 $ref: '#/components/responses/Conflict'
1258 '422':
1259 $ref: '#/components/responses/UnprocessableEntity'
1260 '500':
1261 $ref: '#/components/responses/InternalServerError'
1262 '503':
1263 $ref: '#/components/responses/ServiceUnavailable'
1264 '5XX':
1265 $ref: '#/components/responses/UnexpectedError'
1266 default:
1267 $ref: '#/components/responses/UnexpectedError'
1268 put:
1269 tags:
1270 - "VNF packages"
1271 summary: Upload a VNF package by providing the content of the VNF package
1272 description: Upload a VNF package by providing the content of the VNF package
1273 operationId: uploadVnfPkgContent
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1274 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1275 content:
1276 application/zip:
1277 schema:
1278 $ref: '#/components/schemas/VnfPackage'
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1279 responses:
1280 '202':
1281 description: Accepted
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1282 '204':
1283 description: No Content
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1284 '400':
1285 $ref: '#/components/responses/BadRequest'
1286 '401':
1287 $ref: '#/components/responses/Unauthorized'
1288 '403':
1289 $ref: '#/components/responses/Forbidden'
1290 '404':
1291 $ref: '#/components/responses/NotFound'
1292 '405':
1293 $ref: '#/components/responses/MethodNotAllowed'
1294 '406':
1295 $ref: '#/components/responses/NotAcceptable'
1296 '409':
1297 $ref: '#/components/responses/Conflict'
1298 '422':
1299 $ref: '#/components/responses/UnprocessableEntity'
1300 '500':
1301 $ref: '#/components/responses/InternalServerError'
1302 '503':
1303 $ref: '#/components/responses/ServiceUnavailable'
1304 '5XX':
1305 $ref: '#/components/responses/UnexpectedError'
1306 default:
1307 $ref: '#/components/responses/UnexpectedError'
1308 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1309 parameters:
1310 - name: vnfPkgId
1311 in: path
1312 required: true
1313 description: VNF Package ID
1314 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1315 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1316 - name: artifactPath
1317 in: path
1318 required: true
1319 description: Artifact Path
1320 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1321 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1322 get:
1323 tags:
1324 - "VNF packages"
1325 summary: Fetch individual VNF package artifact
1326 description: Fetch individual VNF package artifact
1327 operationId: getVnfPkgArtifact
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]1328 responses:
1329 '200':
1330 description: OK
1331 content:
1332 application/octet-stream:
1333 schema:
1334 type: string
1335 format: binary
1336 '206':
1337 description: Partial Content
1338 headers:
1339 Content-Range:
1340 schema:
1341 type: string
1342 content:
1343 application/octet-stream:
1344 schema:
1345 type: string
1346 format: binary
1347 '400':
1348 $ref: '#/components/responses/BadRequest'
1349 '401':
1350 $ref: '#/components/responses/Unauthorized'
1351 '403':
1352 $ref: '#/components/responses/Forbidden'
1353 '404':
1354 $ref: '#/components/responses/NotFound'
1355 '405':
1356 $ref: '#/components/responses/MethodNotAllowed'
1357 '406':
1358 $ref: '#/components/responses/NotAcceptable'
1359 '409':
1360 $ref: '#/components/responses/Conflict'
1361 '422':
1362 $ref: '#/components/responses/UnprocessableEntity'
1363 '500':
1364 $ref: '#/components/responses/InternalServerError'
1365 '503':
1366 $ref: '#/components/responses/ServiceUnavailable'
1367 '5XX':
1368 $ref: '#/components/responses/UnexpectedError'
1369 default:
1370 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1371 '/vnfpkgm/v1/vnf_packages_content':
1372 post:
1373 tags:
1374 - "VNF packages"
1375 summary: Upload a VNF package by providing the content of the VNF package
1376 description: Upload a VNF package by providing the content of the VNF package
1377 operationId: uploadVnfPkgsContent
1378 requestBody:
1379 content:
1380 application/zip:
1381 schema:
1382 $ref: '#/components/schemas/VnfPackage'
1383 responses:
1384 '201':
1385 description: Created
1386 headers:
1387 Location:
1388 schema:
1389 type: string
1390 format: uri
1391 content:
1392 application/json:
1393 schema:
1394 $ref: '#/components/schemas/ObjectId'
1395 application/yaml:
1396 schema:
1397 $ref: '#/components/schemas/ObjectId'
1398 '202':
1399 description: Accepted
1400 '204':
1401 description: No Content
1402 '400':
1403 $ref: '#/components/responses/BadRequest'
1404 '401':
1405 $ref: '#/components/responses/Unauthorized'
1406 '403':
1407 $ref: '#/components/responses/Forbidden'
1408 '404':
1409 $ref: '#/components/responses/NotFound'
1410 '405':
1411 $ref: '#/components/responses/MethodNotAllowed'
1412 '406':
1413 $ref: '#/components/responses/NotAcceptable'
1414 '409':
1415 $ref: '#/components/responses/Conflict'
1416 '422':
1417 $ref: '#/components/responses/UnprocessableEntity'
1418 '500':
1419 $ref: '#/components/responses/InternalServerError'
1420 '503':
1421 $ref: '#/components/responses/ServiceUnavailable'
1422 '5XX':
1423 $ref: '#/components/responses/UnexpectedError'
1424 default:
1425 $ref: '#/components/responses/UnexpectedError'
1426 get:
1427 tags:
1428 - "VNF packages"
1429 summary: Query information about multiple VNF package resources
1430 description: Query information about multiple VNF package resources
1431 operationId: getVnfPkgsContent
1432 responses:
1433 '200':
1434 description: OK
1435 content:
1436 application/json:
1437 schema:
1438 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1439 application/yaml:
1440 schema:
1441 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1442 '206':
1443 description: Partial Content
1444 headers:
1445 Content-Range:
1446 schema:
1447 type: string
1448 content:
1449 application/octet-stream:
1450 schema:
1451 type: string
1452 format: binary
1453 '400':
1454 $ref: '#/components/responses/BadRequest'
1455 '401':
1456 $ref: '#/components/responses/Unauthorized'
1457 '403':
1458 $ref: '#/components/responses/Forbidden'
1459 '404':
1460 $ref: '#/components/responses/NotFound'
1461 '405':
1462 $ref: '#/components/responses/MethodNotAllowed'
1463 '406':
1464 $ref: '#/components/responses/NotAcceptable'
1465 '409':
1466 $ref: '#/components/responses/Conflict'
1467 '422':
1468 $ref: '#/components/responses/UnprocessableEntity'
1469 '500':
1470 $ref: '#/components/responses/InternalServerError'
1471 '503':
1472 $ref: '#/components/responses/ServiceUnavailable'
1473 '5XX':
1474 $ref: '#/components/responses/UnexpectedError'
1475 default:
1476 $ref: '#/components/responses/UnexpectedError'
1477 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1478 parameters:
1479 - name: packageContentId
1480 in: path
1481 required: true
1482 description: VNF Package Content ID
1483 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1484 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1485 get:
1486 tags:
1487 - "VNF packages"
1488 summary: Read information about an individual VNF package resource
1489 description: Read information about an individual VNF package resource
1490 operationId: getVnfPkgsIdContent
1491 responses:
1492 '200':
1493 description: OK
1494 content:
1495 application/json:
1496 schema:
1497 $ref: '#/components/schemas/VnfPkgInfo'
1498 application/yaml:
1499 schema:
1500 $ref: '#/components/schemas/VnfPkgInfo'
1501 '400':
1502 $ref: '#/components/responses/BadRequest'
1503 '401':
1504 $ref: '#/components/responses/Unauthorized'
1505 '403':
1506 $ref: '#/components/responses/Forbidden'
1507 '404':
1508 $ref: '#/components/responses/NotFound'
1509 '405':
1510 $ref: '#/components/responses/MethodNotAllowed'
1511 '406':
1512 $ref: '#/components/responses/NotAcceptable'
1513 '409':
1514 $ref: '#/components/responses/Conflict'
1515 '422':
1516 $ref: '#/components/responses/UnprocessableEntity'
1517 '500':
1518 $ref: '#/components/responses/InternalServerError'
1519 '503':
1520 $ref: '#/components/responses/ServiceUnavailable'
1521 '5XX':
1522 $ref: '#/components/responses/UnexpectedError'
1523 default:
1524 $ref: '#/components/responses/UnexpectedError'
1525 put:
1526 tags:
1527 - "VNF packages"
1528 summary: Modify an individual VNF package resource
1529 description: Modify an individual VNF package resource
1530 operationId: updateVnfPkgsIdContent
1531 requestBody:
1532 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1533 responses:
1534 '204':
1535 description: No Content
1536 '400':
1537 $ref: '#/components/responses/BadRequest'
1538 '401':
1539 $ref: '#/components/responses/Unauthorized'
1540 '403':
1541 $ref: '#/components/responses/Forbidden'
1542 '404':
1543 $ref: '#/components/responses/NotFound'
1544 '405':
1545 $ref: '#/components/responses/MethodNotAllowed'
1546 '406':
1547 $ref: '#/components/responses/NotAcceptable'
1548 '409':
1549 $ref: '#/components/responses/Conflict'
1550 '422':
1551 $ref: '#/components/responses/UnprocessableEntity'
1552 '500':
1553 $ref: '#/components/responses/InternalServerError'
1554 '503':
1555 $ref: '#/components/responses/ServiceUnavailable'
1556 '5XX':
1557 $ref: '#/components/responses/UnexpectedError'
1558 default:
1559 $ref: '#/components/responses/UnexpectedError'
1560 delete:
1561 tags:
1562 - "VNF packages"
1563 summary: Delete an individual VNF package resource
1564 description: Delete an individual VNF package resource
1565 operationId: deleteVnfPkgsIdContent
1566 responses:
1567 '204':
1568 description: No Content
1569 '400':
1570 $ref: '#/components/responses/BadRequest'
1571 '401':
1572 $ref: '#/components/responses/Unauthorized'
1573 '403':
1574 $ref: '#/components/responses/Forbidden'
1575 '404':
1576 $ref: '#/components/responses/NotFound'
1577 '405':
1578 $ref: '#/components/responses/MethodNotAllowed'
1579 '406':
1580 $ref: '#/components/responses/NotAcceptable'
1581 '409':
1582 $ref: '#/components/responses/Conflict'
1583 '422':
1584 $ref: '#/components/responses/UnprocessableEntity'
1585 '500':
1586 $ref: '#/components/responses/InternalServerError'
1587 '503':
1588 $ref: '#/components/responses/ServiceUnavailable'
1589 '5XX':
1590 $ref: '#/components/responses/UnexpectedError'
1591 default:
1592 $ref: '#/components/responses/UnexpectedError'
1593# END VNF Packages
1594
1595# BEGIN NS Instances
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1596 '/nslcm/v1/ns_instances':
1597 get:
1598 tags:
1599 - "NS instances"
1600 summary: Query information about multiple NS instances
1601 description: Query information about multiple NS isntances
1602 operationId: getNSinstances
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1603 responses:
1604 '200':
1605 description: OK
1606 content:
1607 application/json:
1608 schema:
1609 $ref: '#/components/schemas/ArrayOfNsInstance'
1610 application/yaml:
1611 schema:
1612 $ref: '#/components/schemas/ArrayOfNsInstance'
1613 '400':
1614 $ref: '#/components/responses/BadRequest'
1615 '401':
1616 $ref: '#/components/responses/Unauthorized'
1617 '403':
1618 $ref: '#/components/responses/Forbidden'
1619 '404':
1620 $ref: '#/components/responses/NotFound'
1621 '405':
1622 $ref: '#/components/responses/MethodNotAllowed'
1623 '406':
1624 $ref: '#/components/responses/NotAcceptable'
1625 '409':
1626 $ref: '#/components/responses/Conflict'
1627 '422':
1628 $ref: '#/components/responses/UnprocessableEntity'
1629 '500':
1630 $ref: '#/components/responses/InternalServerError'
1631 '503':
1632 $ref: '#/components/responses/ServiceUnavailable'
1633 '5XX':
1634 $ref: '#/components/responses/UnexpectedError'
1635 default:
1636 $ref: '#/components/responses/UnexpectedError'
1637 post:
1638 tags:
1639 - "NS instances"
1640 summary: Create a new NS instance resource
1641 description: Create a new NS instance resource
1642 operationId: addNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1643 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1644 $ref: '#/components/requestBodies/InstantiateNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1645 responses:
1646 '201':
1647 description: Created
1648 headers:
1649 Location:
1650 schema:
1651 type: string
1652 format: uri
1653 content:
1654 application/json:
1655 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1656 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1657 application/yaml:
1658 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1659 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1660 '400':
1661 $ref: '#/components/responses/BadRequest'
1662 '401':
1663 $ref: '#/components/responses/Unauthorized'
1664 '403':
1665 $ref: '#/components/responses/Forbidden'
1666 '404':
1667 $ref: '#/components/responses/NotFound'
1668 '405':
1669 $ref: '#/components/responses/MethodNotAllowed'
1670 '406':
1671 $ref: '#/components/responses/NotAcceptable'
1672 '409':
1673 $ref: '#/components/responses/Conflict'
1674 '422':
1675 $ref: '#/components/responses/UnprocessableEntity'
1676 '500':
1677 $ref: '#/components/responses/InternalServerError'
1678 '503':
1679 $ref: '#/components/responses/ServiceUnavailable'
1680 '5XX':
1681 $ref: '#/components/responses/UnexpectedError'
1682 default:
1683 $ref: '#/components/responses/UnexpectedError'
1684 '/nslcm/v1/ns_instances/{nsInstanceId}':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1685 parameters:
1686 - name: nsInstanceId
1687 in: path
1688 required: true
1689 description: NS Instance ID
1690 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1691 type: string
ksaikiranr6400ff72021-04-07 14:19:50 +0530[diff] [blame]1692 - name: vcaStatusRefresh
1693 in: query
1694 required: false
1695 description: Set to true if vca status needs to be refreshed.
1696 schema:
1697 type: boolean
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1698 get:
1699 tags:
1700 - "NS instances"
1701 summary: Read an individual NS instance resource
1702 description: Read an individual NS instance resource
1703 operationId: getNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1704 responses:
1705 '200':
1706 description: OK
1707 content:
1708 application/json:
1709 schema:
1710 $ref: '#/components/schemas/NsInstance'
1711 application/yaml:
1712 schema:
1713 $ref: '#/components/schemas/NsInstance'
1714 '400':
1715 $ref: '#/components/responses/BadRequest'
1716 '401':
1717 $ref: '#/components/responses/Unauthorized'
1718 '403':
1719 $ref: '#/components/responses/Forbidden'
1720 '404':
1721 $ref: '#/components/responses/NotFound'
1722 '405':
1723 $ref: '#/components/responses/MethodNotAllowed'
1724 '406':
1725 $ref: '#/components/responses/NotAcceptable'
1726 '409':
1727 $ref: '#/components/responses/Conflict'
1728 '422':
1729 $ref: '#/components/responses/UnprocessableEntity'
1730 '500':
1731 $ref: '#/components/responses/InternalServerError'
1732 '503':
1733 $ref: '#/components/responses/ServiceUnavailable'
1734 '5XX':
1735 $ref: '#/components/responses/UnexpectedError'
1736 default:
1737 $ref: '#/components/responses/UnexpectedError'
1738 delete:
1739 tags:
1740 - "NS instances"
1741 summary: Delete an individual NS instance resource
1742 description: Delete an individual NS instance resource
1743 operationId: deleteNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1744 responses:
1745 '204':
1746 description: No Content
1747 '400':
1748 $ref: '#/components/responses/BadRequest'
1749 '401':
1750 $ref: '#/components/responses/Unauthorized'
1751 '403':
1752 $ref: '#/components/responses/Forbidden'
1753 '404':
1754 $ref: '#/components/responses/NotFound'
1755 '405':
1756 $ref: '#/components/responses/MethodNotAllowed'
1757 '406':
1758 $ref: '#/components/responses/NotAcceptable'
1759 '409':
1760 $ref: '#/components/responses/Conflict'
1761 '422':
1762 $ref: '#/components/responses/UnprocessableEntity'
1763 '500':
1764 $ref: '#/components/responses/InternalServerError'
1765 '503':
1766 $ref: '#/components/responses/ServiceUnavailable'
1767 '5XX':
1768 $ref: '#/components/responses/UnexpectedError'
1769 default:
1770 $ref: '#/components/responses/UnexpectedError'
1771 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1772 parameters:
1773 - name: nsInstanceId
1774 in: path
1775 required: true
1776 description: NS Instance ID
1777 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1778 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1779 post:
1780 tags:
1781 - "NS instances"
1782 summary: Instantiate a NS
1783 description: |
1784 Instantiate a NS. The precondition is that the NS instance must have
1785 been created and must be in NOT_INSTANTIATED state. As a result of the
1786 success of this operation, the NFVO creates a "NS Lifecycle Operation
1787 Occurrence" resource for the request, and the NS instance state becomes
1788 INSTANTIATED.
1789 operationId: instantiateNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1790 requestBody:
1791 $ref: '#/components/requestBodies/InstantiateNsRequest'
1792 responses:
1793 '202':
1794 description: Accepted
1795 headers:
1796 Location:
1797 description: |
1798 It must point to the new "NS Lifecycle Operation Occurrence"
1799 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1800 schema:
1801 type: string
1802 format: uri
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1803 content:
1804 application/json:
1805 schema:
1806 $ref: '#/components/schemas/ObjectId'
1807 application/yaml:
1808 schema:
1809 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1810 '400':
1811 $ref: '#/components/responses/BadRequest'
1812 '401':
1813 $ref: '#/components/responses/Unauthorized'
1814 '403':
1815 $ref: '#/components/responses/Forbidden'
1816 '404':
1817 $ref: '#/components/responses/NotFound'
1818 '405':
1819 $ref: '#/components/responses/MethodNotAllowed'
1820 '406':
1821 $ref: '#/components/responses/NotAcceptable'
1822 '409':
1823 $ref: '#/components/responses/Conflict'
1824 '422':
1825 $ref: '#/components/responses/UnprocessableEntity'
1826 '500':
1827 $ref: '#/components/responses/InternalServerError'
1828 '503':
1829 $ref: '#/components/responses/ServiceUnavailable'
1830 '5XX':
1831 $ref: '#/components/responses/UnexpectedError'
1832 default:
1833 $ref: '#/components/responses/UnexpectedError'
1834 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]1835 parameters:
1836 - name: nsInstanceId
1837 in: path
1838 required: true
1839 description: NS Instance ID
1840 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]1841 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1842 post:
1843 tags:
1844 - "NS instances"
1845 summary: Scale a NS instance
1846 description: |
1847 Scale a NS instance. The precondition is that the NS instance must have
1848 been created and must be in INSTANTIATED state. As a result of the
1849 success of this operation, the NFVO creates a "NS Lifecycle Operation
1850 Occurrence" resource for the request, and the NS instance state remains
1851 INSTANTIATED.
1852 operationId: scaleNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]1853 requestBody:
1854 $ref: '#/components/requestBodies/ScaleNsRequest'
1855 responses:
1856 '202':
1857 description: Accepted
1858 headers:
1859 Location:
1860 description: |
1861 It must point to the new "NS Lifecycle Operation Occurrence"
1862 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1863 schema:
1864 type: string
1865 format: uri
1866 '400':
1867 $ref: '#/components/responses/BadRequest'
1868 '401':
1869 $ref: '#/components/responses/Unauthorized'
1870 '403':
1871 $ref: '#/components/responses/Forbidden'
1872 '404':
1873 $ref: '#/components/responses/NotFound'
1874 '405':
1875 $ref: '#/components/responses/MethodNotAllowed'
1876 '406':
1877 $ref: '#/components/responses/NotAcceptable'
1878 '409':
1879 $ref: '#/components/responses/Conflict'
1880 '422':
1881 $ref: '#/components/responses/UnprocessableEntity'
1882 '500':
1883 $ref: '#/components/responses/InternalServerError'
1884 '503':
1885 $ref: '#/components/responses/ServiceUnavailable'
1886 '5XX':
1887 $ref: '#/components/responses/UnexpectedError'
1888 default:
1889 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +0100[diff] [blame]1890 '/nslcm/v1/ns_instances/{nsInstanceId}/heal':
1891 parameters:
1892 - name: nsInstanceId
1893 in: path
1894 required: true
1895 description: NS Instance ID
1896 schema:
1897 type: string
1898 post:
1899 tags:
1900 - "NS instances"
1901 summary: Heal a NS instance
1902 description: |
1903 Heal a NS instance. The precondition is that the NS instance must have
1904 been created and must be in INSTANTIATED state. As a result of the
1905 success of this operation, the NFVO creates a "NS Lifecycle Operation
1906 Occurrence" resource for the request, and the NS instance state remains
1907 INSTANTIATED.
1908 operationId: healNSinstance
1909 requestBody:
1910 $ref: '#/components/requestBodies/HealNsRequest'
1911 responses:
1912 '202':
1913 description: Accepted
1914 headers:
1915 Location:
1916 description: |
1917 It must point to the new "NS Lifecycle Operation Occurrence"
1918 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1919 schema:
1920 type: string
1921 format: uri
1922 '400':
1923 $ref: '#/components/responses/BadRequest'
1924 '401':
1925 $ref: '#/components/responses/Unauthorized'
1926 '403':
1927 $ref: '#/components/responses/Forbidden'
1928 '404':
1929 $ref: '#/components/responses/NotFound'
1930 '405':
1931 $ref: '#/components/responses/MethodNotAllowed'
1932 '406':
1933 $ref: '#/components/responses/NotAcceptable'
1934 '409':
1935 $ref: '#/components/responses/Conflict'
1936 '422':
1937 $ref: '#/components/responses/UnprocessableEntity'
1938 '500':
1939 $ref: '#/components/responses/InternalServerError'
1940 '503':
1941 $ref: '#/components/responses/ServiceUnavailable'
1942 '5XX':
1943 $ref: '#/components/responses/UnexpectedError'
1944 default:
1945 $ref: '#/components/responses/UnexpectedError'
elumalai4b120f12022-04-28 16:44:35 +0530[diff] [blame]1946 '/nslcm/v1/ns_instances/{nsInstanceId}/migrate':
1947 parameters:
1948 - name: nsInstanceId
1949 in: path
1950 required: true
1951 description: NS Instance ID
1952 schema:
1953 type: string
1954 post:
1955 tags:
1956 - "NS instances"
1957 summary: Migrate VNFs in a NS instance
1958 description: |
1959 Migrate the VNFs and VDUs in a NS instance. The precondition is
1960 that the NS instance must have been created and must be in
1961 INSTANTIATED state. As a result of the success of this operation,
1962 the NFVO creates a "NS Lifecycle Operation Occurrence" resource
1963 for the request, and the NS instance state remains INSTANTIATED.
1964 operationId: migrateNSinstance
1965 requestBody:
1966 $ref: '#/components/requestBodies/NSinstanceMigrateRequest'
1967 responses:
1968 '202':
1969 description: Accepted
1970 headers:
1971 Location:
1972 description: |
1973 It must point to the new "NS Lifecycle Operation Occurrence"
1974 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1975 schema:
1976 type: string
1977 format: uri
1978 '400':
1979 $ref: '#/components/responses/BadRequest'
1980 '401':
1981 $ref: '#/components/responses/Unauthorized'
1982 '403':
1983 $ref: '#/components/responses/Forbidden'
1984 '404':
1985 $ref: '#/components/responses/NotFound'
1986 '405':
1987 $ref: '#/components/responses/MethodNotAllowed'
1988 '406':
1989 $ref: '#/components/responses/NotAcceptable'
1990 '409':
1991 $ref: '#/components/responses/Conflict'
1992 '422':
1993 $ref: '#/components/responses/UnprocessableEntity'
1994 '500':
1995 $ref: '#/components/responses/InternalServerError'
1996 '503':
1997 $ref: '#/components/responses/ServiceUnavailable'
1998 '5XX':
1999 $ref: '#/components/responses/UnexpectedError'
2000 default:
2001 $ref: '#/components/responses/UnexpectedError'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]2002 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2003 parameters:
2004 - name: nsInstanceId
2005 in: path
2006 required: true
2007 description: NS Instance ID
2008 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]2009 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]2010 post:
2011 tags:
2012 - "NS instances"
2013 summary: Terminate a NS instance
2014 description: |
2015 Terminate a NS instance. The precondition is that the NS instance must have
2016 been created and must be in INSTANTIATED state. As a result of the
2017 success of this operation, the NFVO creates a "NS Lifecycle Operation
2018 Occurrence" resource for the request, and the NS instance state becomes
2019 NOT_INSTANTIATED.
2020 operationId: terminateNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]2021 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2022 # Request data is not required
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]2023 $ref: '#/components/requestBodies/TerminateNsRequest'
2024 responses:
2025 '202':
2026 description: Accepted
2027 headers:
2028 Location:
2029 description: |
2030 It must point to the new "NS Lifecycle Operation Occurrence"
2031 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
2032 schema:
2033 type: string
2034 format: uri
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2035 content:
2036 application/json:
2037 schema:
2038 $ref: '#/components/schemas/ObjectId'
2039 application/yaml:
2040 schema:
2041 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]2042 '400':
2043 $ref: '#/components/responses/BadRequest'
2044 '401':
2045 $ref: '#/components/responses/Unauthorized'
2046 '403':
2047 $ref: '#/components/responses/Forbidden'
2048 '404':
2049 $ref: '#/components/responses/NotFound'
2050 '405':
2051 $ref: '#/components/responses/MethodNotAllowed'
2052 '406':
2053 $ref: '#/components/responses/NotAcceptable'
2054 '409':
2055 $ref: '#/components/responses/Conflict'
2056 '422':
2057 $ref: '#/components/responses/UnprocessableEntity'
2058 '500':
2059 $ref: '#/components/responses/InternalServerError'
2060 '503':
2061 $ref: '#/components/responses/ServiceUnavailable'
2062 '5XX':
2063 $ref: '#/components/responses/UnexpectedError'
2064 default:
2065 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2066 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
2067 parameters:
2068 - name: nsInstanceId
2069 in: path
2070 required: true
2071 description: NS Instance ID
2072 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]2073 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2074 post:
2075 tags:
2076 - "NS instances"
2077 summary: Execute an action on a NS instance
2078 description: |
2079 Execute an action on a NS instance.
2080 The NS instance must have been created and must be in INSTANTIATED state.
2081 operationId: actionOnNSinstance
2082 requestBody:
2083 content:
2084 application/json:
2085 schema:
2086 $ref: '#/components/schemas/NSinstanceActionRequest'
2087 application/yaml:
2088 schema:
2089 $ref: '#/components/schemas/NSinstanceActionRequest'
2090 responses:
2091 '202':
2092 description: Accepted
2093 headers:
2094 Location:
2095 description: |
2096 It must point to the new "NS Lifecycle Operation Occurrence"
2097 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
2098 schema:
2099 type: string
2100 format: uri
2101 content:
2102 application/json:
2103 schema:
2104 $ref: '#/components/schemas/ObjectId'
2105 application/yaml:
2106 schema:
2107 $ref: '#/components/schemas/ObjectId'
2108 '400':
2109 $ref: '#/components/responses/BadRequest'
2110 '401':
2111 $ref: '#/components/responses/Unauthorized'
2112 '403':
2113 $ref: '#/components/responses/Forbidden'
2114 '404':
2115 $ref: '#/components/responses/NotFound'
2116 '405':
2117 $ref: '#/components/responses/MethodNotAllowed'
2118 '406':
2119 $ref: '#/components/responses/NotAcceptable'
2120 '409':
2121 $ref: '#/components/responses/Conflict'
2122 '422':
2123 $ref: '#/components/responses/UnprocessableEntity'
2124 '500':
2125 $ref: '#/components/responses/InternalServerError'
2126 '503':
2127 $ref: '#/components/responses/ServiceUnavailable'
2128 '5XX':
2129 $ref: '#/components/responses/UnexpectedError'
2130 default:
2131 $ref: '#/components/responses/UnexpectedError'
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]2132 '/nslcm/v1/ns_instances/{nsInstanceId}/update':
2133 parameters:
2134 - name: nsInstanceId
2135 in: path
2136 required: true
2137 description: NS Instance ID
2138 schema:
2139 type: string
2140 post:
2141 tags:
2142 - "NS instances"
2143 summary: Update a NS instance
2144 description: |
2145 Update a NS instance. The precondition is that the NS instance must have
2146 been created and must be in INSTANTIATED state. As a result of the
2147 success of this operation, the NFVO creates a "NS Lifecycle Operation
2148 Occurrence" resource for the request, and the NS instance state remains
2149 INSTANTIATED.
2150 operationId: updateNSinstance
2151 requestBody:
2152 $ref: '#/components/requestBodies/UpdateNsRequest'
2153 responses:
2154 '202':
2155 description: Accepted
2156 headers:
2157 Location:
2158 description: |
2159 It must point to the new "NS Lifecycle Operation Occurrence"
2160 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
2161 schema:
2162 type: string
2163 format: uri
2164 '400':
2165 $ref: '#/components/responses/BadRequest'
2166 '401':
2167 $ref: '#/components/responses/Unauthorized'
2168 '403':
2169 $ref: '#/components/responses/Forbidden'
2170 '404':
2171 $ref: '#/components/responses/NotFound'
2172 '405':
2173 $ref: '#/components/responses/MethodNotAllowed'
2174 '406':
2175 $ref: '#/components/responses/NotAcceptable'
2176 '409':
2177 $ref: '#/components/responses/Conflict'
2178 '422':
2179 $ref: '#/components/responses/UnprocessableEntity'
2180 '500':
2181 $ref: '#/components/responses/InternalServerError'
2182 '503':
2183 $ref: '#/components/responses/ServiceUnavailable'
2184 '5XX':
2185 $ref: '#/components/responses/UnexpectedError'
2186 default:
2187 $ref: '#/components/responses/UnexpectedError'
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]2188 '/nslcm/v1/ns_instances_terminate':
2189 post:
2190 tags:
2191 - "NS instances"
2192 summary: Terminates NS instances
2193 description: Terminates multiple NS instances.
2194 operationId: MultiNsTerminateRequest
2195 requestBody:
2196 $ref: '#/components/requestBodies/MultiNsTerminateRequest'
2197 responses:
2198 '202':
2199 description: Accepted
2200 content:
2201 application/json:
2202 schema:
2203 $ref: '#/components/schemas/ObjectIdList'
2204 application/yaml:
2205 schema:
2206 $ref: '#/components/schemas/ObjectIdList'
2207 '400':
2208 $ref: '#/components/responses/BadRequest'
2209 '401':
2210 $ref: '#/components/responses/Unauthorized'
2211 '403':
2212 $ref: '#/components/responses/Forbidden'
2213 '404':
2214 $ref: '#/components/responses/NotFound'
2215 '405':
2216 $ref: '#/components/responses/MethodNotAllowed'
2217 '406':
2218 $ref: '#/components/responses/NotAcceptable'
2219 '409':
2220 $ref: '#/components/responses/Conflict'
2221 '422':
2222 $ref: '#/components/responses/UnprocessableEntity'
2223 '500':
2224 $ref: '#/components/responses/InternalServerError'
2225 '503':
2226 $ref: '#/components/responses/ServiceUnavailable'
2227 '5XX':
2228 $ref: '#/components/responses/UnexpectedError'
2229 default:
2230 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2231 '/nslcm/v1/ns_instances_content':
2232 get:
2233 tags:
2234 - "NS instances"
2235 summary: Query information about multiple NS instances
2236 description: Query information about multiple NS isntances
2237 operationId: getNSinstancesContent
2238 responses:
2239 '200':
2240 description: OK
2241 content:
2242 application/json:
2243 schema:
2244 $ref: '#/components/schemas/ArrayOfNsInstance'
2245 application/yaml:
2246 schema:
2247 $ref: '#/components/schemas/ArrayOfNsInstance'
2248 '400':
2249 $ref: '#/components/responses/BadRequest'
2250 '401':
2251 $ref: '#/components/responses/Unauthorized'
2252 '403':
2253 $ref: '#/components/responses/Forbidden'
2254 '404':
2255 $ref: '#/components/responses/NotFound'
2256 '405':
2257 $ref: '#/components/responses/MethodNotAllowed'
2258 '406':
2259 $ref: '#/components/responses/NotAcceptable'
2260 '409':
2261 $ref: '#/components/responses/Conflict'
2262 '422':
2263 $ref: '#/components/responses/UnprocessableEntity'
2264 '500':
2265 $ref: '#/components/responses/InternalServerError'
2266 '503':
2267 $ref: '#/components/responses/ServiceUnavailable'
2268 '5XX':
2269 $ref: '#/components/responses/UnexpectedError'
2270 default:
2271 $ref: '#/components/responses/UnexpectedError'
2272 post:
2273 tags:
2274 - "NS instances"
2275 summary: Create a new NS instance
2276 description: Create a new NS instance
2277 operationId: createNSinstanceContent
2278 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]2279 $ref: '#/components/requestBodies/InstantiateNsRequest'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2280 responses:
2281 '201':
2282 description: Created
2283 headers:
2284 Location:
2285 schema:
2286 type: string
2287 format: uri
2288 content:
2289 application/json:
2290 schema:
2291 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2292 application/yaml:
2293 schema:
2294 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2295 '400':
2296 $ref: '#/components/responses/BadRequest'
2297 '401':
2298 $ref: '#/components/responses/Unauthorized'
2299 '403':
2300 $ref: '#/components/responses/Forbidden'
2301 '404':
2302 $ref: '#/components/responses/NotFound'
2303 '405':
2304 $ref: '#/components/responses/MethodNotAllowed'
2305 '406':
2306 $ref: '#/components/responses/NotAcceptable'
2307 '409':
2308 $ref: '#/components/responses/Conflict'
2309 '422':
2310 $ref: '#/components/responses/UnprocessableEntity'
2311 '500':
2312 $ref: '#/components/responses/InternalServerError'
2313 '503':
2314 $ref: '#/components/responses/ServiceUnavailable'
2315 '5XX':
2316 $ref: '#/components/responses/UnexpectedError'
2317 default:
2318 $ref: '#/components/responses/UnexpectedError'
2319 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
2320 parameters:
2321 - name: nsInstanceContentId
2322 in: path
2323 required: true
2324 description: NS Instance Content ID
2325 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]2326 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2327 get:
2328 tags:
2329 - "NS instances"
2330 summary: Read an individual NS instance resource
2331 description: Read an individual NS instance resource
2332 operationId: getNSinstanceContent
2333 responses:
2334 '200':
2335 description: OK
2336 content:
2337 application/json:
2338 schema:
2339 $ref: '#/components/schemas/NsInstance'
2340 application/yaml:
2341 schema:
2342 $ref: '#/components/schemas/NsInstance'
2343 '400':
2344 $ref: '#/components/responses/BadRequest'
2345 '401':
2346 $ref: '#/components/responses/Unauthorized'
2347 '403':
2348 $ref: '#/components/responses/Forbidden'
2349 '404':
2350 $ref: '#/components/responses/NotFound'
2351 '405':
2352 $ref: '#/components/responses/MethodNotAllowed'
2353 '406':
2354 $ref: '#/components/responses/NotAcceptable'
2355 '409':
2356 $ref: '#/components/responses/Conflict'
2357 '422':
2358 $ref: '#/components/responses/UnprocessableEntity'
2359 '500':
2360 $ref: '#/components/responses/InternalServerError'
2361 '503':
2362 $ref: '#/components/responses/ServiceUnavailable'
2363 '5XX':
2364 $ref: '#/components/responses/UnexpectedError'
2365 default:
2366 $ref: '#/components/responses/UnexpectedError'
2367 delete:
2368 tags:
2369 - "NS instances"
2370 summary: Delete an individual NS instance resource
2371 description: Delete an individual NS instance resource
2372 operationId: deleteNSinstanceContent
2373 responses:
2374 '202':
2375 description: Accepted
2376 content:
2377 application/json:
2378 schema:
2379 $ref: '#/components/schemas/ObjectId'
2380 application/yaml:
2381 schema:
2382 $ref: '#/components/schemas/ObjectId'
2383 '204':
2384 description: No Content
2385 '400':
2386 $ref: '#/components/responses/BadRequest'
2387 '401':
2388 $ref: '#/components/responses/Unauthorized'
2389 '403':
2390 $ref: '#/components/responses/Forbidden'
2391 '404':
2392 $ref: '#/components/responses/NotFound'
2393 '405':
2394 $ref: '#/components/responses/MethodNotAllowed'
2395 '406':
2396 $ref: '#/components/responses/NotAcceptable'
2397 '409':
2398 $ref: '#/components/responses/Conflict'
2399 '422':
2400 $ref: '#/components/responses/UnprocessableEntity'
2401 '500':
2402 $ref: '#/components/responses/InternalServerError'
2403 '503':
2404 $ref: '#/components/responses/ServiceUnavailable'
2405 '5XX':
2406 $ref: '#/components/responses/UnexpectedError'
2407 default:
2408 $ref: '#/components/responses/UnexpectedError'
2409 '/nslcm/v1/ns_lcm_op_occs':
2410 get:
2411 tags:
2412 - "NS instances"
2413 summary: Query information about multiple NS LCM Operation Occurrences
2414 description: Query information about multiple NS LCM Operation Occurrences
2415 operationId: getNSLCMOpOccs
2416 responses:
2417 '200':
2418 description: OK
2419 content:
2420 application/json:
2421 schema:
2422 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2423 application/yaml:
2424 schema:
2425 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2426 '400':
2427 $ref: '#/components/responses/BadRequest'
2428 '401':
2429 $ref: '#/components/responses/Unauthorized'
2430 '403':
2431 $ref: '#/components/responses/Forbidden'
2432 '404':
2433 $ref: '#/components/responses/NotFound'
2434 '405':
2435 $ref: '#/components/responses/MethodNotAllowed'
2436 '406':
2437 $ref: '#/components/responses/NotAcceptable'
2438 '409':
2439 $ref: '#/components/responses/Conflict'
2440 '422':
2441 $ref: '#/components/responses/UnprocessableEntity'
2442 '500':
2443 $ref: '#/components/responses/InternalServerError'
2444 '503':
2445 $ref: '#/components/responses/ServiceUnavailable'
2446 '5XX':
2447 $ref: '#/components/responses/UnexpectedError'
2448 default:
2449 $ref: '#/components/responses/UnexpectedError'
2450 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2451 parameters:
2452 - name: nsLcmOpOccId
2453 in: path
2454 required: true
2455 description: NS LCM Operation Occurrence ID
2456 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]2457 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2458 get:
2459 tags:
2460 - "NS instances"
2461 summary: Query information about an individual NS LCM Operation Occurrence
2462 description: Query information about an individual NS LCM Operation Occurrence
2463 operationId: getNSLCMOpOcc
2464 responses:
2465 '200':
2466 description: OK
2467 content:
2468 application/json:
2469 schema:
2470 $ref: '#/components/schemas/NsLcmOpOcc'
2471 application/yaml:
2472 schema:
2473 $ref: '#/components/schemas/NsLcmOpOcc'
2474 '400':
2475 $ref: '#/components/responses/BadRequest'
2476 '401':
2477 $ref: '#/components/responses/Unauthorized'
2478 '403':
2479 $ref: '#/components/responses/Forbidden'
2480 '404':
2481 $ref: '#/components/responses/NotFound'
2482 '405':
2483 $ref: '#/components/responses/MethodNotAllowed'
2484 '406':
2485 $ref: '#/components/responses/NotAcceptable'
2486 '409':
2487 $ref: '#/components/responses/Conflict'
2488 '422':
2489 $ref: '#/components/responses/UnprocessableEntity'
2490 '500':
2491 $ref: '#/components/responses/InternalServerError'
2492 '503':
2493 $ref: '#/components/responses/ServiceUnavailable'
2494 '5XX':
2495 $ref: '#/components/responses/UnexpectedError'
2496 default:
2497 $ref: '#/components/responses/UnexpectedError'
Gabriel Cuba2c8be082023-11-14 16:52:01 -0500[diff] [blame]2498 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
2499 parameters:
2500 - name: nsLcmOpOccId
2501 in: path
2502 required: true
2503 description: NS LCM Operation Occurrence ID
2504 schema:
2505 type: string
2506 post:
2507 tags:
2508 - "NS instances"
2509 summary: Cancel an ongoing NS lifecycle management operation
2510 description: Cancel an ongoing NS lifecycle management operation while it is being executed or rolled back
2511 operationId: cancelNSLCMOpOcc
2512 requestBody:
2513 $ref: '#/components/requestBodies/CancelNSLCMOpOccRequest'
2514 responses:
2515 '202':
2516 description: Accepted
2517 '400':
2518 $ref: '#/components/responses/BadRequest'
2519 '401':
2520 $ref: '#/components/responses/Unauthorized'
2521 '403':
2522 $ref: '#/components/responses/Forbidden'
2523 '404':
2524 $ref: '#/components/responses/NotFound'
2525 '405':
2526 $ref: '#/components/responses/MethodNotAllowed'
2527 '406':
2528 $ref: '#/components/responses/NotAcceptable'
2529 '409':
2530 $ref: '#/components/responses/Conflict'
2531 '422':
2532 $ref: '#/components/responses/UnprocessableEntity'
2533 '500':
2534 $ref: '#/components/responses/InternalServerError'
2535 '503':
2536 $ref: '#/components/responses/ServiceUnavailable'
2537 '5XX':
2538 $ref: '#/components/responses/UnexpectedError'
2539 default:
2540 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2541 '/nslcm/v1/vnf_instances':
2542 get:
2543 tags:
2544 - "NS instances"
2545 summary: Query information about multiple VNF Instances
2546 description: Query information about multiple VNF Instances
2547 operationId: getVnfInstances
2548 responses:
2549 '200':
2550 description: OK
2551 content:
2552 application/json:
2553 schema:
2554 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2555 application/yaml:
2556 schema:
2557 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2558 '400':
2559 $ref: '#/components/responses/BadRequest'
2560 '401':
2561 $ref: '#/components/responses/Unauthorized'
2562 '403':
2563 $ref: '#/components/responses/Forbidden'
2564 '404':
2565 $ref: '#/components/responses/NotFound'
2566 '405':
2567 $ref: '#/components/responses/MethodNotAllowed'
2568 '406':
2569 $ref: '#/components/responses/NotAcceptable'
2570 '409':
2571 $ref: '#/components/responses/Conflict'
2572 '422':
2573 $ref: '#/components/responses/UnprocessableEntity'
2574 '500':
2575 $ref: '#/components/responses/InternalServerError'
2576 '503':
2577 $ref: '#/components/responses/ServiceUnavailable'
2578 '5XX':
2579 $ref: '#/components/responses/UnexpectedError'
2580 default:
2581 $ref: '#/components/responses/UnexpectedError'
2582 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2583 parameters:
2584 - name: vnfInstanceId
2585 in: path
2586 required: true
2587 description: VNF Instance ID
2588 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]2589 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2590 get:
2591 tags:
2592 - "NS instances"
2593 summary: Query information about an individual VNF Instance
2594 description: Query information about an individual VNF Instance
2595 operationId: getVnfInstance
2596 responses:
2597 '200':
2598 description: OK
2599 content:
2600 application/json:
2601 schema:
2602 $ref: '#/components/schemas/VnfInstanceInfo'
2603 application/yaml:
2604 schema:
2605 $ref: '#/components/schemas/VnfInstanceInfo'
2606 '400':
2607 $ref: '#/components/responses/BadRequest'
2608 '401':
2609 $ref: '#/components/responses/Unauthorized'
2610 '403':
2611 $ref: '#/components/responses/Forbidden'
2612 '404':
2613 $ref: '#/components/responses/NotFound'
2614 '405':
2615 $ref: '#/components/responses/MethodNotAllowed'
2616 '406':
2617 $ref: '#/components/responses/NotAcceptable'
2618 '409':
2619 $ref: '#/components/responses/Conflict'
2620 '422':
2621 $ref: '#/components/responses/UnprocessableEntity'
2622 '500':
2623 $ref: '#/components/responses/InternalServerError'
2624 '503':
2625 $ref: '#/components/responses/ServiceUnavailable'
2626 '5XX':
2627 $ref: '#/components/responses/UnexpectedError'
2628 default:
2629 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +0100[diff] [blame]2630 '/nslcm/v1/subscriptions':
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]2631 get:
2632 tags:
2633 - NS instances
2634 summary: Query information about multiple NS instance subscription
2635 description: Query information about multiple NS instance subscription
2636 operationId: getNsSubcriptions
2637 responses:
2638 '200':
2639 description: OK
2640 content:
2641 application/json:
2642 schema:
2643 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2644 application/yaml:
2645 schema:
2646 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2647 '400':
2648 $ref: '#/components/responses/BadRequest'
2649 '401':
2650 $ref: '#/components/responses/Unauthorized'
2651 '403':
2652 $ref: '#/components/responses/Forbidden'
2653 '404':
2654 $ref: '#/components/responses/NotFound'
2655 '405':
2656 $ref: '#/components/responses/MethodNotAllowed'
2657 '406':
2658 $ref: '#/components/responses/NotAcceptable'
2659 '409':
2660 $ref: '#/components/responses/Conflict'
2661 '422':
2662 $ref: '#/components/responses/UnprocessableEntity'
2663 '500':
2664 $ref: '#/components/responses/InternalServerError'
2665 '503':
2666 $ref: '#/components/responses/ServiceUnavailable'
2667 5XX:
2668 $ref: '#/components/responses/UnexpectedError'
2669 default:
2670 $ref: '#/components/responses/UnexpectedError'
2671 post:
2672 tags:
2673 - NS instances
2674 summary: Create a new subscription for the Network service
2675 description: Create a new subscription for the Network service
2676 operationId: addNsSubcriptions
2677 requestBody:
2678 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2679 responses:
2680 '201':
2681 description: Created
2682 headers:
2683 Location:
2684 schema:
2685 type: object
2686 content:
2687 application/json:
2688 schema:
2689 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2690 application/yaml:
2691 schema:
2692 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2693 '400':
2694 $ref: '#/components/responses/BadRequest'
2695 '401':
2696 $ref: '#/components/responses/Unauthorized'
2697 '403':
2698 $ref: '#/components/responses/Forbidden'
2699 '404':
2700 $ref: '#/components/responses/NotFound'
2701 '405':
2702 $ref: '#/components/responses/MethodNotAllowed'
2703 '406':
2704 $ref: '#/components/responses/NotAcceptable'
2705 '409':
2706 $ref: '#/components/responses/Conflict'
2707 '422':
2708 $ref: '#/components/responses/UnprocessableEntity'
2709 '500':
2710 $ref: '#/components/responses/InternalServerError'
2711 '503':
2712 $ref: '#/components/responses/ServiceUnavailable'
2713 5XX:
2714 $ref: '#/components/responses/UnexpectedError'
2715 default:
2716 $ref: '#/components/responses/UnexpectedError'
2717 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2718 parameters:
2719 - name: nsSubscriptionsId
2720 in: path
2721 required: true
2722 description: Network Service Subscription ID
2723 schema:
2724 type: string
2725 get:
2726 tags:
2727 - NS instances
2728 summary: Read information about an individual Network Service Subscription
2729 description: Read information about an individual Network Service Subscription
2730 operationId: getNsSubcriptionId
2731 responses:
2732 '200':
2733 description: OK
2734 content:
2735 application/json:
2736 schema:
2737 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2738 application/yaml:
2739 schema:
2740 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2741 '400':
2742 $ref: '#/components/responses/BadRequest'
2743 '401':
2744 $ref: '#/components/responses/Unauthorized'
2745 '403':
2746 $ref: '#/components/responses/Forbidden'
2747 '404':
2748 $ref: '#/components/responses/NotFound'
2749 '405':
2750 $ref: '#/components/responses/MethodNotAllowed'
2751 '406':
2752 $ref: '#/components/responses/NotAcceptable'
2753 '409':
2754 $ref: '#/components/responses/Conflict'
2755 '422':
2756 $ref: '#/components/responses/UnprocessableEntity'
2757 '500':
2758 $ref: '#/components/responses/InternalServerError'
2759 '503':
2760 $ref: '#/components/responses/ServiceUnavailable'
2761 5XX:
2762 $ref: '#/components/responses/UnexpectedError'
2763 default:
2764 $ref: '#/components/responses/UnexpectedError'
2765 delete:
2766 tags:
2767 - NS instances
2768 summary: Delete an individual Network Service Subscription
2769 description: Delete an individual Network Service Subscription
2770 operationId: deleteNsSubcriptionId
2771 responses:
2772 '204':
2773 description: No Content
2774 '400':
2775 $ref: '#/components/responses/BadRequest'
2776 '401':
2777 $ref: '#/components/responses/Unauthorized'
2778 '403':
2779 $ref: '#/components/responses/Forbidden'
2780 '404':
2781 $ref: '#/components/responses/NotFound'
2782 '405':
2783 $ref: '#/components/responses/MethodNotAllowed'
2784 '406':
2785 $ref: '#/components/responses/NotAcceptable'
2786 '409':
2787 $ref: '#/components/responses/Conflict'
2788 '422':
2789 $ref: '#/components/responses/UnprocessableEntity'
2790 '500':
2791 $ref: '#/components/responses/InternalServerError'
2792 '503':
2793 $ref: '#/components/responses/ServiceUnavailable'
2794 5XX:
2795 $ref: '#/components/responses/UnexpectedError'
2796 default:
2797 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2798# END NS Instances
2799
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]2800# BEGIN Alarms
2801 '/nsfm/v1/alarms':
2802 get:
2803 tags:
2804 - "Alarms"
2805 summary: Query information about multiple alarms
2806 description: Query information about multiple alarms
2807 operationId: getAlarms
2808 responses:
2809 '200':
2810 description: OK
2811 content:
2812 application/json:
2813 schema:
2814 $ref: '#/components/schemas/ArrayOfAlarm'
2815 application/yaml:
2816 schema:
2817 $ref: '#/components/schemas/ArrayOfAlarm'
2818 '400':
2819 $ref: '#/components/responses/BadRequest'
2820 '401':
2821 $ref: '#/components/responses/Unauthorized'
2822 '403':
2823 $ref: '#/components/responses/Forbidden'
2824 '404':
2825 $ref: '#/components/responses/NotFound'
2826 '405':
2827 $ref: '#/components/responses/MethodNotAllowed'
2828 '406':
2829 $ref: '#/components/responses/NotAcceptable'
2830 '409':
2831 $ref: '#/components/responses/Conflict'
2832 '422':
2833 $ref: '#/components/responses/UnprocessableEntity'
2834 '500':
2835 $ref: '#/components/responses/InternalServerError'
2836 '503':
2837 $ref: '#/components/responses/ServiceUnavailable'
2838 '5XX':
2839 $ref: '#/components/responses/UnexpectedError'
2840 default:
2841 $ref: '#/components/responses/UnexpectedError'
2842 '/nsfm/v1/alarms/{uuid}':
2843 parameters:
2844 - name: uuid
2845 in: path
2846 required: true
2847 description: Alarm UUID
2848 schema:
2849 type: string
2850 get:
2851 tags:
2852 - "Alarms"
2853 summary: Read an individual Alarm
2854 description: Read an individual Alarm
2855 operationId: getAlarm
2856 responses:
2857 '200':
2858 description: OK
2859 content:
2860 application/json:
2861 schema:
2862 $ref: '#/components/schemas/Alarm'
2863 application/yaml:
2864 schema:
2865 $ref: '#/components/schemas/Alarm'
2866 '400':
2867 $ref: '#/components/responses/BadRequest'
2868 '401':
2869 $ref: '#/components/responses/Unauthorized'
2870 '403':
2871 $ref: '#/components/responses/Forbidden'
2872 '404':
2873 $ref: '#/components/responses/NotFound'
2874 '405':
2875 $ref: '#/components/responses/MethodNotAllowed'
2876 '406':
2877 $ref: '#/components/responses/NotAcceptable'
2878 '409':
2879 $ref: '#/components/responses/Conflict'
2880 '422':
2881 $ref: '#/components/responses/UnprocessableEntity'
2882 '500':
2883 $ref: '#/components/responses/InternalServerError'
2884 '503':
2885 $ref: '#/components/responses/ServiceUnavailable'
2886 '5XX':
2887 $ref: '#/components/responses/UnexpectedError'
2888 default:
2889 $ref: '#/components/responses/UnexpectedError'
2890 patch:
2891 tags:
2892 - "Alarms"
2893 summary: Modify the data of an individual Alarm
2894 description: Modify the data of an individual Alarm
2895 operationId: updateAlarm
2896 requestBody:
2897 $ref: '#/components/requestBodies/AlarmInfoModifications'
2898 responses:
2899 '204':
2900 description: No Content
2901 '400':
2902 $ref: '#/components/responses/BadRequest'
2903 '401':
2904 $ref: '#/components/responses/Unauthorized'
2905 '403':
2906 $ref: '#/components/responses/Forbidden'
2907 '404':
2908 $ref: '#/components/responses/NotFound'
2909 '405':
2910 $ref: '#/components/responses/MethodNotAllowed'
2911 '406':
2912 $ref: '#/components/responses/NotAcceptable'
2913 '409':
2914 $ref: '#/components/responses/Conflict'
2915 '422':
2916 $ref: '#/components/responses/UnprocessableEntity'
2917 '500':
2918 $ref: '#/components/responses/InternalServerError'
2919 '503':
2920 $ref: '#/components/responses/ServiceUnavailable'
2921 '5XX':
2922 $ref: '#/components/responses/UnexpectedError'
2923 default:
2924 $ref: '#/components/responses/UnexpectedError'
2925# END Alarms
2926
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]2927# BEGIN NetSlice Templates
2928 '/nst/v1/netslice_templates':
2929 get:
2930 tags:
2931 - "NetSlice templates"
2932 summary: Query information about multiple NetSlice template resources
2933 description: Query information about multiple NetSlice template resources
2934 operationId: getNSTs
2935 responses:
2936 '200':
2937 description: OK
2938 content:
2939 application/json:
2940 schema:
2941 $ref: '#/components/schemas/ArrayOfNstInfo'
2942 application/yaml:
2943 schema:
2944 $ref: '#/components/schemas/ArrayOfNstInfo'
2945 '400':
2946 $ref: '#/components/responses/BadRequest'
2947 '401':
2948 $ref: '#/components/responses/Unauthorized'
2949 '403':
2950 $ref: '#/components/responses/Forbidden'
2951 '404':
2952 $ref: '#/components/responses/NotFound'
2953 '405':
2954 $ref: '#/components/responses/MethodNotAllowed'
2955 '406':
2956 $ref: '#/components/responses/NotAcceptable'
2957 '409':
2958 $ref: '#/components/responses/Conflict'
2959 '422':
2960 $ref: '#/components/responses/UnprocessableEntity'
2961 '500':
2962 $ref: '#/components/responses/InternalServerError'
2963 '503':
2964 $ref: '#/components/responses/ServiceUnavailable'
2965 '5XX':
2966 $ref: '#/components/responses/UnexpectedError'
2967 default:
2968 $ref: '#/components/responses/UnexpectedError'
2969 post:
2970 tags:
2971 - "NetSlice templates"
2972 summary: Create a new NetSlice template resource
2973 description: Create a new NetSlice template resource
2974 operationId: addNST
2975 requestBody:
2976 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2977 responses:
2978 '201':
2979 description: Created
2980 headers:
2981 Location:
2982 schema:
2983 type: string
2984 format: uri
2985 content:
2986 application/json:
2987 schema:
2988 $ref: '#/components/schemas/ObjectId'
2989 application/yaml:
2990 schema:
2991 $ref: '#/components/schemas/ObjectId'
2992 '400':
2993 $ref: '#/components/responses/BadRequest'
2994 '401':
2995 $ref: '#/components/responses/Unauthorized'
2996 '403':
2997 $ref: '#/components/responses/Forbidden'
2998 '404':
2999 $ref: '#/components/responses/NotFound'
3000 '405':
3001 $ref: '#/components/responses/MethodNotAllowed'
3002 '406':
3003 $ref: '#/components/responses/NotAcceptable'
3004 '409':
3005 $ref: '#/components/responses/Conflict'
3006 '422':
3007 $ref: '#/components/responses/UnprocessableEntity'
3008 '500':
3009 $ref: '#/components/responses/InternalServerError'
3010 '503':
3011 $ref: '#/components/responses/ServiceUnavailable'
3012 '5XX':
3013 $ref: '#/components/responses/UnexpectedError'
3014 default:
3015 $ref: '#/components/responses/UnexpectedError'
3016 '/nst/v1/netslice_templates/{netsliceTemplateId}':
3017 parameters:
3018 - name: netsliceTemplateId
3019 in: path
3020 required: true
3021 description: NetSlice Template ID
3022 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3023 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3024 get:
3025 tags:
3026 - "NetSlice templates"
3027 summary: Read information about an individual NetSlice template resource
3028 description: Read information about an individual NetSlice template resource
3029 operationId: getNST
3030 responses:
3031 '200':
3032 description: OK
3033 content:
3034 application/json:
3035 schema:
3036 $ref: '#/components/schemas/NstInfo'
3037 application/yaml:
3038 schema:
3039 $ref: '#/components/schemas/NstInfo'
3040 '400':
3041 $ref: '#/components/responses/BadRequest'
3042 '401':
3043 $ref: '#/components/responses/Unauthorized'
3044 '403':
3045 $ref: '#/components/responses/Forbidden'
3046 '404':
3047 $ref: '#/components/responses/NotFound'
3048 '405':
3049 $ref: '#/components/responses/MethodNotAllowed'
3050 '406':
3051 $ref: '#/components/responses/NotAcceptable'
3052 '409':
3053 $ref: '#/components/responses/Conflict'
3054 '422':
3055 $ref: '#/components/responses/UnprocessableEntity'
3056 '500':
3057 $ref: '#/components/responses/InternalServerError'
3058 '503':
3059 $ref: '#/components/responses/ServiceUnavailable'
3060 '5XX':
3061 $ref: '#/components/responses/UnexpectedError'
3062 default:
3063 $ref: '#/components/responses/UnexpectedError'
3064 delete:
3065 tags:
3066 - "NetSlice templates"
3067 summary: Delete an individual NetSlice template resource
3068 description: Delete an individual NetSlice template resource
3069 operationId: deleteNST
3070 responses:
3071 '204':
3072 description: No Content
3073 '400':
3074 $ref: '#/components/responses/BadRequest'
3075 '401':
3076 $ref: '#/components/responses/Unauthorized'
3077 '403':
3078 $ref: '#/components/responses/Forbidden'
3079 '404':
3080 $ref: '#/components/responses/NotFound'
3081 '405':
3082 $ref: '#/components/responses/MethodNotAllowed'
3083 '406':
3084 $ref: '#/components/responses/NotAcceptable'
3085 '409':
3086 $ref: '#/components/responses/Conflict'
3087 '422':
3088 $ref: '#/components/responses/UnprocessableEntity'
3089 '500':
3090 $ref: '#/components/responses/InternalServerError'
3091 '503':
3092 $ref: '#/components/responses/ServiceUnavailable'
3093 '5XX':
3094 $ref: '#/components/responses/UnexpectedError'
3095 default:
3096 $ref: '#/components/responses/UnexpectedError'
3097 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
3098 parameters:
3099 - name: netsliceTemplateId
3100 in: path
3101 required: true
3102 description: NetSlice Template ID
3103 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3104 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3105 - name: artifactPath
3106 in: path
3107 required: true
3108 description: Artifact Path
3109 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3110 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3111 get:
3112 tags:
3113 - "NetSlice templates"
3114 summary: Fetch individual NetSlice Template artifact
3115 description: Fetch individual NetSlice Template artifact
3116 operationId: getNstArtifact
3117 responses:
3118 '200':
3119 description: OK
3120 content:
3121 application/octet-stream:
3122 schema:
3123 type: string
3124 format: binary
3125 '206':
3126 description: Partial Content
3127 headers:
3128 Content-Range:
3129 schema:
3130 type: string
3131 content:
3132 application/octet-stream:
3133 schema:
3134 type: string
3135 format: binary
3136 '400':
3137 $ref: '#/components/responses/BadRequest'
3138 '401':
3139 $ref: '#/components/responses/Unauthorized'
3140 '403':
3141 $ref: '#/components/responses/Forbidden'
3142 '404':
3143 $ref: '#/components/responses/NotFound'
3144 '405':
3145 $ref: '#/components/responses/MethodNotAllowed'
3146 '406':
3147 $ref: '#/components/responses/NotAcceptable'
3148 '409':
3149 $ref: '#/components/responses/Conflict'
3150 '422':
3151 $ref: '#/components/responses/UnprocessableEntity'
3152 '500':
3153 $ref: '#/components/responses/InternalServerError'
3154 '503':
3155 $ref: '#/components/responses/ServiceUnavailable'
3156 '5XX':
3157 $ref: '#/components/responses/UnexpectedError'
3158 default:
3159 $ref: '#/components/responses/UnexpectedError'
3160 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
3161 parameters:
3162 - name: netsliceTemplateId
3163 in: path
3164 required: true
3165 description: NetSlice Template ID
3166 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3167 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3168 get:
3169 tags:
3170 - "NetSlice templates"
3171 summary: Read NST of an on-boarded NetSlice Template
3172 description: Read NST of an on-boarded NetSlice Template
3173 operationId: getNstNst
3174 responses:
3175 '200':
3176 description: OK
3177 content:
3178 text/plain:
3179 schema:
3180 $ref: '#/components/schemas/NetSliceTemplate'
3181 '400':
3182 $ref: '#/components/responses/BadRequest'
3183 '401':
3184 $ref: '#/components/responses/Unauthorized'
3185 '403':
3186 $ref: '#/components/responses/Forbidden'
3187 '404':
3188 $ref: '#/components/responses/NotFound'
3189 '405':
3190 $ref: '#/components/responses/MethodNotAllowed'
3191 '406':
3192 $ref: '#/components/responses/NotAcceptable'
3193 '409':
3194 $ref: '#/components/responses/Conflict'
3195 '422':
3196 $ref: '#/components/responses/UnprocessableEntity'
3197 '500':
3198 $ref: '#/components/responses/InternalServerError'
3199 '503':
3200 $ref: '#/components/responses/ServiceUnavailable'
3201 '5XX':
3202 $ref: '#/components/responses/UnexpectedError'
3203 default:
3204 $ref: '#/components/responses/UnexpectedError'
3205 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
3206 parameters:
3207 - name: netsliceTemplateId
3208 in: path
3209 required: true
3210 description: NetSlice Template ID
3211 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3212 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3213 get:
3214 tags:
3215 - "NetSlice templates"
3216 summary: Fetch the content of a NST
3217 description: Fetch the content of a NST
3218 operationId: getNSTcontent
3219 responses:
3220 '200':
3221 description: OK
3222 content:
3223 application/zip:
3224 schema:
3225 $ref: '#/components/schemas/NetSlicePackage'
3226 '206':
3227 description: Partial Content
3228 headers:
3229 Content-Range:
3230 schema:
3231 type: string
3232 content:
3233 application/zip:
3234 schema:
3235 $ref: '#/components/schemas/NetSlicePackage'
3236 '400':
3237 $ref: '#/components/responses/BadRequest'
3238 '401':
3239 $ref: '#/components/responses/Unauthorized'
3240 '403':
3241 $ref: '#/components/responses/Forbidden'
3242 '404':
3243 $ref: '#/components/responses/NotFound'
3244 '405':
3245 $ref: '#/components/responses/MethodNotAllowed'
3246 '406':
3247 $ref: '#/components/responses/NotAcceptable'
3248 '409':
3249 $ref: '#/components/responses/Conflict'
3250 '422':
3251 $ref: '#/components/responses/UnprocessableEntity'
3252 '500':
3253 $ref: '#/components/responses/InternalServerError'
3254 '503':
3255 $ref: '#/components/responses/ServiceUnavailable'
3256 '5XX':
3257 $ref: '#/components/responses/UnexpectedError'
3258 default:
3259 $ref: '#/components/responses/UnexpectedError'
3260 put:
3261 tags:
3262 - "NetSlice templates"
3263 summary: Upload the content of a NST
3264 description: Upload the content of a NST
3265 operationId: updateNSTcontent
3266 requestBody:
3267 $ref: '#/components/requestBodies/NetSlicePackage'
3268 responses:
3269 '202':
3270 description: Accepted
3271 '204':
3272 description: No Content
3273 '400':
3274 $ref: '#/components/responses/BadRequest'
3275 '401':
3276 $ref: '#/components/responses/Unauthorized'
3277 '403':
3278 $ref: '#/components/responses/Forbidden'
3279 '404':
3280 $ref: '#/components/responses/NotFound'
3281 '405':
3282 $ref: '#/components/responses/MethodNotAllowed'
3283 '406':
3284 $ref: '#/components/responses/NotAcceptable'
3285 '409':
3286 $ref: '#/components/responses/Conflict'
3287 '422':
3288 $ref: '#/components/responses/UnprocessableEntity'
3289 '500':
3290 $ref: '#/components/responses/InternalServerError'
3291 '503':
3292 $ref: '#/components/responses/ServiceUnavailable'
3293 '5XX':
3294 $ref: '#/components/responses/UnexpectedError'
3295 default:
3296 $ref: '#/components/responses/UnexpectedError'
3297 '/nst/v1/netslice_templates_content':
3298 post:
3299 tags:
3300 - "NetSlice templates"
3301 summary: Upload a NetSlice package by providing the content of the NetSlice package
3302 description: Upload a NetSlice package by providing the content of the NetSlice package
3303 operationId: uploadNstContent
3304 requestBody:
3305 content:
3306 application/zip:
3307 schema:
3308 $ref: '#/components/schemas/NetSlicePackage'
3309 responses:
3310 '201':
3311 description: Created
3312 headers:
3313 Location:
3314 schema:
3315 type: string
3316 format: uri
3317 content:
3318 application/json:
3319 schema:
3320 $ref: '#/components/schemas/ObjectId'
3321 application/yaml:
3322 schema:
3323 $ref: '#/components/schemas/ObjectId'
3324 '202':
3325 description: Accepted
3326 '204':
3327 description: No Content
3328 '400':
3329 $ref: '#/components/responses/BadRequest'
3330 '401':
3331 $ref: '#/components/responses/Unauthorized'
3332 '403':
3333 $ref: '#/components/responses/Forbidden'
3334 '404':
3335 $ref: '#/components/responses/NotFound'
3336 '405':
3337 $ref: '#/components/responses/MethodNotAllowed'
3338 '406':
3339 $ref: '#/components/responses/NotAcceptable'
3340 '409':
3341 $ref: '#/components/responses/Conflict'
3342 '422':
3343 $ref: '#/components/responses/UnprocessableEntity'
3344 '500':
3345 $ref: '#/components/responses/InternalServerError'
3346 '503':
3347 $ref: '#/components/responses/ServiceUnavailable'
3348 '5XX':
3349 $ref: '#/components/responses/UnexpectedError'
3350 default:
3351 $ref: '#/components/responses/UnexpectedError'
3352 get:
3353 tags:
3354 - "NetSlice templates"
3355 summary: Query information about multiple NetSlice Template resources
3356 description: Query information about multiple NetSlice Template resources
3357 operationId: getNstContent
3358 responses:
3359 '200':
3360 description: OK
3361 content:
3362 application/json:
3363 schema:
3364 $ref: '#/components/schemas/ArrayOfNstInfo'
3365 application/yaml:
3366 schema:
3367 $ref: '#/components/schemas/ArrayOfNstInfo'
3368 '206':
3369 description: Partial Content
3370 headers:
3371 Content-Range:
3372 schema:
3373 type: string
3374 content:
3375 application/octet-stream:
3376 schema:
3377 type: string
3378 format: binary
3379 '400':
3380 $ref: '#/components/responses/BadRequest'
3381 '401':
3382 $ref: '#/components/responses/Unauthorized'
3383 '403':
3384 $ref: '#/components/responses/Forbidden'
3385 '404':
3386 $ref: '#/components/responses/NotFound'
3387 '405':
3388 $ref: '#/components/responses/MethodNotAllowed'
3389 '406':
3390 $ref: '#/components/responses/NotAcceptable'
3391 '409':
3392 $ref: '#/components/responses/Conflict'
3393 '422':
3394 $ref: '#/components/responses/UnprocessableEntity'
3395 '500':
3396 $ref: '#/components/responses/InternalServerError'
3397 '503':
3398 $ref: '#/components/responses/ServiceUnavailable'
3399 '5XX':
3400 $ref: '#/components/responses/UnexpectedError'
3401 default:
3402 $ref: '#/components/responses/UnexpectedError'
3403 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
3404 parameters:
3405 - name: netsliceTemplateContentId
3406 in: path
3407 required: true
3408 description: NetSlice Template ID
3409 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3410 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3411 get:
3412 tags:
3413 - "NetSlice templates"
3414 summary: Read information about an individual NetSlice Template resource
3415 description: Read information about an individual NetSlice Template resource
3416 operationId: getNstIdContent
3417 responses:
3418 '200':
3419 description: OK
3420 content:
3421 application/json:
3422 schema:
3423 $ref: '#/components/schemas/NstInfo'
3424 application/yaml:
3425 schema:
3426 $ref: '#/components/schemas/NstInfo'
3427 '400':
3428 $ref: '#/components/responses/BadRequest'
3429 '401':
3430 $ref: '#/components/responses/Unauthorized'
3431 '403':
3432 $ref: '#/components/responses/Forbidden'
3433 '404':
3434 $ref: '#/components/responses/NotFound'
3435 '405':
3436 $ref: '#/components/responses/MethodNotAllowed'
3437 '406':
3438 $ref: '#/components/responses/NotAcceptable'
3439 '409':
3440 $ref: '#/components/responses/Conflict'
3441 '422':
3442 $ref: '#/components/responses/UnprocessableEntity'
3443 '500':
3444 $ref: '#/components/responses/InternalServerError'
3445 '503':
3446 $ref: '#/components/responses/ServiceUnavailable'
3447 '5XX':
3448 $ref: '#/components/responses/UnexpectedError'
3449 default:
3450 $ref: '#/components/responses/UnexpectedError'
3451 put:
3452 tags:
3453 - "NetSlice templates"
3454 summary: Modify an individual NetSlice Template resource
3455 description: Modify an individual NetSlice Template resource
3456 operationId: updateNstIdContent
3457 requestBody:
3458 $ref: '#/components/requestBodies/NstInfoModifications'
3459 responses:
3460 '204':
3461 description: No Content
3462 '400':
3463 $ref: '#/components/responses/BadRequest'
3464 '401':
3465 $ref: '#/components/responses/Unauthorized'
3466 '403':
3467 $ref: '#/components/responses/Forbidden'
3468 '404':
3469 $ref: '#/components/responses/NotFound'
3470 '405':
3471 $ref: '#/components/responses/MethodNotAllowed'
3472 '406':
3473 $ref: '#/components/responses/NotAcceptable'
3474 '409':
3475 $ref: '#/components/responses/Conflict'
3476 '422':
3477 $ref: '#/components/responses/UnprocessableEntity'
3478 '500':
3479 $ref: '#/components/responses/InternalServerError'
3480 '503':
3481 $ref: '#/components/responses/ServiceUnavailable'
3482 '5XX':
3483 $ref: '#/components/responses/UnexpectedError'
3484 default:
3485 $ref: '#/components/responses/UnexpectedError'
3486 delete:
3487 tags:
3488 - "NetSlice templates"
3489 summary: Delete an individual NetSlice Template resource
3490 description: Delete an individual NetSlice Template resource
3491 operationId: deleteNstIdContent
3492 responses:
3493 '204':
3494 description: No Content
3495 '400':
3496 $ref: '#/components/responses/BadRequest'
3497 '401':
3498 $ref: '#/components/responses/Unauthorized'
3499 '403':
3500 $ref: '#/components/responses/Forbidden'
3501 '404':
3502 $ref: '#/components/responses/NotFound'
3503 '405':
3504 $ref: '#/components/responses/MethodNotAllowed'
3505 '406':
3506 $ref: '#/components/responses/NotAcceptable'
3507 '409':
3508 $ref: '#/components/responses/Conflict'
3509 '422':
3510 $ref: '#/components/responses/UnprocessableEntity'
3511 '500':
3512 $ref: '#/components/responses/InternalServerError'
3513 '503':
3514 $ref: '#/components/responses/ServiceUnavailable'
3515 '5XX':
3516 $ref: '#/components/responses/UnexpectedError'
3517 default:
3518 $ref: '#/components/responses/UnexpectedError'
3519# END NetSlice Templates
3520
3521# BEGIN NetSlice Instances
3522 '/nsilcm/v1/netslice_instances':
3523 get:
3524 tags:
3525 - "NetSlice instances"
3526 summary: Query information about multiple NetSlice instances
3527 description: Query information about multiple NetSlice isntances
3528 operationId: getNSIs
3529 responses:
3530 '200':
3531 description: OK
3532 content:
3533 application/json:
3534 schema:
3535 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3536 application/yaml:
3537 schema:
3538 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3539 '400':
3540 $ref: '#/components/responses/BadRequest'
3541 '401':
3542 $ref: '#/components/responses/Unauthorized'
3543 '403':
3544 $ref: '#/components/responses/Forbidden'
3545 '404':
3546 $ref: '#/components/responses/NotFound'
3547 '405':
3548 $ref: '#/components/responses/MethodNotAllowed'
3549 '406':
3550 $ref: '#/components/responses/NotAcceptable'
3551 '409':
3552 $ref: '#/components/responses/Conflict'
3553 '422':
3554 $ref: '#/components/responses/UnprocessableEntity'
3555 '500':
3556 $ref: '#/components/responses/InternalServerError'
3557 '503':
3558 $ref: '#/components/responses/ServiceUnavailable'
3559 '5XX':
3560 $ref: '#/components/responses/UnexpectedError'
3561 default:
3562 $ref: '#/components/responses/UnexpectedError'
3563 post:
3564 tags:
3565 - "NetSlice instances"
3566 summary: Create a new NetSlice instance resource
3567 description: Create a new NetSlice instance resource
3568 operationId: addNSI
3569 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3570 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3571 responses:
3572 '201':
3573 description: Created
3574 headers:
3575 Location:
3576 schema:
3577 type: string
3578 format: uri
3579 content:
3580 application/json:
3581 schema:
3582 $ref: '#/components/schemas/ObjectId'
3583 application/yaml:
3584 schema:
3585 $ref: '#/components/schemas/ObjectId'
3586 '400':
3587 $ref: '#/components/responses/BadRequest'
3588 '401':
3589 $ref: '#/components/responses/Unauthorized'
3590 '403':
3591 $ref: '#/components/responses/Forbidden'
3592 '404':
3593 $ref: '#/components/responses/NotFound'
3594 '405':
3595 $ref: '#/components/responses/MethodNotAllowed'
3596 '406':
3597 $ref: '#/components/responses/NotAcceptable'
3598 '409':
3599 $ref: '#/components/responses/Conflict'
3600 '422':
3601 $ref: '#/components/responses/UnprocessableEntity'
3602 '500':
3603 $ref: '#/components/responses/InternalServerError'
3604 '503':
3605 $ref: '#/components/responses/ServiceUnavailable'
3606 '5XX':
3607 $ref: '#/components/responses/UnexpectedError'
3608 default:
3609 $ref: '#/components/responses/UnexpectedError'
3610 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3611 parameters:
3612 - name: netsliceInstanceId
3613 in: path
3614 required: true
3615 description: NetSlice Instance ID
3616 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3617 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3618 get:
3619 tags:
3620 - "NetSlice instances"
3621 summary: Read an individual NetSlice instance resource
3622 description: Read an individual NetSlice instance resource
3623 operationId: getNSI
3624 responses:
3625 '200':
3626 description: OK
3627 content:
3628 application/json:
3629 schema:
3630 $ref: '#/components/schemas/NetSliceInstance'
3631 application/yaml:
3632 schema:
3633 $ref: '#/components/schemas/NetSliceInstance'
3634 '400':
3635 $ref: '#/components/responses/BadRequest'
3636 '401':
3637 $ref: '#/components/responses/Unauthorized'
3638 '403':
3639 $ref: '#/components/responses/Forbidden'
3640 '404':
3641 $ref: '#/components/responses/NotFound'
3642 '405':
3643 $ref: '#/components/responses/MethodNotAllowed'
3644 '406':
3645 $ref: '#/components/responses/NotAcceptable'
3646 '409':
3647 $ref: '#/components/responses/Conflict'
3648 '422':
3649 $ref: '#/components/responses/UnprocessableEntity'
3650 '500':
3651 $ref: '#/components/responses/InternalServerError'
3652 '503':
3653 $ref: '#/components/responses/ServiceUnavailable'
3654 '5XX':
3655 $ref: '#/components/responses/UnexpectedError'
3656 default:
3657 $ref: '#/components/responses/UnexpectedError'
3658 delete:
3659 tags:
3660 - "NetSlice instances"
3661 summary: Delete an individual NetSlice instance resource
3662 description: Delete an individual NetSlice instance resource
3663 operationId: deleteNSI
3664 responses:
3665 '204':
3666 description: No Content
3667 '400':
3668 $ref: '#/components/responses/BadRequest'
3669 '401':
3670 $ref: '#/components/responses/Unauthorized'
3671 '403':
3672 $ref: '#/components/responses/Forbidden'
3673 '404':
3674 $ref: '#/components/responses/NotFound'
3675 '405':
3676 $ref: '#/components/responses/MethodNotAllowed'
3677 '406':
3678 $ref: '#/components/responses/NotAcceptable'
3679 '409':
3680 $ref: '#/components/responses/Conflict'
3681 '422':
3682 $ref: '#/components/responses/UnprocessableEntity'
3683 '500':
3684 $ref: '#/components/responses/InternalServerError'
3685 '503':
3686 $ref: '#/components/responses/ServiceUnavailable'
3687 '5XX':
3688 $ref: '#/components/responses/UnexpectedError'
3689 default:
3690 $ref: '#/components/responses/UnexpectedError'
3691 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3692 parameters:
3693 - name: netsliceInstanceId
3694 in: path
3695 required: true
3696 description: NetSlice Instance ID
3697 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3698 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3699 post:
3700 tags:
3701 - "NetSlice instances"
3702 summary: Instantiate a NetSlice
3703 description: |
3704 Instantiate a NetSlice. The precondition is that the NetSlice instance
3705 must have been created and must be in NOT_INSTANTIATED state. As a result
3706 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3707 Operation Occurrence" resource for the request, and the NS instance state
3708 becomes INSTANTIATED.
3709 operationId: instantiateNSI
3710 requestBody:
3711 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3712 responses:
3713 '202':
3714 description: Accepted
3715 headers:
3716 Location:
3717 description: |
3718 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3719 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3720 schema:
3721 type: string
3722 format: uri
3723 content:
3724 application/json:
3725 schema:
3726 $ref: '#/components/schemas/ObjectId'
3727 application/yaml:
3728 schema:
3729 $ref: '#/components/schemas/ObjectId'
3730 '400':
3731 $ref: '#/components/responses/BadRequest'
3732 '401':
3733 $ref: '#/components/responses/Unauthorized'
3734 '403':
3735 $ref: '#/components/responses/Forbidden'
3736 '404':
3737 $ref: '#/components/responses/NotFound'
3738 '405':
3739 $ref: '#/components/responses/MethodNotAllowed'
3740 '406':
3741 $ref: '#/components/responses/NotAcceptable'
3742 '409':
3743 $ref: '#/components/responses/Conflict'
3744 '422':
3745 $ref: '#/components/responses/UnprocessableEntity'
3746 '500':
3747 $ref: '#/components/responses/InternalServerError'
3748 '503':
3749 $ref: '#/components/responses/ServiceUnavailable'
3750 '5XX':
3751 $ref: '#/components/responses/UnexpectedError'
3752 default:
3753 $ref: '#/components/responses/UnexpectedError'
3754 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3755 parameters:
3756 - name: netsliceInstanceId
3757 in: path
3758 required: true
3759 description: NetSlice Instance ID
3760 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3761 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3762 post:
3763 tags:
3764 - "NetSlice instances"
3765 summary: Terminate a NetSlice instance
3766 description: |
3767 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3768 must have been created and must be in INSTANTIATED state. As a result of the
3769 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3770 Occurrence" resource for the request, and the NetSlice instance state becomes
3771 NOT_INSTANTIATED.
3772 operationId: terminateNSI
3773 requestBody:
3774 # Request data is not required
3775 $ref: '#/components/requestBodies/TerminateNsiRequest'
3776 responses:
3777 '202':
3778 description: Accepted
3779 headers:
3780 Location:
3781 description: |
3782 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3783 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3784 schema:
3785 type: string
3786 format: uri
3787 content:
3788 application/json:
3789 schema:
3790 $ref: '#/components/schemas/ObjectId'
3791 application/yaml:
3792 schema:
3793 $ref: '#/components/schemas/ObjectId'
3794 '400':
3795 $ref: '#/components/responses/BadRequest'
3796 '401':
3797 $ref: '#/components/responses/Unauthorized'
3798 '403':
3799 $ref: '#/components/responses/Forbidden'
3800 '404':
3801 $ref: '#/components/responses/NotFound'
3802 '405':
3803 $ref: '#/components/responses/MethodNotAllowed'
3804 '406':
3805 $ref: '#/components/responses/NotAcceptable'
3806 '409':
3807 $ref: '#/components/responses/Conflict'
3808 '422':
3809 $ref: '#/components/responses/UnprocessableEntity'
3810 '500':
3811 $ref: '#/components/responses/InternalServerError'
3812 '503':
3813 $ref: '#/components/responses/ServiceUnavailable'
3814 '5XX':
3815 $ref: '#/components/responses/UnexpectedError'
3816 default:
3817 $ref: '#/components/responses/UnexpectedError'
3818 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3819 parameters:
3820 - name: netsliceInstanceId
3821 in: path
3822 required: true
3823 description: NetSlice Instance ID
3824 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3825 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3826 post:
3827 tags:
3828 - "NetSlice instances"
3829 summary: Execute an action on a NetSlice instance
3830 description: |
3831 Execute an action on a NetSlice instance.
3832 The NetSlice instance must have been created and must be in INSTANTIATED state.
3833 operationId: actionOnNSI
3834 requestBody:
3835 content:
3836 application/json:
3837 schema:
3838 $ref: '#/components/schemas/NsiActionRequest'
3839 application/yaml:
3840 schema:
3841 $ref: '#/components/schemas/NsiActionRequest'
3842 responses:
3843 '202':
3844 description: Accepted
3845 headers:
3846 Location:
3847 description: |
3848 It must point to the new "NS Lifecycle Operation Occurrence"
3849 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3850 schema:
3851 type: string
3852 format: uri
3853 content:
3854 application/json:
3855 schema:
3856 $ref: '#/components/schemas/ObjectId'
3857 application/yaml:
3858 schema:
3859 $ref: '#/components/schemas/ObjectId'
3860 '400':
3861 $ref: '#/components/responses/BadRequest'
3862 '401':
3863 $ref: '#/components/responses/Unauthorized'
3864 '403':
3865 $ref: '#/components/responses/Forbidden'
3866 '404':
3867 $ref: '#/components/responses/NotFound'
3868 '405':
3869 $ref: '#/components/responses/MethodNotAllowed'
3870 '406':
3871 $ref: '#/components/responses/NotAcceptable'
3872 '409':
3873 $ref: '#/components/responses/Conflict'
3874 '422':
3875 $ref: '#/components/responses/UnprocessableEntity'
3876 '500':
3877 $ref: '#/components/responses/InternalServerError'
3878 '503':
3879 $ref: '#/components/responses/ServiceUnavailable'
3880 '5XX':
3881 $ref: '#/components/responses/UnexpectedError'
3882 default:
3883 $ref: '#/components/responses/UnexpectedError'
3884 '/nsilcm/v1/netslice_instances_content':
3885 get:
3886 tags:
3887 - "NetSlice instances"
3888 summary: Query information about multiple NetSlice instances
3889 description: Query information about multiple NetSlice isntances
3890 operationId: getNSIsContent
3891 responses:
3892 '200':
3893 description: OK
3894 content:
3895 application/json:
3896 schema:
3897 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3898 application/yaml:
3899 schema:
3900 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3901 '400':
3902 $ref: '#/components/responses/BadRequest'
3903 '401':
3904 $ref: '#/components/responses/Unauthorized'
3905 '403':
3906 $ref: '#/components/responses/Forbidden'
3907 '404':
3908 $ref: '#/components/responses/NotFound'
3909 '405':
3910 $ref: '#/components/responses/MethodNotAllowed'
3911 '406':
3912 $ref: '#/components/responses/NotAcceptable'
3913 '409':
3914 $ref: '#/components/responses/Conflict'
3915 '422':
3916 $ref: '#/components/responses/UnprocessableEntity'
3917 '500':
3918 $ref: '#/components/responses/InternalServerError'
3919 '503':
3920 $ref: '#/components/responses/ServiceUnavailable'
3921 '5XX':
3922 $ref: '#/components/responses/UnexpectedError'
3923 default:
3924 $ref: '#/components/responses/UnexpectedError'
3925 post:
3926 tags:
3927 - "NetSlice instances"
3928 summary: Create a new NetSlice instance
3929 description: Create a new NetSlice instance
3930 operationId: createNSIContent
3931 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3932 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3933 responses:
3934 '201':
3935 description: Created
3936 headers:
3937 Location:
3938 schema:
3939 type: string
3940 format: uri
3941 content:
3942 application/json:
3943 schema:
3944 $ref: '#/components/schemas/CreateNsiContentResponse'
3945 application/yaml:
3946 schema:
3947 $ref: '#/components/schemas/CreateNsiContentResponse'
3948 '400':
3949 $ref: '#/components/responses/BadRequest'
3950 '401':
3951 $ref: '#/components/responses/Unauthorized'
3952 '403':
3953 $ref: '#/components/responses/Forbidden'
3954 '404':
3955 $ref: '#/components/responses/NotFound'
3956 '405':
3957 $ref: '#/components/responses/MethodNotAllowed'
3958 '406':
3959 $ref: '#/components/responses/NotAcceptable'
3960 '409':
3961 $ref: '#/components/responses/Conflict'
3962 '422':
3963 $ref: '#/components/responses/UnprocessableEntity'
3964 '500':
3965 $ref: '#/components/responses/InternalServerError'
3966 '503':
3967 $ref: '#/components/responses/ServiceUnavailable'
3968 '5XX':
3969 $ref: '#/components/responses/UnexpectedError'
3970 default:
3971 $ref: '#/components/responses/UnexpectedError'
3972 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3973 parameters:
3974 - name: netsliceInstanceContentId
3975 in: path
3976 required: true
3977 description: NetSlice Instance Content ID
3978 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]3979 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]3980 get:
3981 tags:
3982 - "NetSlice instances"
3983 summary: Read an individual NetSlice instance resource
3984 description: Read an individual NetSlice instance resource
3985 operationId: getNSIContent
3986 responses:
3987 '200':
3988 description: OK
3989 content:
3990 application/json:
3991 schema:
3992 $ref: '#/components/schemas/NetSliceInstance'
3993 application/yaml:
3994 schema:
3995 $ref: '#/components/schemas/NetSliceInstance'
3996 '400':
3997 $ref: '#/components/responses/BadRequest'
3998 '401':
3999 $ref: '#/components/responses/Unauthorized'
4000 '403':
4001 $ref: '#/components/responses/Forbidden'
4002 '404':
4003 $ref: '#/components/responses/NotFound'
4004 '405':
4005 $ref: '#/components/responses/MethodNotAllowed'
4006 '406':
4007 $ref: '#/components/responses/NotAcceptable'
4008 '409':
4009 $ref: '#/components/responses/Conflict'
4010 '422':
4011 $ref: '#/components/responses/UnprocessableEntity'
4012 '500':
4013 $ref: '#/components/responses/InternalServerError'
4014 '503':
4015 $ref: '#/components/responses/ServiceUnavailable'
4016 '5XX':
4017 $ref: '#/components/responses/UnexpectedError'
4018 default:
4019 $ref: '#/components/responses/UnexpectedError'
4020 delete:
4021 tags:
4022 - "NetSlice instances"
4023 summary: Delete an individual NS instance resource
4024 description: Delete an individual NS instance resource
4025 operationId: deleteNSIContent
4026 responses:
4027 '202':
4028 description: Accepted
4029 content:
4030 application/json:
4031 schema:
4032 $ref: '#/components/schemas/ObjectId'
4033 application/yaml:
4034 schema:
4035 $ref: '#/components/schemas/ObjectId'
4036 '204':
4037 description: No Content
4038 '400':
4039 $ref: '#/components/responses/BadRequest'
4040 '401':
4041 $ref: '#/components/responses/Unauthorized'
4042 '403':
4043 $ref: '#/components/responses/Forbidden'
4044 '404':
4045 $ref: '#/components/responses/NotFound'
4046 '405':
4047 $ref: '#/components/responses/MethodNotAllowed'
4048 '406':
4049 $ref: '#/components/responses/NotAcceptable'
4050 '409':
4051 $ref: '#/components/responses/Conflict'
4052 '422':
4053 $ref: '#/components/responses/UnprocessableEntity'
4054 '500':
4055 $ref: '#/components/responses/InternalServerError'
4056 '503':
4057 $ref: '#/components/responses/ServiceUnavailable'
4058 '5XX':
4059 $ref: '#/components/responses/UnexpectedError'
4060 default:
4061 $ref: '#/components/responses/UnexpectedError'
4062 '/nsilcm/v1/nsi_lcm_op_occs':
4063 get:
4064 tags:
4065 - "NetSlice instances"
4066 summary: Query information about multiple NetSlice LCM Operation Occurrences
4067 description: Query information about multiple NetSlice LCM Operation Occurrences
4068 operationId: getNsiLcmOpOccs
4069 responses:
4070 '200':
4071 description: OK
4072 content:
4073 application/json:
4074 schema:
4075 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
4076 application/yaml:
4077 schema:
4078 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
4079 '400':
4080 $ref: '#/components/responses/BadRequest'
4081 '401':
4082 $ref: '#/components/responses/Unauthorized'
4083 '403':
4084 $ref: '#/components/responses/Forbidden'
4085 '404':
4086 $ref: '#/components/responses/NotFound'
4087 '405':
4088 $ref: '#/components/responses/MethodNotAllowed'
4089 '406':
4090 $ref: '#/components/responses/NotAcceptable'
4091 '409':
4092 $ref: '#/components/responses/Conflict'
4093 '422':
4094 $ref: '#/components/responses/UnprocessableEntity'
4095 '500':
4096 $ref: '#/components/responses/InternalServerError'
4097 '503':
4098 $ref: '#/components/responses/ServiceUnavailable'
4099 '5XX':
4100 $ref: '#/components/responses/UnexpectedError'
4101 default:
4102 $ref: '#/components/responses/UnexpectedError'
4103 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
4104 parameters:
4105 - name: nsiLcmOpOccId
4106 in: path
4107 required: true
4108 description: NetSlice LCM Operation Occurrence ID
4109 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4110 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]4111 get:
4112 tags:
4113 - "NetSlice instances"
4114 summary: Query information about an individual NetSlice LCM Operation Occurrence
4115 description: Query information about an individual NetSlice LCM Operation Occurrence
4116 operationId: getNsiLcmOpOcc
4117 responses:
4118 '200':
4119 description: OK
4120 content:
4121 application/json:
4122 schema:
4123 $ref: '#/components/schemas/NsiLcmOpOcc'
4124 application/yaml:
4125 schema:
4126 $ref: '#/components/schemas/NsiLcmOpOcc'
4127 '400':
4128 $ref: '#/components/responses/BadRequest'
4129 '401':
4130 $ref: '#/components/responses/Unauthorized'
4131 '403':
4132 $ref: '#/components/responses/Forbidden'
4133 '404':
4134 $ref: '#/components/responses/NotFound'
4135 '405':
4136 $ref: '#/components/responses/MethodNotAllowed'
4137 '406':
4138 $ref: '#/components/responses/NotAcceptable'
4139 '409':
4140 $ref: '#/components/responses/Conflict'
4141 '422':
4142 $ref: '#/components/responses/UnprocessableEntity'
4143 '500':
4144 $ref: '#/components/responses/InternalServerError'
4145 '503':
4146 $ref: '#/components/responses/ServiceUnavailable'
4147 '5XX':
4148 $ref: '#/components/responses/UnexpectedError'
4149 default:
4150 $ref: '#/components/responses/UnexpectedError'
4151# END NetSlice Instances
4152
4153# BEGIN NSPM
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4154 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
4155 parameters:
4156 - name: pmJobId
4157 in: path
4158 required: true
4159 description: NS PM Job ID
4160 schema:
4161 type: string
4162 - name: nsId
4163 in: path
4164 required: true
4165 description: NS ID
4166 schema:
4167 type: string
4168 get:
4169 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]4170 - "NS Performance Management"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4171 summary: Query information about an individual NS PM Job Report
4172 description: Query information about an individual NS PM Job Report
4173 operationId: getNsPmJobReport
4174 responses:
4175 '200':
4176 description: OK
4177 content:
4178 application/json:
4179 schema:
4180 $ref: '#/components/schemas/NsPmJobReportInfo'
4181 application/yaml:
4182 schema:
4183 $ref: '#/components/schemas/NsPmJobReportInfo'
4184 '400':
4185 $ref: '#/components/responses/BadRequest'
4186 '401':
4187 $ref: '#/components/responses/Unauthorized'
4188 '403':
4189 $ref: '#/components/responses/Forbidden'
4190 '404':
4191 $ref: '#/components/responses/NotFound'
4192 '405':
4193 $ref: '#/components/responses/MethodNotAllowed'
4194 '406':
4195 $ref: '#/components/responses/NotAcceptable'
4196 '409':
4197 $ref: '#/components/responses/Conflict'
4198 '422':
4199 $ref: '#/components/responses/UnprocessableEntity'
4200 '500':
4201 $ref: '#/components/responses/InternalServerError'
4202 '503':
4203 $ref: '#/components/responses/ServiceUnavailable'
4204 '5XX':
4205 $ref: '#/components/responses/UnexpectedError'
4206 default:
4207 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]4208# END NSPM
4209
4210# BEGIN PDU
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4211 '/pdu/v1/pdu_descriptors':
4212 get:
4213 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]4214 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4215 summary: Query information about multiple PDU Descriptors
4216 description: Query information about multiple PDU Descriptors
4217 operationId: getPDUs
4218 responses:
4219 '200':
4220 description: OK
4221 content:
4222 application/json:
4223 schema:
4224 $ref: '#/components/schemas/ArrayOfPduInfo'
4225 application/yaml:
4226 schema:
4227 $ref: '#/components/schemas/ArrayOfPduInfo'
4228 '400':
4229 $ref: '#/components/responses/BadRequest'
4230 '401':
4231 $ref: '#/components/responses/Unauthorized'
4232 '403':
4233 $ref: '#/components/responses/Forbidden'
4234 '404':
4235 $ref: '#/components/responses/NotFound'
4236 '405':
4237 $ref: '#/components/responses/MethodNotAllowed'
4238 '406':
4239 $ref: '#/components/responses/NotAcceptable'
4240 '409':
4241 $ref: '#/components/responses/Conflict'
4242 '422':
4243 $ref: '#/components/responses/UnprocessableEntity'
4244 '500':
4245 $ref: '#/components/responses/InternalServerError'
4246 '503':
4247 $ref: '#/components/responses/ServiceUnavailable'
4248 '5XX':
4249 $ref: '#/components/responses/UnexpectedError'
4250 default:
4251 $ref: '#/components/responses/UnexpectedError'
4252 post:
4253 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]4254 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4255 summary: Create a new PDU
4256 description: Create a new PDU Descriptor
4257 operationId: createPDU
4258 requestBody:
4259 $ref: '#/components/requestBodies/CreatePduRequest'
4260 responses:
4261 '200':
4262 description: OK
4263 headers:
4264 Location:
4265 schema:
4266 type: string
4267 format: uri
4268 content:
4269 application/json:
4270 schema:
4271 $ref: '#/components/schemas/ObjectId'
4272 application/yaml:
4273 schema:
4274 $ref: '#/components/schemas/ObjectId'
4275 '400':
4276 $ref: '#/components/responses/BadRequest'
4277 '401':
4278 $ref: '#/components/responses/Unauthorized'
4279 '403':
4280 $ref: '#/components/responses/Forbidden'
4281 '404':
4282 $ref: '#/components/responses/NotFound'
4283 '405':
4284 $ref: '#/components/responses/MethodNotAllowed'
4285 '406':
4286 $ref: '#/components/responses/NotAcceptable'
4287 '409':
4288 $ref: '#/components/responses/Conflict'
4289 '422':
4290 $ref: '#/components/responses/UnprocessableEntity'
4291 '500':
4292 $ref: '#/components/responses/InternalServerError'
4293 '503':
4294 $ref: '#/components/responses/ServiceUnavailable'
4295 '5XX':
4296 $ref: '#/components/responses/UnexpectedError'
4297 default:
4298 $ref: '#/components/responses/UnexpectedError'
4299 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
4300 parameters:
4301 - name: pduDescriptorId
4302 in: path
4303 required: true
4304 description: PDU Descriptor ID
4305 schema:
4306 type: string
4307 get:
4308 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]4309 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4310 summary: Query information about an individual PDU Descriptor
4311 description: Query information about an individual PDU Descriptor
4312 operationId: getPDU
4313 responses:
4314 '200':
4315 description: OK
4316 content:
4317 application/json:
4318 schema:
4319 $ref: '#/components/schemas/PduInfo'
4320 application/yaml:
4321 schema:
4322 $ref: '#/components/schemas/PduInfo'
4323 '400':
4324 $ref: '#/components/responses/BadRequest'
4325 '401':
4326 $ref: '#/components/responses/Unauthorized'
4327 '403':
4328 $ref: '#/components/responses/Forbidden'
4329 '404':
4330 $ref: '#/components/responses/NotFound'
4331 '405':
4332 $ref: '#/components/responses/MethodNotAllowed'
4333 '406':
4334 $ref: '#/components/responses/NotAcceptable'
4335 '409':
4336 $ref: '#/components/responses/Conflict'
4337 '422':
4338 $ref: '#/components/responses/UnprocessableEntity'
4339 '500':
4340 $ref: '#/components/responses/InternalServerError'
4341 '503':
4342 $ref: '#/components/responses/ServiceUnavailable'
4343 '5XX':
4344 $ref: '#/components/responses/UnexpectedError'
4345 default:
4346 $ref: '#/components/responses/UnexpectedError'
4347 patch:
4348 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]4349 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4350 summary: Modify an individual PDU Descriptor
4351 description: Modify an individual PDU Descriptor
4352 operationId: editPDU
4353 requestBody:
4354 $ref: '#/components/requestBodies/EditPduRequest'
4355 responses:
4356 '204':
4357 description: No Content
4358 '400':
4359 $ref: '#/components/responses/BadRequest'
4360 '401':
4361 $ref: '#/components/responses/Unauthorized'
4362 '403':
4363 $ref: '#/components/responses/Forbidden'
4364 '404':
4365 $ref: '#/components/responses/NotFound'
4366 '405':
4367 $ref: '#/components/responses/MethodNotAllowed'
4368 '406':
4369 $ref: '#/components/responses/NotAcceptable'
4370 '409':
4371 $ref: '#/components/responses/Conflict'
4372 '422':
4373 $ref: '#/components/responses/UnprocessableEntity'
4374 '500':
4375 $ref: '#/components/responses/InternalServerError'
4376 '503':
4377 $ref: '#/components/responses/ServiceUnavailable'
4378 '5XX':
4379 $ref: '#/components/responses/UnexpectedError'
4380 default:
4381 $ref: '#/components/responses/UnexpectedError'
4382 delete:
4383 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +0100[diff] [blame]4384 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]4385 summary: Delete an individual PDU Descriptor
4386 description: Delete an individual PDU Descriptor
4387 operationId: deletePDU
4388 responses:
4389 '204':
4390 description: No Content
4391 '400':
4392 $ref: '#/components/responses/BadRequest'
4393 '401':
4394 $ref: '#/components/responses/Unauthorized'
4395 '403':
4396 $ref: '#/components/responses/Forbidden'
4397 '404':
4398 $ref: '#/components/responses/NotFound'
4399 '405':
4400 $ref: '#/components/responses/MethodNotAllowed'
4401 '406':
4402 $ref: '#/components/responses/NotAcceptable'
4403 '409':
4404 $ref: '#/components/responses/Conflict'
4405 '422':
4406 $ref: '#/components/responses/UnprocessableEntity'
4407 '500':
4408 $ref: '#/components/responses/InternalServerError'
4409 '503':
4410 $ref: '#/components/responses/ServiceUnavailable'
4411 '5XX':
4412 $ref: '#/components/responses/UnexpectedError'
4413 default:
4414 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]4415# END PDU
4416
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame^]4417# BEGIN k8s Cluster
4418 '/k8scluster/v1/clusters':
4419 get:
4420 tags:
4421 - 'K8s Cluster'
4422 summary: Listing All Clusters
4423 description: This API is used to obtain details about all clusters
4424 operationId: listk8sCluster
4425 responses:
4426 '200':
4427 description: OK
4428 '400':
4429 $ref: '#/components/responses/BadRequest'
4430 '401':
4431 $ref: '#/components/responses/Unauthorized'
4432 '403':
4433 $ref: '#/components/responses/Forbidden'
4434 '404':
4435 $ref: '#/components/responses/NotFound'
4436 '405':
4437 $ref: '#/components/responses/MethodNotAllowed'
4438 '406':
4439 $ref: '#/components/responses/NotAcceptable'
4440 '409':
4441 $ref: '#/components/responses/Conflict'
4442 '422':
4443 $ref: '#/components/responses/UnprocessableEntity'
4444 '500':
4445 $ref: '#/components/responses/InternalServerError'
4446 '503':
4447 $ref: '#/components/responses/ServiceUnavailable'
4448 '5XX':
4449 $ref: '#/components/responses/UnexpectedError'
4450 default:
4451 $ref: '#/components/responses/UnexpectedError'
4452 post:
4453 tags:
4454 - "K8s Cluster"
4455 summary: Creating a Cluster
4456 description: This API is used to create cluster
4457 operationId: createk8sCluster
4458 requestBody:
4459 $ref: '#/components/requestBodies/CreateCluster'
4460 responses:
4461 '201':
4462 description: Created
4463 content:
4464 application/json:
4465 schema:
4466 $ref: '#/components/schemas/ObjectId'
4467 application/yaml:
4468 schema:
4469 $ref: '#/components/schemas/ObjectId'
4470 '400':
4471 $ref: '#/components/responses/BadRequest'
4472 '401':
4473 $ref: '#/components/responses/Unauthorized'
4474 '403':
4475 $ref: '#/components/responses/Forbidden'
4476 '404':
4477 $ref: '#/components/responses/NotFound'
4478 '405':
4479 $ref: '#/components/responses/MethodNotAllowed'
4480 '406':
4481 $ref: '#/components/responses/NotAcceptable'
4482 '409':
4483 $ref: '#/components/responses/Conflict'
4484 '422':
4485 $ref: '#/components/responses/UnprocessableEntity'
4486 '500':
4487 $ref: '#/components/responses/InternalServerError'
4488 '503':
4489 $ref: '#/components/responses/ServiceUnavailable'
4490 '5XX':
4491 $ref: '#/components/responses/UnexpectedError'
4492 default:
4493 $ref: '#/components/responses/UnexpectedError'
4494 '/k8scluster/v1/clusters/{cluster_id}':
4495 parameters:
4496 - name: cluster_id
4497 in: path
4498 required: true
4499 description: cluster_id
4500 schema:
4501 type: string
4502 get:
4503 tags:
4504 - 'K8s Cluster'
4505 summary: Reading a Specific Cluster
4506 description: This API is used to obtain details about a specified cluster.
4507 operationId: readk8sCluster
4508 responses:
4509 '200':
4510 description: OK
4511 '400':
4512 $ref: '#/components/responses/BadRequest'
4513 '401':
4514 $ref: '#/components/responses/Unauthorized'
4515 '403':
4516 $ref: '#/components/responses/Forbidden'
4517 '404':
4518 $ref: '#/components/responses/NotFound'
4519 '405':
4520 $ref: '#/components/responses/MethodNotAllowed'
4521 '406':
4522 $ref: '#/components/responses/NotAcceptable'
4523 '409':
4524 $ref: '#/components/responses/Conflict'
4525 '422':
4526 $ref: '#/components/responses/UnprocessableEntity'
4527 '500':
4528 $ref: '#/components/responses/InternalServerError'
4529 '503':
4530 $ref: '#/components/responses/ServiceUnavailable'
4531 '5XX':
4532 $ref: '#/components/responses/UnexpectedError'
4533 default:
4534 $ref: '#/components/responses/UnexpectedError'
4535 delete:
4536 tags:
4537 - "K8s Cluster"
4538 summary: Deleting a Cluster
4539 description: This API is used to delete a specified cluster.
4540 operationId: deletek8sCluster
4541 responses:
4542 '202':
4543 description: Accepted
4544 '400':
4545 $ref: '#/components/responses/BadRequest'
4546 '401':
4547 $ref: '#/components/responses/Unauthorized'
4548 '403':
4549 $ref: '#/components/responses/Forbidden'
4550 '404':
4551 $ref: '#/components/responses/NotFound'
4552 '405':
4553 $ref: '#/components/responses/MethodNotAllowed'
4554 '406':
4555 $ref: '#/components/responses/NotAcceptable'
4556 '409':
4557 $ref: '#/components/responses/Conflict'
4558 '422':
4559 $ref: '#/components/responses/UnprocessableEntity'
4560 '500':
4561 $ref: '#/components/responses/InternalServerError'
4562 '503':
4563 $ref: '#/components/responses/ServiceUnavailable'
4564 '5XX':
4565 $ref: '#/components/responses/UnexpectedError'
4566 default:
4567 $ref: '#/components/responses/UnexpectedError'
4568 '/k8scluster/v1/clusters/{cluster_id}/get_creds':
4569 parameters:
4570 - name: cluster_id
4571 in: path
4572 required: true
4573 description: cluster_id
4574 schema:
4575 type: string
4576 get:
4577 tags:
4578 - "K8s Cluster"
4579 summary: Get Credentials of the cluster
4580 description: This API is used to obtain a kube_config file of a specified cluster.
4581 operationId: getCreds
4582 responses:
4583 '200':
4584 description: OK
4585 '400':
4586 $ref: '#/components/responses/BadRequest'
4587 '401':
4588 $ref: '#/components/responses/Unauthorized'
4589 '403':
4590 $ref: '#/components/responses/Forbidden'
4591 '404':
4592 $ref: '#/components/responses/NotFound'
4593 '405':
4594 $ref: '#/components/responses/MethodNotAllowed'
4595 '406':
4596 $ref: '#/components/responses/NotAcceptable'
4597 '409':
4598 $ref: '#/components/responses/Conflict'
4599 '422':
4600 $ref: '#/components/responses/UnprocessableEntity'
4601 '500':
4602 $ref: '#/components/responses/InternalServerError'
4603 '503':
4604 $ref: '#/components/responses/ServiceUnavailable'
4605 '5XX':
4606 $ref: '#/components/responses/UnexpectedError'
4607 default:
4608 $ref: '#/components/responses/UnexpectedError'
4609 '/k8scluster/v1/clusters/{cluster_id}/scale':
4610 parameters:
4611 - name: cluster_id
4612 in: path
4613 required: true
4614 description: cluster_id
4615 schema:
4616 type: string
4617 post:
4618 tags:
4619 - "K8s Cluster"
4620 summary: Scaling Node
4621 description: This API is used to scale the node into a specified cluster
4622 operationId: nodeScaling
4623 requestBody:
4624 $ref: '#/components/requestBodies/ScaleNode'
4625 responses:
4626 '202':
4627 description: Accepted
4628 '400':
4629 $ref: '#/components/responses/BadRequest'
4630 '401':
4631 $ref: '#/components/responses/Unauthorized'
4632 '403':
4633 $ref: '#/components/responses/Forbidden'
4634 '404':
4635 $ref: '#/components/responses/NotFound'
4636 '405':
4637 $ref: '#/components/responses/MethodNotAllowed'
4638 '406':
4639 $ref: '#/components/responses/NotAcceptable'
4640 '409':
4641 $ref: '#/components/responses/Conflict'
4642 '422':
4643 $ref: '#/components/responses/UnprocessableEntity'
4644 '500':
4645 $ref: '#/components/responses/InternalServerError'
4646 '503':
4647 $ref: '#/components/responses/ServiceUnavailable'
4648 '5XX':
4649 $ref: '#/components/responses/UnexpectedError'
4650 default:
4651 $ref: '#/components/responses/UnexpectedError'
4652 '/k8scluster/v1/clusters/{cluster_id}/upgrade':
4653 parameters:
4654 - name: cluster_id
4655 in: path
4656 required: true
4657 description: cluster_id
4658 schema:
4659 type: string
4660 post:
4661 tags:
4662 - "K8s Cluster"
4663 summary: Upgrading a Cluster
4664 description: This API is used to Upgrade a Cluster
4665 operationId: upgradeCluster
4666 requestBody:
4667 $ref: '#/components/requestBodies/UpgradeCluster'
4668 responses:
4669 '202':
4670 description: Accepted
4671 '400':
4672 $ref: '#/components/responses/BadRequest'
4673 '401':
4674 $ref: '#/components/responses/Unauthorized'
4675 '403':
4676 $ref: '#/components/responses/Forbidden'
4677 '404':
4678 $ref: '#/components/responses/NotFound'
4679 '405':
4680 $ref: '#/components/responses/MethodNotAllowed'
4681 '406':
4682 $ref: '#/components/responses/NotAcceptable'
4683 '409':
4684 $ref: '#/components/responses/Conflict'
4685 '422':
4686 $ref: '#/components/responses/UnprocessableEntity'
4687 '500':
4688 $ref: '#/components/responses/InternalServerError'
4689 '503':
4690 $ref: '#/components/responses/ServiceUnavailable'
4691 '5XX':
4692 $ref: '#/components/responses/UnexpectedError'
4693 default:
4694 $ref: '#/components/responses/UnexpectedError'
4695 '/k8scluster/v1/app_profiles':
4696 post:
4697 tags:
4698 - "K8s Cluster"
4699 summary: Creating App-profiles
4700 description: This API is used to create App-profiles
4701 operationId: createAppProfile
4702 requestBody:
4703 $ref: '#/components/requestBodies/ProfileInfo'
4704 responses:
4705 '201':
4706 description: Created
4707 content:
4708 application/json:
4709 schema:
4710 $ref: '#/components/schemas/ObjectId'
4711 application/yaml:
4712 schema:
4713 $ref: '#/components/schemas/ObjectId'
4714 '400':
4715 $ref: '#/components/responses/BadRequest'
4716 '401':
4717 $ref: '#/components/responses/Unauthorized'
4718 '403':
4719 $ref: '#/components/responses/Forbidden'
4720 '404':
4721 $ref: '#/components/responses/NotFound'
4722 '405':
4723 $ref: '#/components/responses/MethodNotAllowed'
4724 '406':
4725 $ref: '#/components/responses/NotAcceptable'
4726 '409':
4727 $ref: '#/components/responses/Conflict'
4728 '422':
4729 $ref: '#/components/responses/UnprocessableEntity'
4730 '500':
4731 $ref: '#/components/responses/InternalServerError'
4732 '503':
4733 $ref: '#/components/responses/ServiceUnavailable'
4734 '5XX':
4735 $ref: '#/components/responses/UnexpectedError'
4736 default:
4737 $ref: '#/components/responses/UnexpectedError'
4738 get:
4739 tags:
4740 - "K8s Cluster"
4741 summary: Listing App-profiles
4742 description: This API is used to list all App-profiles
4743 operationId: listAppProfile
4744 responses:
4745 '200':
4746 description: OK
4747 '400':
4748 $ref: '#/components/responses/BadRequest'
4749 '401':
4750 $ref: '#/components/responses/Unauthorized'
4751 '403':
4752 $ref: '#/components/responses/Forbidden'
4753 '404':
4754 $ref: '#/components/responses/NotFound'
4755 '405':
4756 $ref: '#/components/responses/MethodNotAllowed'
4757 '406':
4758 $ref: '#/components/responses/NotAcceptable'
4759 '409':
4760 $ref: '#/components/responses/Conflict'
4761 '422':
4762 $ref: '#/components/responses/UnprocessableEntity'
4763 '500':
4764 $ref: '#/components/responses/InternalServerError'
4765 '503':
4766 $ref: '#/components/responses/ServiceUnavailable'
4767 '5XX':
4768 $ref: '#/components/responses/UnexpectedError'
4769 default:
4770 $ref: '#/components/responses/UnexpectedError'
4771 '/k8scluster/v1/app_profiles/{app_profile_id}':
4772 parameters:
4773 - name: app_profile_id
4774 in: path
4775 required: true
4776 description: app_profile_id
4777 schema:
4778 type: string
4779 get:
4780 tags:
4781 - "K8s Cluster"
4782 summary: Reading App-profiles
4783 description: This API is used to reading specific App-profile
4784 operationId: readAppProfile
4785 responses:
4786 '200':
4787 description: OK
4788 '400':
4789 $ref: '#/components/responses/BadRequest'
4790 '401':
4791 $ref: '#/components/responses/Unauthorized'
4792 '403':
4793 $ref: '#/components/responses/Forbidden'
4794 '404':
4795 $ref: '#/components/responses/NotFound'
4796 '405':
4797 $ref: '#/components/responses/MethodNotAllowed'
4798 '406':
4799 $ref: '#/components/responses/NotAcceptable'
4800 '409':
4801 $ref: '#/components/responses/Conflict'
4802 '422':
4803 $ref: '#/components/responses/UnprocessableEntity'
4804 '500':
4805 $ref: '#/components/responses/InternalServerError'
4806 '503':
4807 $ref: '#/components/responses/ServiceUnavailable'
4808 '5XX':
4809 $ref: '#/components/responses/UnexpectedError'
4810 default:
4811 $ref: '#/components/responses/UnexpectedError'
4812 patch:
4813 tags:
4814 - "K8s Cluster"
4815 summary: Patching App-profiles
4816 description: This API is used to patch specific App-profile
4817 operationId: patchAppProfile
4818 requestBody:
4819 $ref: '#/components/requestBodies/ProfileInfo'
4820 responses:
4821 '202':
4822 description: Accepted
4823 '400':
4824 $ref: '#/components/responses/BadRequest'
4825 '401':
4826 $ref: '#/components/responses/Unauthorized'
4827 '403':
4828 $ref: '#/components/responses/Forbidden'
4829 '404':
4830 $ref: '#/components/responses/NotFound'
4831 '405':
4832 $ref: '#/components/responses/MethodNotAllowed'
4833 '406':
4834 $ref: '#/components/responses/NotAcceptable'
4835 '409':
4836 $ref: '#/components/responses/Conflict'
4837 '422':
4838 $ref: '#/components/responses/UnprocessableEntity'
4839 '500':
4840 $ref: '#/components/responses/InternalServerError'
4841 '503':
4842 $ref: '#/components/responses/ServiceUnavailable'
4843 '5XX':
4844 $ref: '#/components/responses/UnexpectedError'
4845 default:
4846 $ref: '#/components/responses/UnexpectedError'
4847 delete:
4848 tags:
4849 - "K8s Cluster"
4850 summary: Deleteing App-profiles
4851 description: This API is used to delete specific App-profile
4852 operationId: deleteAppProfile
4853 responses:
4854 '202':
4855 description: Accepted
4856 '400':
4857 $ref: '#/components/responses/BadRequest'
4858 '401':
4859 $ref: '#/components/responses/Unauthorized'
4860 '403':
4861 $ref: '#/components/responses/Forbidden'
4862 '404':
4863 $ref: '#/components/responses/NotFound'
4864 '405':
4865 $ref: '#/components/responses/MethodNotAllowed'
4866 '406':
4867 $ref: '#/components/responses/NotAcceptable'
4868 '409':
4869 $ref: '#/components/responses/Conflict'
4870 '422':
4871 $ref: '#/components/responses/UnprocessableEntity'
4872 '500':
4873 $ref: '#/components/responses/InternalServerError'
4874 '503':
4875 $ref: '#/components/responses/ServiceUnavailable'
4876 '5XX':
4877 $ref: '#/components/responses/UnexpectedError'
4878 default:
4879 $ref: '#/components/responses/UnexpectedError'
4880 '/k8scluster/v1/clusters/{cluster_id}/app_profiles':
4881 parameters:
4882 - name: cluster_id
4883 in: path
4884 required: true
4885 description: cluster_id
4886 schema:
4887 type: string
4888 patch:
4889 tags:
4890 - "K8s Cluster"
4891 summary: Adding or Removing App profile to cluster
4892 description: This API is used to add or remove app profiles to cluster
4893 operationId: addRemoveAppProfile
4894 requestBody:
4895 $ref: '#/components/requestBodies/AttachDetachProfile'
4896 responses:
4897 '202':
4898 description: Accepted
4899 '400':
4900 $ref: '#/components/responses/BadRequest'
4901 '401':
4902 $ref: '#/components/responses/Unauthorized'
4903 '403':
4904 $ref: '#/components/responses/Forbidden'
4905 '404':
4906 $ref: '#/components/responses/NotFound'
4907 '405':
4908 $ref: '#/components/responses/MethodNotAllowed'
4909 '406':
4910 $ref: '#/components/responses/NotAcceptable'
4911 '409':
4912 $ref: '#/components/responses/Conflict'
4913 '422':
4914 $ref: '#/components/responses/UnprocessableEntity'
4915 '500':
4916 $ref: '#/components/responses/InternalServerError'
4917 '503':
4918 $ref: '#/components/responses/ServiceUnavailable'
4919 '5XX':
4920 $ref: '#/components/responses/UnexpectedError'
4921 default:
4922 $ref: '#/components/responses/UnexpectedError'
4923 get:
4924 tags:
4925 - "K8s Cluster"
4926 summary: Getting App-profile in cluster
4927 description: This API is used to get app-profiles in specified cluster
4928 operationId: getAppProfile
4929 responses:
4930 '200':
4931 description: OK
4932 '400':
4933 $ref: '#/components/responses/BadRequest'
4934 '401':
4935 $ref: '#/components/responses/Unauthorized'
4936 '403':
4937 $ref: '#/components/responses/Forbidden'
4938 '404':
4939 $ref: '#/components/responses/NotFound'
4940 '405':
4941 $ref: '#/components/responses/MethodNotAllowed'
4942 '406':
4943 $ref: '#/components/responses/NotAcceptable'
4944 '409':
4945 $ref: '#/components/responses/Conflict'
4946 '422':
4947 $ref: '#/components/responses/UnprocessableEntity'
4948 '500':
4949 $ref: '#/components/responses/InternalServerError'
4950 '503':
4951 $ref: '#/components/responses/ServiceUnavailable'
4952 '5XX':
4953 $ref: '#/components/responses/UnexpectedError'
4954 default:
4955 $ref: '#/components/responses/UnexpectedError'
4956 '/k8scluster/v1/infra_controller_profiles':
4957 post:
4958 tags:
4959 - "K8s Cluster"
4960 summary: Creating Infra controller profiles
4961 description: This API is used to create Infra controllerprofiles
4962 operationId: createInfraControllerProfile
4963 requestBody:
4964 $ref: '#/components/requestBodies/ProfileInfo'
4965 responses:
4966 '201':
4967 description: Created
4968 content:
4969 application/json:
4970 schema:
4971 $ref: '#/components/schemas/ObjectId'
4972 application/yaml:
4973 schema:
4974 $ref: '#/components/schemas/ObjectId'
4975 '400':
4976 $ref: '#/components/responses/BadRequest'
4977 '401':
4978 $ref: '#/components/responses/Unauthorized'
4979 '403':
4980 $ref: '#/components/responses/Forbidden'
4981 '404':
4982 $ref: '#/components/responses/NotFound'
4983 '405':
4984 $ref: '#/components/responses/MethodNotAllowed'
4985 '406':
4986 $ref: '#/components/responses/NotAcceptable'
4987 '409':
4988 $ref: '#/components/responses/Conflict'
4989 '422':
4990 $ref: '#/components/responses/UnprocessableEntity'
4991 '500':
4992 $ref: '#/components/responses/InternalServerError'
4993 '503':
4994 $ref: '#/components/responses/ServiceUnavailable'
4995 '5XX':
4996 $ref: '#/components/responses/UnexpectedError'
4997 default:
4998 $ref: '#/components/responses/UnexpectedError'
4999 get:
5000 tags:
5001 - "K8s Cluster"
5002 summary: Listing Infra controller profiles
5003 description: This API is used to list all Infra controller profiles
5004 operationId: listInfraControllerProfile
5005 responses:
5006 '200':
5007 description: OK
5008 '400':
5009 $ref: '#/components/responses/BadRequest'
5010 '401':
5011 $ref: '#/components/responses/Unauthorized'
5012 '403':
5013 $ref: '#/components/responses/Forbidden'
5014 '404':
5015 $ref: '#/components/responses/NotFound'
5016 '405':
5017 $ref: '#/components/responses/MethodNotAllowed'
5018 '406':
5019 $ref: '#/components/responses/NotAcceptable'
5020 '409':
5021 $ref: '#/components/responses/Conflict'
5022 '422':
5023 $ref: '#/components/responses/UnprocessableEntity'
5024 '500':
5025 $ref: '#/components/responses/InternalServerError'
5026 '503':
5027 $ref: '#/components/responses/ServiceUnavailable'
5028 '5XX':
5029 $ref: '#/components/responses/UnexpectedError'
5030 default:
5031 $ref: '#/components/responses/UnexpectedError'
5032 '/k8scluster/v1/infra_controller_profiles/{infra_controller_profile_id}':
5033 parameters:
5034 - name: infra_controller_profile_id
5035 in: path
5036 required: true
5037 description: infra_controller_profile_id
5038 schema:
5039 type: string
5040 get:
5041 tags:
5042 - "K8s Cluster"
5043 summary: Reading Infra controller profiles
5044 description: This API is used to reading specific Infra controller profile
5045 operationId: readInfraControllerProfile
5046 responses:
5047 '200':
5048 description: OK
5049 '400':
5050 $ref: '#/components/responses/BadRequest'
5051 '401':
5052 $ref: '#/components/responses/Unauthorized'
5053 '403':
5054 $ref: '#/components/responses/Forbidden'
5055 '404':
5056 $ref: '#/components/responses/NotFound'
5057 '405':
5058 $ref: '#/components/responses/MethodNotAllowed'
5059 '406':
5060 $ref: '#/components/responses/NotAcceptable'
5061 '409':
5062 $ref: '#/components/responses/Conflict'
5063 '422':
5064 $ref: '#/components/responses/UnprocessableEntity'
5065 '500':
5066 $ref: '#/components/responses/InternalServerError'
5067 '503':
5068 $ref: '#/components/responses/ServiceUnavailable'
5069 '5XX':
5070 $ref: '#/components/responses/UnexpectedError'
5071 default:
5072 $ref: '#/components/responses/UnexpectedError'
5073 patch:
5074 tags:
5075 - "K8s Cluster"
5076 summary: Patching Infra controller profiles
5077 description: This API is used to patch specific Infra controller profile
5078 operationId: patchInfraControllerProfile
5079 requestBody:
5080 $ref: '#/components/requestBodies/ProfileInfo'
5081 responses:
5082 '202':
5083 description: Accepted
5084 '400':
5085 $ref: '#/components/responses/BadRequest'
5086 '401':
5087 $ref: '#/components/responses/Unauthorized'
5088 '403':
5089 $ref: '#/components/responses/Forbidden'
5090 '404':
5091 $ref: '#/components/responses/NotFound'
5092 '405':
5093 $ref: '#/components/responses/MethodNotAllowed'
5094 '406':
5095 $ref: '#/components/responses/NotAcceptable'
5096 '409':
5097 $ref: '#/components/responses/Conflict'
5098 '422':
5099 $ref: '#/components/responses/UnprocessableEntity'
5100 '500':
5101 $ref: '#/components/responses/InternalServerError'
5102 '503':
5103 $ref: '#/components/responses/ServiceUnavailable'
5104 '5XX':
5105 $ref: '#/components/responses/UnexpectedError'
5106 default:
5107 $ref: '#/components/responses/UnexpectedError'
5108 delete:
5109 tags:
5110 - "K8s Cluster"
5111 summary: Deleteing Infra controller profiles
5112 description: This API is used to delete specific Infra controller profile
5113 operationId: deleteInfraControllerProfile
5114 responses:
5115 '202':
5116 description: Accepted
5117 '400':
5118 $ref: '#/components/responses/BadRequest'
5119 '401':
5120 $ref: '#/components/responses/Unauthorized'
5121 '403':
5122 $ref: '#/components/responses/Forbidden'
5123 '404':
5124 $ref: '#/components/responses/NotFound'
5125 '405':
5126 $ref: '#/components/responses/MethodNotAllowed'
5127 '406':
5128 $ref: '#/components/responses/NotAcceptable'
5129 '409':
5130 $ref: '#/components/responses/Conflict'
5131 '422':
5132 $ref: '#/components/responses/UnprocessableEntity'
5133 '500':
5134 $ref: '#/components/responses/InternalServerError'
5135 '503':
5136 $ref: '#/components/responses/ServiceUnavailable'
5137 '5XX':
5138 $ref: '#/components/responses/UnexpectedError'
5139 default:
5140 $ref: '#/components/responses/UnexpectedError'
5141 '/k8scluster/v1/clusters/{cluster_id}/infra_controller_profiles':
5142 parameters:
5143 - name: cluster_id
5144 in: path
5145 required: true
5146 description: cluster_id
5147 schema:
5148 type: string
5149 patch:
5150 tags:
5151 - "K8s Cluster"
5152 summary: Adding or Removing Infra controller profile to cluster
5153 description: This API is used to add or remove infra controller profile to cluster
5154 operationId: addremoveInfraControllerProfile
5155 requestBody:
5156 $ref: '#/components/requestBodies/AttachDetachProfile'
5157 responses:
5158 '202':
5159 description: Accepted
5160 '400':
5161 $ref: '#/components/responses/BadRequest'
5162 '401':
5163 $ref: '#/components/responses/Unauthorized'
5164 '403':
5165 $ref: '#/components/responses/Forbidden'
5166 '404':
5167 $ref: '#/components/responses/NotFound'
5168 '405':
5169 $ref: '#/components/responses/MethodNotAllowed'
5170 '406':
5171 $ref: '#/components/responses/NotAcceptable'
5172 '409':
5173 $ref: '#/components/responses/Conflict'
5174 '422':
5175 $ref: '#/components/responses/UnprocessableEntity'
5176 '500':
5177 $ref: '#/components/responses/InternalServerError'
5178 '503':
5179 $ref: '#/components/responses/ServiceUnavailable'
5180 '5XX':
5181 $ref: '#/components/responses/UnexpectedError'
5182 default:
5183 $ref: '#/components/responses/UnexpectedError'
5184 get:
5185 tags:
5186 - "K8s Cluster"
5187 summary: Getting Infra controller profile in cluster
5188 description: This API is used to get infra controller profiles in specified cluster
5189 operationId: getInfraControllerProfile
5190 responses:
5191 '200':
5192 description: OK
5193 '400':
5194 $ref: '#/components/responses/BadRequest'
5195 '401':
5196 $ref: '#/components/responses/Unauthorized'
5197 '403':
5198 $ref: '#/components/responses/Forbidden'
5199 '404':
5200 $ref: '#/components/responses/NotFound'
5201 '405':
5202 $ref: '#/components/responses/MethodNotAllowed'
5203 '406':
5204 $ref: '#/components/responses/NotAcceptable'
5205 '409':
5206 $ref: '#/components/responses/Conflict'
5207 '422':
5208 $ref: '#/components/responses/UnprocessableEntity'
5209 '500':
5210 $ref: '#/components/responses/InternalServerError'
5211 '503':
5212 $ref: '#/components/responses/ServiceUnavailable'
5213 '5XX':
5214 $ref: '#/components/responses/UnexpectedError'
5215 default:
5216 $ref: '#/components/responses/UnexpectedError'
5217 '/k8scluster/v1/infra_config_profiles':
5218 post:
5219 tags:
5220 - "K8s Cluster"
5221 summary: Creating Infra config profiles
5222 description: This API is used to create Infra config profiles
5223 operationId: createInfraConfigProfile
5224 requestBody:
5225 $ref: '#/components/requestBodies/ProfileInfo'
5226 responses:
5227 '201':
5228 description: Created
5229 content:
5230 application/json:
5231 schema:
5232 $ref: '#/components/schemas/ObjectId'
5233 application/yaml:
5234 schema:
5235 $ref: '#/components/schemas/ObjectId'
5236 '400':
5237 $ref: '#/components/responses/BadRequest'
5238 '401':
5239 $ref: '#/components/responses/Unauthorized'
5240 '403':
5241 $ref: '#/components/responses/Forbidden'
5242 '404':
5243 $ref: '#/components/responses/NotFound'
5244 '405':
5245 $ref: '#/components/responses/MethodNotAllowed'
5246 '406':
5247 $ref: '#/components/responses/NotAcceptable'
5248 '409':
5249 $ref: '#/components/responses/Conflict'
5250 '422':
5251 $ref: '#/components/responses/UnprocessableEntity'
5252 '500':
5253 $ref: '#/components/responses/InternalServerError'
5254 '503':
5255 $ref: '#/components/responses/ServiceUnavailable'
5256 '5XX':
5257 $ref: '#/components/responses/UnexpectedError'
5258 default:
5259 $ref: '#/components/responses/UnexpectedError'
5260 get:
5261 tags:
5262 - "K8s Cluster"
5263 summary: Listing Infra config profiles
5264 description: This API is used to list all Infra config profiles
5265 operationId: listInfraConfigProfile
5266 responses:
5267 '200':
5268 description: OK
5269 '400':
5270 $ref: '#/components/responses/BadRequest'
5271 '401':
5272 $ref: '#/components/responses/Unauthorized'
5273 '403':
5274 $ref: '#/components/responses/Forbidden'
5275 '404':
5276 $ref: '#/components/responses/NotFound'
5277 '405':
5278 $ref: '#/components/responses/MethodNotAllowed'
5279 '406':
5280 $ref: '#/components/responses/NotAcceptable'
5281 '409':
5282 $ref: '#/components/responses/Conflict'
5283 '422':
5284 $ref: '#/components/responses/UnprocessableEntity'
5285 '500':
5286 $ref: '#/components/responses/InternalServerError'
5287 '503':
5288 $ref: '#/components/responses/ServiceUnavailable'
5289 '5XX':
5290 $ref: '#/components/responses/UnexpectedError'
5291 default:
5292 $ref: '#/components/responses/UnexpectedError'
5293 '/k8scluster/v1/infra_config_profiles/{infra_config_profile_id}':
5294 parameters:
5295 - name: infra_config_profile_id
5296 in: path
5297 required: true
5298 description: infra_config_profile_id
5299 schema:
5300 type: string
5301 get:
5302 tags:
5303 - "K8s Cluster"
5304 summary: Reading Infra config profiles
5305 description: This API is used to reading specific Infra config profile
5306 operationId: readInfraConfigProfile
5307 responses:
5308 '200':
5309 description: OK
5310 '400':
5311 $ref: '#/components/responses/BadRequest'
5312 '401':
5313 $ref: '#/components/responses/Unauthorized'
5314 '403':
5315 $ref: '#/components/responses/Forbidden'
5316 '404':
5317 $ref: '#/components/responses/NotFound'
5318 '405':
5319 $ref: '#/components/responses/MethodNotAllowed'
5320 '406':
5321 $ref: '#/components/responses/NotAcceptable'
5322 '409':
5323 $ref: '#/components/responses/Conflict'
5324 '422':
5325 $ref: '#/components/responses/UnprocessableEntity'
5326 '500':
5327 $ref: '#/components/responses/InternalServerError'
5328 '503':
5329 $ref: '#/components/responses/ServiceUnavailable'
5330 '5XX':
5331 $ref: '#/components/responses/UnexpectedError'
5332 default:
5333 $ref: '#/components/responses/UnexpectedError'
5334 patch:
5335 tags:
5336 - "K8s Cluster"
5337 summary: Patching Infra config profiles
5338 description: This API is used to patch specific Infra config profile
5339 operationId: patchInfraConfigProfile
5340 requestBody:
5341 $ref: '#/components/requestBodies/ProfileInfo'
5342 responses:
5343 '202':
5344 description: Accepted
5345 '400':
5346 $ref: '#/components/responses/BadRequest'
5347 '401':
5348 $ref: '#/components/responses/Unauthorized'
5349 '403':
5350 $ref: '#/components/responses/Forbidden'
5351 '404':
5352 $ref: '#/components/responses/NotFound'
5353 '405':
5354 $ref: '#/components/responses/MethodNotAllowed'
5355 '406':
5356 $ref: '#/components/responses/NotAcceptable'
5357 '409':
5358 $ref: '#/components/responses/Conflict'
5359 '422':
5360 $ref: '#/components/responses/UnprocessableEntity'
5361 '500':
5362 $ref: '#/components/responses/InternalServerError'
5363 '503':
5364 $ref: '#/components/responses/ServiceUnavailable'
5365 '5XX':
5366 $ref: '#/components/responses/UnexpectedError'
5367 default:
5368 $ref: '#/components/responses/UnexpectedError'
5369 delete:
5370 tags:
5371 - "K8s Cluster"
5372 summary: Deleteing Infra config profiles
5373 description: This API is used to delete specific Infra config profile
5374 operationId: deleteInfraConfigProfile
5375 responses:
5376 '202':
5377 description: Accepted
5378 '400':
5379 $ref: '#/components/responses/BadRequest'
5380 '401':
5381 $ref: '#/components/responses/Unauthorized'
5382 '403':
5383 $ref: '#/components/responses/Forbidden'
5384 '404':
5385 $ref: '#/components/responses/NotFound'
5386 '405':
5387 $ref: '#/components/responses/MethodNotAllowed'
5388 '406':
5389 $ref: '#/components/responses/NotAcceptable'
5390 '409':
5391 $ref: '#/components/responses/Conflict'
5392 '422':
5393 $ref: '#/components/responses/UnprocessableEntity'
5394 '500':
5395 $ref: '#/components/responses/InternalServerError'
5396 '503':
5397 $ref: '#/components/responses/ServiceUnavailable'
5398 '5XX':
5399 $ref: '#/components/responses/UnexpectedError'
5400 default:
5401 $ref: '#/components/responses/UnexpectedError'
5402 '/k8scluster/v1/clusters/{cluster_id}/infra_config_profiles':
5403 parameters:
5404 - name: cluster_id
5405 in: path
5406 required: true
5407 description: cluster_id
5408 schema:
5409 type: string
5410 patch:
5411 tags:
5412 - "K8s Cluster"
5413 summary: Adding or Removing Infra config profile to cluster
5414 description: This API is used to add or remove infra config profile to cluster
5415 operationId: addremoveInfraConfigProfile
5416 requestBody:
5417 $ref: '#/components/requestBodies/AttachDetachProfile'
5418 responses:
5419 '202':
5420 description: Accepted
5421 '400':
5422 $ref: '#/components/responses/BadRequest'
5423 '401':
5424 $ref: '#/components/responses/Unauthorized'
5425 '403':
5426 $ref: '#/components/responses/Forbidden'
5427 '404':
5428 $ref: '#/components/responses/NotFound'
5429 '405':
5430 $ref: '#/components/responses/MethodNotAllowed'
5431 '406':
5432 $ref: '#/components/responses/NotAcceptable'
5433 '409':
5434 $ref: '#/components/responses/Conflict'
5435 '422':
5436 $ref: '#/components/responses/UnprocessableEntity'
5437 '500':
5438 $ref: '#/components/responses/InternalServerError'
5439 '503':
5440 $ref: '#/components/responses/ServiceUnavailable'
5441 '5XX':
5442 $ref: '#/components/responses/UnexpectedError'
5443 default:
5444 $ref: '#/components/responses/UnexpectedError'
5445 get:
5446 tags:
5447 - "K8s Cluster"
5448 summary: Getting Infra config profile in cluster
5449 description: This API is used to get infra config profiles in specified cluster
5450 operationId: getInfraConfigProfile
5451 responses:
5452 '200':
5453 description: OK
5454 '400':
5455 $ref: '#/components/responses/BadRequest'
5456 '401':
5457 $ref: '#/components/responses/Unauthorized'
5458 '403':
5459 $ref: '#/components/responses/Forbidden'
5460 '404':
5461 $ref: '#/components/responses/NotFound'
5462 '405':
5463 $ref: '#/components/responses/MethodNotAllowed'
5464 '406':
5465 $ref: '#/components/responses/NotAcceptable'
5466 '409':
5467 $ref: '#/components/responses/Conflict'
5468 '422':
5469 $ref: '#/components/responses/UnprocessableEntity'
5470 '500':
5471 $ref: '#/components/responses/InternalServerError'
5472 '503':
5473 $ref: '#/components/responses/ServiceUnavailable'
5474 '5XX':
5475 $ref: '#/components/responses/UnexpectedError'
5476 default:
5477 $ref: '#/components/responses/UnexpectedError'
5478 '/k8scluster/v1/resource_profiles':
5479 post:
5480 tags:
5481 - "K8s Cluster"
5482 summary: Creating resource profiles
5483 description: This API is used to create resource profiles
5484 operationId: createResourceProfile
5485 requestBody:
5486 $ref: '#/components/requestBodies/ProfileInfo'
5487 responses:
5488 '201':
5489 description: Created
5490 content:
5491 application/json:
5492 schema:
5493 $ref: '#/components/schemas/ObjectId'
5494 application/yaml:
5495 schema:
5496 $ref: '#/components/schemas/ObjectId'
5497 '400':
5498 $ref: '#/components/responses/BadRequest'
5499 '401':
5500 $ref: '#/components/responses/Unauthorized'
5501 '403':
5502 $ref: '#/components/responses/Forbidden'
5503 '404':
5504 $ref: '#/components/responses/NotFound'
5505 '405':
5506 $ref: '#/components/responses/MethodNotAllowed'
5507 '406':
5508 $ref: '#/components/responses/NotAcceptable'
5509 '409':
5510 $ref: '#/components/responses/Conflict'
5511 '422':
5512 $ref: '#/components/responses/UnprocessableEntity'
5513 '500':
5514 $ref: '#/components/responses/InternalServerError'
5515 '503':
5516 $ref: '#/components/responses/ServiceUnavailable'
5517 '5XX':
5518 $ref: '#/components/responses/UnexpectedError'
5519 default:
5520 $ref: '#/components/responses/UnexpectedError'
5521 get:
5522 tags:
5523 - "K8s Cluster"
5524 summary: Listing resource profiles
5525 description: This API is used to list all resource profiles
5526 operationId: listResourceProfile
5527 responses:
5528 '200':
5529 description: OK
5530 '400':
5531 $ref: '#/components/responses/BadRequest'
5532 '401':
5533 $ref: '#/components/responses/Unauthorized'
5534 '403':
5535 $ref: '#/components/responses/Forbidden'
5536 '404':
5537 $ref: '#/components/responses/NotFound'
5538 '405':
5539 $ref: '#/components/responses/MethodNotAllowed'
5540 '406':
5541 $ref: '#/components/responses/NotAcceptable'
5542 '409':
5543 $ref: '#/components/responses/Conflict'
5544 '422':
5545 $ref: '#/components/responses/UnprocessableEntity'
5546 '500':
5547 $ref: '#/components/responses/InternalServerError'
5548 '503':
5549 $ref: '#/components/responses/ServiceUnavailable'
5550 '5XX':
5551 $ref: '#/components/responses/UnexpectedError'
5552 default:
5553 $ref: '#/components/responses/UnexpectedError'
5554 '/k8scluster/v1/resource_profiles/{resource_profile_id}':
5555 parameters:
5556 - name: resource_profile_id
5557 in: path
5558 required: true
5559 description: resource_profile_id
5560 schema:
5561 type: string
5562 get:
5563 tags:
5564 - "K8s Cluster"
5565 summary: Reading resource profiles
5566 description: This API is used to reading specific resource profile
5567 operationId: readResourceProfile
5568 responses:
5569 '200':
5570 description: OK
5571 '400':
5572 $ref: '#/components/responses/BadRequest'
5573 '401':
5574 $ref: '#/components/responses/Unauthorized'
5575 '403':
5576 $ref: '#/components/responses/Forbidden'
5577 '404':
5578 $ref: '#/components/responses/NotFound'
5579 '405':
5580 $ref: '#/components/responses/MethodNotAllowed'
5581 '406':
5582 $ref: '#/components/responses/NotAcceptable'
5583 '409':
5584 $ref: '#/components/responses/Conflict'
5585 '422':
5586 $ref: '#/components/responses/UnprocessableEntity'
5587 '500':
5588 $ref: '#/components/responses/InternalServerError'
5589 '503':
5590 $ref: '#/components/responses/ServiceUnavailable'
5591 '5XX':
5592 $ref: '#/components/responses/UnexpectedError'
5593 default:
5594 $ref: '#/components/responses/UnexpectedError'
5595 patch:
5596 tags:
5597 - "K8s Cluster"
5598 summary: Patching resource profiles
5599 description: This API is used to patch specific resource profile
5600 operationId: patchResourceProfile
5601 requestBody:
5602 $ref: '#/components/requestBodies/ProfileInfo'
5603 responses:
5604 '202':
5605 description: Accepted
5606 '400':
5607 $ref: '#/components/responses/BadRequest'
5608 '401':
5609 $ref: '#/components/responses/Unauthorized'
5610 '403':
5611 $ref: '#/components/responses/Forbidden'
5612 '404':
5613 $ref: '#/components/responses/NotFound'
5614 '405':
5615 $ref: '#/components/responses/MethodNotAllowed'
5616 '406':
5617 $ref: '#/components/responses/NotAcceptable'
5618 '409':
5619 $ref: '#/components/responses/Conflict'
5620 '422':
5621 $ref: '#/components/responses/UnprocessableEntity'
5622 '500':
5623 $ref: '#/components/responses/InternalServerError'
5624 '503':
5625 $ref: '#/components/responses/ServiceUnavailable'
5626 '5XX':
5627 $ref: '#/components/responses/UnexpectedError'
5628 default:
5629 $ref: '#/components/responses/UnexpectedError'
5630 delete:
5631 tags:
5632 - "K8s Cluster"
5633 summary: Deleteing resource profiles
5634 description: This API is used to delete specific resource profile
5635 operationId: deleteResourceProfile
5636 responses:
5637 '202':
5638 description: Accepted
5639 '400':
5640 $ref: '#/components/responses/BadRequest'
5641 '401':
5642 $ref: '#/components/responses/Unauthorized'
5643 '403':
5644 $ref: '#/components/responses/Forbidden'
5645 '404':
5646 $ref: '#/components/responses/NotFound'
5647 '405':
5648 $ref: '#/components/responses/MethodNotAllowed'
5649 '406':
5650 $ref: '#/components/responses/NotAcceptable'
5651 '409':
5652 $ref: '#/components/responses/Conflict'
5653 '422':
5654 $ref: '#/components/responses/UnprocessableEntity'
5655 '500':
5656 $ref: '#/components/responses/InternalServerError'
5657 '503':
5658 $ref: '#/components/responses/ServiceUnavailable'
5659 '5XX':
5660 $ref: '#/components/responses/UnexpectedError'
5661 default:
5662 $ref: '#/components/responses/UnexpectedError'
5663 '/k8scluster/v1/clusters/{cluster_id}/resource_profiles':
5664 parameters:
5665 - name: cluster_id
5666 in: path
5667 required: true
5668 description: cluster_id
5669 schema:
5670 type: string
5671 patch:
5672 tags:
5673 - "K8s Cluster"
5674 summary: Adding or Removing Resource profile to cluster
5675 description: This API is used to add or remove resource profiles to cluster
5676 operationId: addremoveResourceProfile
5677 requestBody:
5678 $ref: '#/components/requestBodies/AttachDetachProfile'
5679 responses:
5680 '202':
5681 description: Accepted
5682 '400':
5683 $ref: '#/components/responses/BadRequest'
5684 '401':
5685 $ref: '#/components/responses/Unauthorized'
5686 '403':
5687 $ref: '#/components/responses/Forbidden'
5688 '404':
5689 $ref: '#/components/responses/NotFound'
5690 '405':
5691 $ref: '#/components/responses/MethodNotAllowed'
5692 '406':
5693 $ref: '#/components/responses/NotAcceptable'
5694 '409':
5695 $ref: '#/components/responses/Conflict'
5696 '422':
5697 $ref: '#/components/responses/UnprocessableEntity'
5698 '500':
5699 $ref: '#/components/responses/InternalServerError'
5700 '503':
5701 $ref: '#/components/responses/ServiceUnavailable'
5702 '5XX':
5703 $ref: '#/components/responses/UnexpectedError'
5704 default:
5705 $ref: '#/components/responses/UnexpectedError'
5706 get:
5707 tags:
5708 - "K8s Cluster"
5709 summary: Getting Resource profile in cluster
5710 description: This API is used to get resource profiles in specified cluster
5711 operationId: getResourceProfile
5712 responses:
5713 '200':
5714 description: OK
5715 '400':
5716 $ref: '#/components/responses/BadRequest'
5717 '401':
5718 $ref: '#/components/responses/Unauthorized'
5719 '403':
5720 $ref: '#/components/responses/Forbidden'
5721 '404':
5722 $ref: '#/components/responses/NotFound'
5723 '405':
5724 $ref: '#/components/responses/MethodNotAllowed'
5725 '406':
5726 $ref: '#/components/responses/NotAcceptable'
5727 '409':
5728 $ref: '#/components/responses/Conflict'
5729 '422':
5730 $ref: '#/components/responses/UnprocessableEntity'
5731 '500':
5732 $ref: '#/components/responses/InternalServerError'
5733 '503':
5734 $ref: '#/components/responses/ServiceUnavailable'
5735 '5XX':
5736 $ref: '#/components/responses/UnexpectedError'
5737 default:
5738 $ref: '#/components/responses/UnexpectedError'
5739#END k8s Cluster
5740
5741# BEGIN OKA packages
5742 '/oka/v1/oka_packages':
5743 get:
5744 tags:
5745 - "OKA packages"
5746 summary: List OKA package
5747 description: This API is used to List OKA packages
5748 operationId: getOKAPackage
5749 responses:
5750 '200':
5751 description: OK
5752 '400':
5753 $ref: '#/components/responses/BadRequest'
5754 '401':
5755 $ref: '#/components/responses/Unauthorized'
5756 '403':
5757 $ref: '#/components/responses/Forbidden'
5758 '404':
5759 $ref: '#/components/responses/NotFound'
5760 '405':
5761 $ref: '#/components/responses/MethodNotAllowed'
5762 '406':
5763 $ref: '#/components/responses/NotAcceptable'
5764 '409':
5765 $ref: '#/components/responses/Conflict'
5766 '422':
5767 $ref: '#/components/responses/UnprocessableEntity'
5768 '500':
5769 $ref: '#/components/responses/InternalServerError'
5770 '503':
5771 $ref: '#/components/responses/ServiceUnavailable'
5772 '5XX':
5773 $ref: '#/components/responses/UnexpectedError'
5774 default:
5775 $ref: '#/components/responses/UnexpectedError'
5776 post:
5777 tags:
5778 - "OKA packages"
5779 summary: Add OKA package
5780 description: This API is used to add OKA packages
5781 operationId: addOKAPackage
5782 requestBody:
5783 content:
5784 application/zip:
5785 schema:
5786 $ref: '#/components/schemas/OkaPackage'
5787 responses:
5788 '201':
5789 description: Created
5790 content:
5791 application/json:
5792 schema:
5793 $ref: '#/components/schemas/ObjectId'
5794 application/yaml:
5795 schema:
5796 $ref: '#/components/schemas/ObjectId'
5797 '400':
5798 $ref: '#/components/responses/BadRequest'
5799 '401':
5800 $ref: '#/components/responses/Unauthorized'
5801 '403':
5802 $ref: '#/components/responses/Forbidden'
5803 '404':
5804 $ref: '#/components/responses/NotFound'
5805 '405':
5806 $ref: '#/components/responses/MethodNotAllowed'
5807 '406':
5808 $ref: '#/components/responses/NotAcceptable'
5809 '409':
5810 $ref: '#/components/responses/Conflict'
5811 '422':
5812 $ref: '#/components/responses/UnprocessableEntity'
5813 '500':
5814 $ref: '#/components/responses/InternalServerError'
5815 '503':
5816 $ref: '#/components/responses/ServiceUnavailable'
5817 '5XX':
5818 $ref: '#/components/responses/UnexpectedError'
5819 default:
5820 $ref: '#/components/responses/UnexpectedError'
5821 '/oka/v1/oka_packages/{oka_pkg_id}':
5822 parameters:
5823 - name: oka_pkg_id
5824 in: path
5825 required: true
5826 description: oka_pkg_id
5827 schema:
5828 type: string
5829 get:
5830 tags:
5831 - "OKA packages"
5832 summary: Read OKA package
5833 description: This API is used to Read OKA packages
5834 operationId: readOKAPackage
5835 responses:
5836 '200':
5837 description: OK
5838 '400':
5839 $ref: '#/components/responses/BadRequest'
5840 '401':
5841 $ref: '#/components/responses/Unauthorized'
5842 '403':
5843 $ref: '#/components/responses/Forbidden'
5844 '404':
5845 $ref: '#/components/responses/NotFound'
5846 '405':
5847 $ref: '#/components/responses/MethodNotAllowed'
5848 '406':
5849 $ref: '#/components/responses/NotAcceptable'
5850 '409':
5851 $ref: '#/components/responses/Conflict'
5852 '422':
5853 $ref: '#/components/responses/UnprocessableEntity'
5854 '500':
5855 $ref: '#/components/responses/InternalServerError'
5856 '503':
5857 $ref: '#/components/responses/ServiceUnavailable'
5858 '5XX':
5859 $ref: '#/components/responses/UnexpectedError'
5860 default:
5861 $ref: '#/components/responses/UnexpectedError'
5862 patch:
5863 tags:
5864 - "OKA packages"
5865 summary: Update OKA package
5866 description: This API is used to Update OKA packages
5867 operationId: updateOKAPackage
5868 requestBody:
5869 content:
5870 application/zip:
5871 schema:
5872 $ref: '#/components/schemas/OkaPackage'
5873 responses:
5874 '202':
5875 description: Accepted
5876 '400':
5877 $ref: '#/components/responses/BadRequest'
5878 '401':
5879 $ref: '#/components/responses/Unauthorized'
5880 '403':
5881 $ref: '#/components/responses/Forbidden'
5882 '404':
5883 $ref: '#/components/responses/NotFound'
5884 '405':
5885 $ref: '#/components/responses/MethodNotAllowed'
5886 '406':
5887 $ref: '#/components/responses/NotAcceptable'
5888 '409':
5889 $ref: '#/components/responses/Conflict'
5890 '422':
5891 $ref: '#/components/responses/UnprocessableEntity'
5892 '500':
5893 $ref: '#/components/responses/InternalServerError'
5894 '503':
5895 $ref: '#/components/responses/ServiceUnavailable'
5896 '5XX':
5897 $ref: '#/components/responses/UnexpectedError'
5898 default:
5899 $ref: '#/components/responses/UnexpectedError'
5900 delete:
5901 tags:
5902 - "OKA packages"
5903 summary: Delete OKA package
5904 description: This API is used to Delete OKA packages
5905 operationId: deleteOKAPackage
5906 responses:
5907 '202':
5908 description: Accepted
5909 '400':
5910 $ref: '#/components/responses/BadRequest'
5911 '401':
5912 $ref: '#/components/responses/Unauthorized'
5913 '403':
5914 $ref: '#/components/responses/Forbidden'
5915 '404':
5916 $ref: '#/components/responses/NotFound'
5917 '405':
5918 $ref: '#/components/responses/MethodNotAllowed'
5919 '406':
5920 $ref: '#/components/responses/NotAcceptable'
5921 '409':
5922 $ref: '#/components/responses/Conflict'
5923 '422':
5924 $ref: '#/components/responses/UnprocessableEntity'
5925 '500':
5926 $ref: '#/components/responses/InternalServerError'
5927 '503':
5928 $ref: '#/components/responses/ServiceUnavailable'
5929 '5XX':
5930 $ref: '#/components/responses/UnexpectedError'
5931 default:
5932 $ref: '#/components/responses/UnexpectedError'
5933# END OKA packages
5934
5935# BEGIN KSU
5936 '/ksu/v1/ksus':
5937 get:
5938 tags:
5939 - "KSU"
5940 summary: Get KSU
5941 description: This API is used to Get KSU
5942 operationId: getKSU
5943 responses:
5944 '200':
5945 description: OK
5946 '400':
5947 $ref: '#/components/responses/BadRequest'
5948 '401':
5949 $ref: '#/components/responses/Unauthorized'
5950 '403':
5951 $ref: '#/components/responses/Forbidden'
5952 '404':
5953 $ref: '#/components/responses/NotFound'
5954 '405':
5955 $ref: '#/components/responses/MethodNotAllowed'
5956 '406':
5957 $ref: '#/components/responses/NotAcceptable'
5958 '409':
5959 $ref: '#/components/responses/Conflict'
5960 '422':
5961 $ref: '#/components/responses/UnprocessableEntity'
5962 '500':
5963 $ref: '#/components/responses/InternalServerError'
5964 '503':
5965 $ref: '#/components/responses/ServiceUnavailable'
5966 '5XX':
5967 $ref: '#/components/responses/UnexpectedError'
5968 default:
5969 $ref: '#/components/responses/UnexpectedError'
5970 post:
5971 tags:
5972 - "KSU"
5973 summary: Add KSU
5974 description: This API is used to Add KSU
5975 operationId: addKSU
5976 requestBody:
5977 $ref: '#/components/requestBodies/MultipleKsu'
5978 responses:
5979 '201':
5980 description: Created
5981 content:
5982 application/json:
5983 schema:
5984 $ref: '#/components/schemas/ObjectId'
5985 application/yaml:
5986 schema:
5987 $ref: '#/components/schemas/ObjectId'
5988 '400':
5989 $ref: '#/components/responses/BadRequest'
5990 '401':
5991 $ref: '#/components/responses/Unauthorized'
5992 '403':
5993 $ref: '#/components/responses/Forbidden'
5994 '404':
5995 $ref: '#/components/responses/NotFound'
5996 '405':
5997 $ref: '#/components/responses/MethodNotAllowed'
5998 '406':
5999 $ref: '#/components/responses/NotAcceptable'
6000 '409':
6001 $ref: '#/components/responses/Conflict'
6002 '422':
6003 $ref: '#/components/responses/UnprocessableEntity'
6004 '500':
6005 $ref: '#/components/responses/InternalServerError'
6006 '503':
6007 $ref: '#/components/responses/ServiceUnavailable'
6008 '5XX':
6009 $ref: '#/components/responses/UnexpectedError'
6010 default:
6011 $ref: '#/components/responses/UnexpectedError'
6012 '/ksu/v1/ksus/{ksu_id}':
6013 parameters:
6014 - name: ksu_id
6015 in: path
6016 required: true
6017 description: ksu_id
6018 schema:
6019 type: string
6020 get:
6021 tags:
6022 - "KSU"
6023 summary: Read KSU
6024 description: This API is used to Read KSU
6025 operationId: readKSU
6026 responses:
6027 '200':
6028 description: OK
6029 '400':
6030 $ref: '#/components/responses/BadRequest'
6031 '401':
6032 $ref: '#/components/responses/Unauthorized'
6033 '403':
6034 $ref: '#/components/responses/Forbidden'
6035 '404':
6036 $ref: '#/components/responses/NotFound'
6037 '405':
6038 $ref: '#/components/responses/MethodNotAllowed'
6039 '406':
6040 $ref: '#/components/responses/NotAcceptable'
6041 '409':
6042 $ref: '#/components/responses/Conflict'
6043 '422':
6044 $ref: '#/components/responses/UnprocessableEntity'
6045 '500':
6046 $ref: '#/components/responses/InternalServerError'
6047 '503':
6048 $ref: '#/components/responses/ServiceUnavailable'
6049 '5XX':
6050 $ref: '#/components/responses/UnexpectedError'
6051 default:
6052 $ref: '#/components/responses/UnexpectedError'
6053 patch:
6054 tags:
6055 - "KSU"
6056 summary: Update KSU
6057 description: This API is used to Update KSU
6058 operationId: updateKSU
6059 requestBody:
6060 $ref: '#/components/requestBodies/Ksu'
6061 responses:
6062 '202':
6063 description: Accepted
6064 '400':
6065 $ref: '#/components/responses/BadRequest'
6066 '401':
6067 $ref: '#/components/responses/Unauthorized'
6068 '403':
6069 $ref: '#/components/responses/Forbidden'
6070 '404':
6071 $ref: '#/components/responses/NotFound'
6072 '405':
6073 $ref: '#/components/responses/MethodNotAllowed'
6074 '406':
6075 $ref: '#/components/responses/NotAcceptable'
6076 '409':
6077 $ref: '#/components/responses/Conflict'
6078 '422':
6079 $ref: '#/components/responses/UnprocessableEntity'
6080 '500':
6081 $ref: '#/components/responses/InternalServerError'
6082 '503':
6083 $ref: '#/components/responses/ServiceUnavailable'
6084 '5XX':
6085 $ref: '#/components/responses/UnexpectedError'
6086 default:
6087 $ref: '#/components/responses/UnexpectedError'
6088 delete:
6089 tags:
6090 - "KSU"
6091 summary: Delete KSU
6092 description: This API is used to Delete KSU
6093 operationId: deleteKSU
6094 responses:
6095 '202':
6096 description: Accepted
6097 '400':
6098 $ref: '#/components/responses/BadRequest'
6099 '401':
6100 $ref: '#/components/responses/Unauthorized'
6101 '403':
6102 $ref: '#/components/responses/Forbidden'
6103 '404':
6104 $ref: '#/components/responses/NotFound'
6105 '405':
6106 $ref: '#/components/responses/MethodNotAllowed'
6107 '406':
6108 $ref: '#/components/responses/NotAcceptable'
6109 '409':
6110 $ref: '#/components/responses/Conflict'
6111 '422':
6112 $ref: '#/components/responses/UnprocessableEntity'
6113 '500':
6114 $ref: '#/components/responses/InternalServerError'
6115 '503':
6116 $ref: '#/components/responses/ServiceUnavailable'
6117 '5XX':
6118 $ref: '#/components/responses/UnexpectedError'
6119 default:
6120 $ref: '#/components/responses/UnexpectedError'
6121 '/ksu/v1/ksus/update':
6122 post:
6123 tags:
6124 - "KSU"
6125 summary: Update multiple KSU
6126 description: This API is used to Update multiple KSU
6127 operationId: updateMultipleKSU
6128 requestBody:
6129 $ref: '#/components/requestBodies/MultipleKsu'
6130 responses:
6131 '202':
6132 description: Accepted
6133 '400':
6134 $ref: '#/components/responses/BadRequest'
6135 '401':
6136 $ref: '#/components/responses/Unauthorized'
6137 '403':
6138 $ref: '#/components/responses/Forbidden'
6139 '404':
6140 $ref: '#/components/responses/NotFound'
6141 '405':
6142 $ref: '#/components/responses/MethodNotAllowed'
6143 '406':
6144 $ref: '#/components/responses/NotAcceptable'
6145 '409':
6146 $ref: '#/components/responses/Conflict'
6147 '422':
6148 $ref: '#/components/responses/UnprocessableEntity'
6149 '500':
6150 $ref: '#/components/responses/InternalServerError'
6151 '503':
6152 $ref: '#/components/responses/ServiceUnavailable'
6153 '5XX':
6154 $ref: '#/components/responses/UnexpectedError'
6155 default:
6156 $ref: '#/components/responses/UnexpectedError'
6157 '/ksu/v1/ksus/delete':
6158 post:
6159 tags:
6160 - "KSU"
6161 summary: Delete multiple KSU
6162 description: This API is used to Delete multiple KSU
6163 operationId: deleteMultipleKSU
6164 requestBody:
6165 $ref: '#/components/requestBodies/DeleteMultipleKsu'
6166 responses:
6167 '202':
6168 description: Accepted
6169 '400':
6170 $ref: '#/components/responses/BadRequest'
6171 '401':
6172 $ref: '#/components/responses/Unauthorized'
6173 '403':
6174 $ref: '#/components/responses/Forbidden'
6175 '404':
6176 $ref: '#/components/responses/NotFound'
6177 '405':
6178 $ref: '#/components/responses/MethodNotAllowed'
6179 '406':
6180 $ref: '#/components/responses/NotAcceptable'
6181 '409':
6182 $ref: '#/components/responses/Conflict'
6183 '422':
6184 $ref: '#/components/responses/UnprocessableEntity'
6185 '500':
6186 $ref: '#/components/responses/InternalServerError'
6187 '503':
6188 $ref: '#/components/responses/ServiceUnavailable'
6189 '5XX':
6190 $ref: '#/components/responses/UnexpectedError'
6191 default:
6192 $ref: '#/components/responses/UnexpectedError'
6193 '/ksu/v1/ksus/{ksu_id}/clone':
6194 parameters:
6195 - name: ksu_id
6196 in: path
6197 required: true
6198 description: ksu_id
6199 schema:
6200 type: string
6201 post:
6202 tags:
6203 - "KSU"
6204 summary: Clone KSU
6205 description: This API is used to Clone KSU
6206 operationId: cloneKSU
6207 requestBody:
6208 $ref: '#/components/requestBodies/CloneKsu'
6209 responses:
6210 '202':
6211 description: Accepted
6212 content:
6213 application/json:
6214 schema:
6215 $ref: '#/components/schemas/ObjectId'
6216 application/yaml:
6217 schema:
6218 $ref: '#/components/schemas/ObjectId'
6219 '400':
6220 $ref: '#/components/responses/BadRequest'
6221 '401':
6222 $ref: '#/components/responses/Unauthorized'
6223 '403':
6224 $ref: '#/components/responses/Forbidden'
6225 '404':
6226 $ref: '#/components/responses/NotFound'
6227 '405':
6228 $ref: '#/components/responses/MethodNotAllowed'
6229 '406':
6230 $ref: '#/components/responses/NotAcceptable'
6231 '409':
6232 $ref: '#/components/responses/Conflict'
6233 '422':
6234 $ref: '#/components/responses/UnprocessableEntity'
6235 '500':
6236 $ref: '#/components/responses/InternalServerError'
6237 '503':
6238 $ref: '#/components/responses/ServiceUnavailable'
6239 '5XX':
6240 $ref: '#/components/responses/UnexpectedError'
6241 default:
6242 $ref: '#/components/responses/UnexpectedError'
6243 '/ksu/v1/ksus/{ksu_id}/move':
6244 parameters:
6245 - name: ksu_id
6246 in: path
6247 required: true
6248 description: ksu_id
6249 schema:
6250 type: string
6251 post:
6252 tags:
6253 - "KSU"
6254 summary: Move KSU
6255 description: This API is used to Move KSU
6256 operationId: moveKSU
6257 requestBody:
6258 $ref: '#/components/requestBodies/MoveKsu'
6259 responses:
6260 '202':
6261 description: Accepted
6262 '400':
6263 $ref: '#/components/responses/BadRequest'
6264 '401':
6265 $ref: '#/components/responses/Unauthorized'
6266 '403':
6267 $ref: '#/components/responses/Forbidden'
6268 '404':
6269 $ref: '#/components/responses/NotFound'
6270 '405':
6271 $ref: '#/components/responses/MethodNotAllowed'
6272 '406':
6273 $ref: '#/components/responses/NotAcceptable'
6274 '409':
6275 $ref: '#/components/responses/Conflict'
6276 '422':
6277 $ref: '#/components/responses/UnprocessableEntity'
6278 '500':
6279 $ref: '#/components/responses/InternalServerError'
6280 '503':
6281 $ref: '#/components/responses/ServiceUnavailable'
6282 '5XX':
6283 $ref: '#/components/responses/UnexpectedError'
6284 default:
6285 $ref: '#/components/responses/UnexpectedError'
6286# END KSU
6287
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]6288# BEGIN Admin
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6289 '/admin/v1/tokens':
6290 get:
6291 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6292 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6293 - "Admin"
6294 summary: Query information about multiple Tokens
6295 description: Query information about multiple Tokens
6296 operationId: getTokens
6297 responses:
6298 '200':
6299 description: OK
6300 content:
6301 application/json:
6302 schema:
6303 $ref: '#/components/schemas/ArrayOfTokenInfo'
6304 application/yaml:
6305 schema:
6306 $ref: '#/components/schemas/ArrayOfTokenInfo'
6307 '400':
6308 $ref: '#/components/responses/BadRequest'
6309 '401':
6310 $ref: '#/components/responses/Unauthorized'
6311 '403':
6312 $ref: '#/components/responses/Forbidden'
6313 '404':
6314 $ref: '#/components/responses/NotFound'
6315 '405':
6316 $ref: '#/components/responses/MethodNotAllowed'
6317 '406':
6318 $ref: '#/components/responses/NotAcceptable'
6319 '409':
6320 $ref: '#/components/responses/Conflict'
6321 '422':
6322 $ref: '#/components/responses/UnprocessableEntity'
6323 '500':
6324 $ref: '#/components/responses/InternalServerError'
6325 '503':
6326 $ref: '#/components/responses/ServiceUnavailable'
6327 '5XX':
6328 $ref: '#/components/responses/UnexpectedError'
6329 default:
6330 $ref: '#/components/responses/UnexpectedError'
6331 post:
6332 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6333 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6334 - "Admin"
6335 summary: Request a new Token
6336 description: Request a new Token
6337 operationId: createToken
6338 requestBody:
6339 $ref: '#/components/requestBodies/CreateTokenRequest'
6340 responses:
6341 '200':
6342 description: OK
6343 headers:
6344 Location:
6345 schema:
6346 type: string
6347 format: uri
6348 content:
6349 application/json:
6350 schema:
selvi.ja6f638b2022-03-23 12:27:35 +0000[diff] [blame]6351 oneOf:
6352 - $ref: '#/components/schemas/TokenInfo'
6353 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6354 application/yaml:
6355 schema:
selvi.ja6f638b2022-03-23 12:27:35 +0000[diff] [blame]6356 oneOf:
6357 - $ref: '#/components/schemas/TokenInfo'
6358 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6359 '400':
6360 $ref: '#/components/responses/BadRequest'
6361 '401':
6362 $ref: '#/components/responses/Unauthorized'
6363 '403':
6364 $ref: '#/components/responses/Forbidden'
6365 '404':
6366 $ref: '#/components/responses/NotFound'
6367 '405':
6368 $ref: '#/components/responses/MethodNotAllowed'
6369 '406':
6370 $ref: '#/components/responses/NotAcceptable'
6371 '409':
6372 $ref: '#/components/responses/Conflict'
6373 '422':
6374 $ref: '#/components/responses/UnprocessableEntity'
6375 '500':
6376 $ref: '#/components/responses/InternalServerError'
6377 '503':
6378 $ref: '#/components/responses/ServiceUnavailable'
6379 '5XX':
6380 $ref: '#/components/responses/UnexpectedError'
6381 default:
6382 $ref: '#/components/responses/UnexpectedError'
6383 delete:
6384 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6385 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6386 - "Admin"
6387 summary: Delete the Token indicated in the Authorization Header
6388 description: Delete the Token indicated in the Authorization Header
6389 operationId: deleteAuthToken
6390 responses:
6391 '200':
6392 description: OK
6393 content:
6394 application/json:
6395 schema:
6396 type: string
6397 application/yaml:
6398 schema:
6399 type: string
6400 '400':
6401 $ref: '#/components/responses/BadRequest'
6402 '401':
6403 $ref: '#/components/responses/Unauthorized'
6404 '403':
6405 $ref: '#/components/responses/Forbidden'
6406 '404':
6407 $ref: '#/components/responses/NotFound'
6408 '405':
6409 $ref: '#/components/responses/MethodNotAllowed'
6410 '406':
6411 $ref: '#/components/responses/NotAcceptable'
6412 '409':
6413 $ref: '#/components/responses/Conflict'
6414 '422':
6415 $ref: '#/components/responses/UnprocessableEntity'
6416 '500':
6417 $ref: '#/components/responses/InternalServerError'
6418 '503':
6419 $ref: '#/components/responses/ServiceUnavailable'
6420 '5XX':
6421 $ref: '#/components/responses/UnexpectedError'
6422 default:
6423 $ref: '#/components/responses/UnexpectedError'
6424 '/admin/v1/tokens/{tokenId}':
6425 parameters:
6426 - name: tokenId
6427 in: path
6428 required: true
6429 description: Token ID
6430 schema:
6431 type: string
6432 get:
6433 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6434 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6435 - "Admin"
6436 summary: Query information about an individual Token
6437 description: Query information about an individual Token
6438 operationId: getToken
6439 responses:
6440 '200':
6441 description: OK
6442 content:
6443 application/json:
6444 schema:
6445 $ref: '#/components/schemas/TokenInfo'
6446 application/yaml:
6447 schema:
6448 $ref: '#/components/schemas/TokenInfo'
6449 '400':
6450 $ref: '#/components/responses/BadRequest'
6451 '401':
6452 $ref: '#/components/responses/Unauthorized'
6453 '403':
6454 $ref: '#/components/responses/Forbidden'
6455 '404':
6456 $ref: '#/components/responses/NotFound'
6457 '405':
6458 $ref: '#/components/responses/MethodNotAllowed'
6459 '406':
6460 $ref: '#/components/responses/NotAcceptable'
6461 '409':
6462 $ref: '#/components/responses/Conflict'
6463 '422':
6464 $ref: '#/components/responses/UnprocessableEntity'
6465 '500':
6466 $ref: '#/components/responses/InternalServerError'
6467 '503':
6468 $ref: '#/components/responses/ServiceUnavailable'
6469 '5XX':
6470 $ref: '#/components/responses/UnexpectedError'
6471 default:
6472 $ref: '#/components/responses/UnexpectedError'
6473 delete:
6474 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6475 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6476 - "Admin"
6477 summary: Delete the Token indicated as parameter
6478 description: Delete the Token indicated as parameter
6479 operationId: deleteToken
6480 responses:
6481 '200':
6482 description: OK
6483 content:
6484 application/json:
6485 schema:
6486 type: string
6487 application/yaml:
6488 schema:
6489 type: string
6490 '400':
6491 $ref: '#/components/responses/BadRequest'
6492 '401':
6493 $ref: '#/components/responses/Unauthorized'
6494 '403':
6495 $ref: '#/components/responses/Forbidden'
6496 '404':
6497 $ref: '#/components/responses/NotFound'
6498 '405':
6499 $ref: '#/components/responses/MethodNotAllowed'
6500 '406':
6501 $ref: '#/components/responses/NotAcceptable'
6502 '409':
6503 $ref: '#/components/responses/Conflict'
6504 '422':
6505 $ref: '#/components/responses/UnprocessableEntity'
6506 '500':
6507 $ref: '#/components/responses/InternalServerError'
6508 '503':
6509 $ref: '#/components/responses/ServiceUnavailable'
6510 '5XX':
6511 $ref: '#/components/responses/UnexpectedError'
6512 default:
6513 $ref: '#/components/responses/UnexpectedError'
6514 '/admin/v1/users':
6515 get:
6516 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6517 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6518 - "Admin"
6519 summary: Query information about multiple Users
6520 description: Query information about multiple Users
6521 operationId: getUsers
6522 responses:
6523 '200':
6524 description: OK
6525 content:
6526 application/json:
6527 schema:
6528 $ref: '#/components/schemas/ArrayOfUserInfo'
6529 application/yaml:
6530 schema:
6531 $ref: '#/components/schemas/ArrayOfUserInfo'
6532 '400':
6533 $ref: '#/components/responses/BadRequest'
6534 '401':
6535 $ref: '#/components/responses/Unauthorized'
6536 '403':
6537 $ref: '#/components/responses/Forbidden'
6538 '404':
6539 $ref: '#/components/responses/NotFound'
6540 '405':
6541 $ref: '#/components/responses/MethodNotAllowed'
6542 '406':
6543 $ref: '#/components/responses/NotAcceptable'
6544 '409':
6545 $ref: '#/components/responses/Conflict'
6546 '422':
6547 $ref: '#/components/responses/UnprocessableEntity'
6548 '500':
6549 $ref: '#/components/responses/InternalServerError'
6550 '503':
6551 $ref: '#/components/responses/ServiceUnavailable'
6552 '5XX':
6553 $ref: '#/components/responses/UnexpectedError'
6554 default:
6555 $ref: '#/components/responses/UnexpectedError'
6556 post:
6557 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6558 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6559 - "Admin"
6560 summary: Create a new User
6561 description: Create a new User
6562 operationId: createUser
6563 requestBody:
6564 $ref: '#/components/requestBodies/CreateUserRequest'
6565 responses:
6566 '201':
6567 description: Created
6568 headers:
6569 Location:
6570 schema:
6571 type: string
6572 format: uri
6573 content:
6574 application/json:
6575 schema:
6576 $ref: '#/components/schemas/ObjectId'
6577 application/yaml:
6578 schema:
6579 $ref: '#/components/schemas/ObjectId'
6580 '400':
6581 $ref: '#/components/responses/BadRequest'
6582 '401':
6583 $ref: '#/components/responses/Unauthorized'
6584 '403':
6585 $ref: '#/components/responses/Forbidden'
6586 '404':
6587 $ref: '#/components/responses/NotFound'
6588 '405':
6589 $ref: '#/components/responses/MethodNotAllowed'
6590 '406':
6591 $ref: '#/components/responses/NotAcceptable'
6592 '409':
6593 $ref: '#/components/responses/Conflict'
6594 '422':
6595 $ref: '#/components/responses/UnprocessableEntity'
6596 '500':
6597 $ref: '#/components/responses/InternalServerError'
6598 '503':
6599 $ref: '#/components/responses/ServiceUnavailable'
6600 '5XX':
6601 $ref: '#/components/responses/UnexpectedError'
6602 default:
6603 $ref: '#/components/responses/UnexpectedError'
6604 '/admin/v1/users/{userId}':
6605 parameters:
6606 - name: userId
6607 in: path
6608 required: true
6609 description: User ID/Name
6610 schema:
6611 type: string
6612 get:
6613 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6614 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6615 - "Admin"
6616 summary: Query information about an individual User
6617 description: Query information about an individual User
6618 operationId: getUser
6619 responses:
6620 '200':
6621 description: OK
6622 content:
6623 application/json:
6624 schema:
6625 $ref: '#/components/schemas/UserInfo'
6626 application/yaml:
6627 schema:
6628 $ref: '#/components/schemas/UserInfo'
6629 '400':
6630 $ref: '#/components/responses/BadRequest'
6631 '401':
6632 $ref: '#/components/responses/Unauthorized'
6633 '403':
6634 $ref: '#/components/responses/Forbidden'
6635 '404':
6636 $ref: '#/components/responses/NotFound'
6637 '405':
6638 $ref: '#/components/responses/MethodNotAllowed'
6639 '406':
6640 $ref: '#/components/responses/NotAcceptable'
6641 '409':
6642 $ref: '#/components/responses/Conflict'
6643 '422':
6644 $ref: '#/components/responses/UnprocessableEntity'
6645 '500':
6646 $ref: '#/components/responses/InternalServerError'
6647 '503':
6648 $ref: '#/components/responses/ServiceUnavailable'
6649 '5XX':
6650 $ref: '#/components/responses/UnexpectedError'
6651 default:
6652 $ref: '#/components/responses/UnexpectedError'
6653 patch:
6654 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6655 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6656 - "Admin"
6657 summary: Modify a User
6658 description: Modify a User
6659 operationId: editUser
6660 requestBody:
6661 $ref: '#/components/requestBodies/EditUserRequest'
6662 responses:
6663 '204':
6664 description: No Content
6665 '400':
6666 $ref: '#/components/responses/BadRequest'
6667 '401':
6668 $ref: '#/components/responses/Unauthorized'
6669 '403':
6670 $ref: '#/components/responses/Forbidden'
6671 '404':
6672 $ref: '#/components/responses/NotFound'
6673 '405':
6674 $ref: '#/components/responses/MethodNotAllowed'
6675 '406':
6676 $ref: '#/components/responses/NotAcceptable'
6677 '409':
6678 $ref: '#/components/responses/Conflict'
6679 '422':
6680 $ref: '#/components/responses/UnprocessableEntity'
6681 '500':
6682 $ref: '#/components/responses/InternalServerError'
6683 '503':
6684 $ref: '#/components/responses/ServiceUnavailable'
6685 '5XX':
6686 $ref: '#/components/responses/UnexpectedError'
6687 default:
6688 $ref: '#/components/responses/UnexpectedError'
6689 delete:
6690 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6691 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6692 - "Admin"
6693 summary: Delete a User
6694 description: Delete a User
6695 operationId: deleteUser
6696 responses:
6697 '204':
6698 description: No Content
6699 '400':
6700 $ref: '#/components/responses/BadRequest'
6701 '401':
6702 $ref: '#/components/responses/Unauthorized'
6703 '403':
6704 $ref: '#/components/responses/Forbidden'
6705 '404':
6706 $ref: '#/components/responses/NotFound'
6707 '405':
6708 $ref: '#/components/responses/MethodNotAllowed'
6709 '406':
6710 $ref: '#/components/responses/NotAcceptable'
6711 '409':
6712 $ref: '#/components/responses/Conflict'
6713 '422':
6714 $ref: '#/components/responses/UnprocessableEntity'
6715 '500':
6716 $ref: '#/components/responses/InternalServerError'
6717 '503':
6718 $ref: '#/components/responses/ServiceUnavailable'
6719 '5XX':
6720 $ref: '#/components/responses/UnexpectedError'
6721 default:
6722 $ref: '#/components/responses/UnexpectedError'
6723 '/admin/v1/projects':
6724 get:
6725 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6726 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6727 - "Admin"
6728 summary: Query information about multiple Projects
6729 description: Query information about multiple Projects
6730 operationId: getProjects
6731 responses:
6732 '200':
6733 description: OK
6734 content:
6735 application/json:
6736 schema:
6737 $ref: '#/components/schemas/ArrayOfProjectInfo'
6738 application/yaml:
6739 schema:
6740 $ref: '#/components/schemas/ArrayOfProjectInfo'
6741 '400':
6742 $ref: '#/components/responses/BadRequest'
6743 '401':
6744 $ref: '#/components/responses/Unauthorized'
6745 '403':
6746 $ref: '#/components/responses/Forbidden'
6747 '404':
6748 $ref: '#/components/responses/NotFound'
6749 '405':
6750 $ref: '#/components/responses/MethodNotAllowed'
6751 '406':
6752 $ref: '#/components/responses/NotAcceptable'
6753 '409':
6754 $ref: '#/components/responses/Conflict'
6755 '422':
6756 $ref: '#/components/responses/UnprocessableEntity'
6757 '500':
6758 $ref: '#/components/responses/InternalServerError'
6759 '503':
6760 $ref: '#/components/responses/ServiceUnavailable'
6761 '5XX':
6762 $ref: '#/components/responses/UnexpectedError'
6763 default:
6764 $ref: '#/components/responses/UnexpectedError'
6765 post:
6766 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6767 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6768 - "Admin"
6769 summary: Create a new Project
6770 description: Create a new Project
6771 operationId: createProject
6772 requestBody:
6773 $ref: '#/components/requestBodies/CreateProjectRequest'
6774 responses:
6775 '201':
6776 description: Created
6777 headers:
6778 Location:
6779 schema:
6780 type: string
6781 format: uri
6782 content:
6783 application/json:
6784 schema:
6785 $ref: '#/components/schemas/ObjectId'
6786 application/yaml:
6787 schema:
6788 $ref: '#/components/schemas/ObjectId'
6789 '400':
6790 $ref: '#/components/responses/BadRequest'
6791 '401':
6792 $ref: '#/components/responses/Unauthorized'
6793 '403':
6794 $ref: '#/components/responses/Forbidden'
6795 '404':
6796 $ref: '#/components/responses/NotFound'
6797 '405':
6798 $ref: '#/components/responses/MethodNotAllowed'
6799 '406':
6800 $ref: '#/components/responses/NotAcceptable'
6801 '409':
6802 $ref: '#/components/responses/Conflict'
6803 '422':
6804 $ref: '#/components/responses/UnprocessableEntity'
6805 '500':
6806 $ref: '#/components/responses/InternalServerError'
6807 '503':
6808 $ref: '#/components/responses/ServiceUnavailable'
6809 '5XX':
6810 $ref: '#/components/responses/UnexpectedError'
6811 default:
6812 $ref: '#/components/responses/UnexpectedError'
6813 '/admin/v1/projects/{projectId}':
6814 parameters:
6815 - name: projectId
6816 in: path
6817 required: true
6818 description: Project ID/Name
6819 schema:
6820 type: string
6821 get:
6822 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6823 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6824 - "Admin"
6825 summary: Query information about an individual Project
6826 description: Query information about an individual Project
6827 operationId: getProject
6828 responses:
6829 '200':
6830 description: OK
6831 content:
6832 application/json:
6833 schema:
6834 $ref: '#/components/schemas/ProjectInfo'
6835 application/yaml:
6836 schema:
6837 $ref: '#/components/schemas/ProjectInfo'
6838 '400':
6839 $ref: '#/components/responses/BadRequest'
6840 '401':
6841 $ref: '#/components/responses/Unauthorized'
6842 '403':
6843 $ref: '#/components/responses/Forbidden'
6844 '404':
6845 $ref: '#/components/responses/NotFound'
6846 '405':
6847 $ref: '#/components/responses/MethodNotAllowed'
6848 '406':
6849 $ref: '#/components/responses/NotAcceptable'
6850 '409':
6851 $ref: '#/components/responses/Conflict'
6852 '422':
6853 $ref: '#/components/responses/UnprocessableEntity'
6854 '500':
6855 $ref: '#/components/responses/InternalServerError'
6856 '503':
6857 $ref: '#/components/responses/ServiceUnavailable'
6858 '5XX':
6859 $ref: '#/components/responses/UnexpectedError'
6860 default:
6861 $ref: '#/components/responses/UnexpectedError'
6862 patch:
6863 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6864 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6865 - "Admin"
6866 summary: Modify a Project
6867 description: Modify a Project
6868 operationId: editProject
6869 requestBody:
6870 $ref: '#/components/requestBodies/EditProjectRequest'
6871 responses:
6872 '204':
6873 description: No Content
6874 '400':
6875 $ref: '#/components/responses/BadRequest'
6876 '401':
6877 $ref: '#/components/responses/Unauthorized'
6878 '403':
6879 $ref: '#/components/responses/Forbidden'
6880 '404':
6881 $ref: '#/components/responses/NotFound'
6882 '405':
6883 $ref: '#/components/responses/MethodNotAllowed'
6884 '406':
6885 $ref: '#/components/responses/NotAcceptable'
6886 '409':
6887 $ref: '#/components/responses/Conflict'
6888 '422':
6889 $ref: '#/components/responses/UnprocessableEntity'
6890 '500':
6891 $ref: '#/components/responses/InternalServerError'
6892 '503':
6893 $ref: '#/components/responses/ServiceUnavailable'
6894 '5XX':
6895 $ref: '#/components/responses/UnexpectedError'
6896 default:
6897 $ref: '#/components/responses/UnexpectedError'
6898 delete:
6899 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6900 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6901 - "Admin"
6902 summary: Delete a Project
6903 description: Delete a Project
6904 operationId: deleteProject
6905 responses:
6906 '204':
6907 description: No Content
6908 '400':
6909 $ref: '#/components/responses/BadRequest'
6910 '401':
6911 $ref: '#/components/responses/Unauthorized'
6912 '403':
6913 $ref: '#/components/responses/Forbidden'
6914 '404':
6915 $ref: '#/components/responses/NotFound'
6916 '405':
6917 $ref: '#/components/responses/MethodNotAllowed'
6918 '406':
6919 $ref: '#/components/responses/NotAcceptable'
6920 '409':
6921 $ref: '#/components/responses/Conflict'
6922 '422':
6923 $ref: '#/components/responses/UnprocessableEntity'
6924 '500':
6925 $ref: '#/components/responses/InternalServerError'
6926 '503':
6927 $ref: '#/components/responses/ServiceUnavailable'
6928 '5XX':
6929 $ref: '#/components/responses/UnexpectedError'
6930 default:
6931 $ref: '#/components/responses/UnexpectedError'
6932 '/admin/v1/roles':
6933 get:
6934 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6935 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6936 - "Admin"
6937 summary: Query information about multiple Roles
6938 description: Query information about multiple Roles
6939 operationId: getRoles
6940 responses:
6941 '200':
6942 description: OK
6943 content:
6944 application/json:
6945 schema:
6946 $ref: '#/components/schemas/ArrayOfRoleInfo'
6947 application/yaml:
6948 schema:
6949 $ref: '#/components/schemas/ArrayOfRoleInfo'
6950 '400':
6951 $ref: '#/components/responses/BadRequest'
6952 '401':
6953 $ref: '#/components/responses/Unauthorized'
6954 '403':
6955 $ref: '#/components/responses/Forbidden'
6956 '404':
6957 $ref: '#/components/responses/NotFound'
6958 '405':
6959 $ref: '#/components/responses/MethodNotAllowed'
6960 '406':
6961 $ref: '#/components/responses/NotAcceptable'
6962 '409':
6963 $ref: '#/components/responses/Conflict'
6964 '422':
6965 $ref: '#/components/responses/UnprocessableEntity'
6966 '500':
6967 $ref: '#/components/responses/InternalServerError'
6968 '503':
6969 $ref: '#/components/responses/ServiceUnavailable'
6970 '5XX':
6971 $ref: '#/components/responses/UnexpectedError'
6972 default:
6973 $ref: '#/components/responses/UnexpectedError'
6974 post:
6975 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6976 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6977 - "Admin"
6978 summary: Create a new Role
6979 description: Create a new Role
6980 operationId: createRole
6981 requestBody:
6982 $ref: '#/components/requestBodies/CreateRoleRequest'
6983 responses:
6984 '201':
6985 description: Created
6986 headers:
6987 Location:
6988 schema:
6989 type: string
6990 format: uri
6991 content:
6992 application/json:
6993 schema:
6994 $ref: '#/components/schemas/ObjectId'
6995 application/yaml:
6996 schema:
6997 $ref: '#/components/schemas/ObjectId'
6998 '400':
6999 $ref: '#/components/responses/BadRequest'
7000 '401':
7001 $ref: '#/components/responses/Unauthorized'
7002 '403':
7003 $ref: '#/components/responses/Forbidden'
7004 '404':
7005 $ref: '#/components/responses/NotFound'
7006 '405':
7007 $ref: '#/components/responses/MethodNotAllowed'
7008 '406':
7009 $ref: '#/components/responses/NotAcceptable'
7010 '409':
7011 $ref: '#/components/responses/Conflict'
7012 '422':
7013 $ref: '#/components/responses/UnprocessableEntity'
7014 '500':
7015 $ref: '#/components/responses/InternalServerError'
7016 '503':
7017 $ref: '#/components/responses/ServiceUnavailable'
7018 '5XX':
7019 $ref: '#/components/responses/UnexpectedError'
7020 default:
7021 $ref: '#/components/responses/UnexpectedError'
7022 '/admin/v1/roles/{roleId}':
7023 parameters:
7024 - name: roleId
7025 in: path
7026 required: true
7027 description: Role ID/Name
7028 schema:
7029 type: string
7030 get:
7031 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7032 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7033 - "Admin"
7034 summary: Query information about an individual Role
7035 description: Query information about an individual Role
7036 operationId: getRole
7037 responses:
7038 '200':
7039 description: OK
7040 content:
7041 application/json:
7042 schema:
7043 $ref: '#/components/schemas/RoleInfo'
7044 application/yaml:
7045 schema:
7046 $ref: '#/components/schemas/RoleInfo'
7047 '400':
7048 $ref: '#/components/responses/BadRequest'
7049 '401':
7050 $ref: '#/components/responses/Unauthorized'
7051 '403':
7052 $ref: '#/components/responses/Forbidden'
7053 '404':
7054 $ref: '#/components/responses/NotFound'
7055 '405':
7056 $ref: '#/components/responses/MethodNotAllowed'
7057 '406':
7058 $ref: '#/components/responses/NotAcceptable'
7059 '409':
7060 $ref: '#/components/responses/Conflict'
7061 '422':
7062 $ref: '#/components/responses/UnprocessableEntity'
7063 '500':
7064 $ref: '#/components/responses/InternalServerError'
7065 '503':
7066 $ref: '#/components/responses/ServiceUnavailable'
7067 '5XX':
7068 $ref: '#/components/responses/UnexpectedError'
7069 default:
7070 $ref: '#/components/responses/UnexpectedError'
7071 patch:
7072 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7073 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7074 - "Admin"
7075 summary: Modify a Role
7076 description: Modify a Role
7077 operationId: editRole
7078 requestBody:
7079 $ref: '#/components/requestBodies/EditRoleRequest'
7080 responses:
7081 '204':
7082 description: No Content
7083 '400':
7084 $ref: '#/components/responses/BadRequest'
7085 '401':
7086 $ref: '#/components/responses/Unauthorized'
7087 '403':
7088 $ref: '#/components/responses/Forbidden'
7089 '404':
7090 $ref: '#/components/responses/NotFound'
7091 '405':
7092 $ref: '#/components/responses/MethodNotAllowed'
7093 '406':
7094 $ref: '#/components/responses/NotAcceptable'
7095 '409':
7096 $ref: '#/components/responses/Conflict'
7097 '422':
7098 $ref: '#/components/responses/UnprocessableEntity'
7099 '500':
7100 $ref: '#/components/responses/InternalServerError'
7101 '503':
7102 $ref: '#/components/responses/ServiceUnavailable'
7103 '5XX':
7104 $ref: '#/components/responses/UnexpectedError'
7105 default:
7106 $ref: '#/components/responses/UnexpectedError'
7107 delete:
7108 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7109 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7110 - "Admin"
7111 summary: Delete a Role
7112 description: Delete a Role
7113 operationId: deleteRole
7114 responses:
7115 '204':
7116 description: No Content
7117 '400':
7118 $ref: '#/components/responses/BadRequest'
7119 '401':
7120 $ref: '#/components/responses/Unauthorized'
7121 '403':
7122 $ref: '#/components/responses/Forbidden'
7123 '404':
7124 $ref: '#/components/responses/NotFound'
7125 '405':
7126 $ref: '#/components/responses/MethodNotAllowed'
7127 '406':
7128 $ref: '#/components/responses/NotAcceptable'
7129 '409':
7130 $ref: '#/components/responses/Conflict'
7131 '422':
7132 $ref: '#/components/responses/UnprocessableEntity'
7133 '500':
7134 $ref: '#/components/responses/InternalServerError'
7135 '503':
7136 $ref: '#/components/responses/ServiceUnavailable'
7137 '5XX':
7138 $ref: '#/components/responses/UnexpectedError'
7139 default:
7140 $ref: '#/components/responses/UnexpectedError'
7141 '/admin/v1/vims':
7142 get:
7143 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7144 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7145 - "Admin"
7146 summary: Query information about multiple VIMs
7147 description: Query information about multiple VIMs
7148 operationId: getVIMs
7149 responses:
7150 '200':
7151 description: OK
7152 content:
7153 application/json:
7154 schema:
7155 $ref: '#/components/schemas/ArrayOfVimInfo'
7156 application/yaml:
7157 schema:
7158 $ref: '#/components/schemas/ArrayOfVimInfo'
7159 '400':
7160 $ref: '#/components/responses/BadRequest'
7161 '401':
7162 $ref: '#/components/responses/Unauthorized'
7163 '403':
7164 $ref: '#/components/responses/Forbidden'
7165 '404':
7166 $ref: '#/components/responses/NotFound'
7167 '405':
7168 $ref: '#/components/responses/MethodNotAllowed'
7169 '406':
7170 $ref: '#/components/responses/NotAcceptable'
7171 '409':
7172 $ref: '#/components/responses/Conflict'
7173 '422':
7174 $ref: '#/components/responses/UnprocessableEntity'
7175 '500':
7176 $ref: '#/components/responses/InternalServerError'
7177 '503':
7178 $ref: '#/components/responses/ServiceUnavailable'
7179 '5XX':
7180 $ref: '#/components/responses/UnexpectedError'
7181 default:
7182 $ref: '#/components/responses/UnexpectedError'
7183 post:
7184 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7185 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7186 - "Admin"
7187 summary: Create a new VIM
7188 description: Create a new VIM
7189 operationId: createVIM
7190 requestBody:
7191 $ref: '#/components/requestBodies/CreateVimRequest'
7192 responses:
7193 '202':
7194 description: Accepted
7195 content:
7196 application/json:
7197 schema:
7198 $ref: '#/components/schemas/ObjectId_plus_OpId'
7199 application/yaml:
7200 schema:
7201 $ref: '#/components/schemas/ObjectId_plus_OpId'
7202 '400':
7203 $ref: '#/components/responses/BadRequest'
7204 '401':
7205 $ref: '#/components/responses/Unauthorized'
7206 '403':
7207 $ref: '#/components/responses/Forbidden'
7208 '404':
7209 $ref: '#/components/responses/NotFound'
7210 '405':
7211 $ref: '#/components/responses/MethodNotAllowed'
7212 '406':
7213 $ref: '#/components/responses/NotAcceptable'
7214 '409':
7215 $ref: '#/components/responses/Conflict'
7216 '422':
7217 $ref: '#/components/responses/UnprocessableEntity'
7218 '500':
7219 $ref: '#/components/responses/InternalServerError'
7220 '503':
7221 $ref: '#/components/responses/ServiceUnavailable'
7222 '5XX':
7223 $ref: '#/components/responses/UnexpectedError'
7224 default:
7225 $ref: '#/components/responses/UnexpectedError'
7226 '/admin/v1/vims/{vimId}':
7227 parameters:
7228 - name: vimId
7229 in: path
7230 required: true
7231 description: VIM ID
7232 schema:
7233 type: string
7234 format: uuid
7235 get:
7236 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7237 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7238 - "Admin"
7239 summary: Query information about an individual VIM
7240 description: Query information about an individual VIM
7241 operationId: getVIM
7242 responses:
7243 '200':
7244 description: OK
7245 content:
7246 application/json:
7247 schema:
7248 $ref: '#/components/schemas/VimInfo'
7249 application/yaml:
7250 schema:
7251 $ref: '#/components/schemas/VimInfo'
7252 '400':
7253 $ref: '#/components/responses/BadRequest'
7254 '401':
7255 $ref: '#/components/responses/Unauthorized'
7256 '403':
7257 $ref: '#/components/responses/Forbidden'
7258 '404':
7259 $ref: '#/components/responses/NotFound'
7260 '405':
7261 $ref: '#/components/responses/MethodNotAllowed'
7262 '406':
7263 $ref: '#/components/responses/NotAcceptable'
7264 '409':
7265 $ref: '#/components/responses/Conflict'
7266 '422':
7267 $ref: '#/components/responses/UnprocessableEntity'
7268 '500':
7269 $ref: '#/components/responses/InternalServerError'
7270 '503':
7271 $ref: '#/components/responses/ServiceUnavailable'
7272 '5XX':
7273 $ref: '#/components/responses/UnexpectedError'
7274 default:
7275 $ref: '#/components/responses/UnexpectedError'
7276 patch:
7277 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7278 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7279 - "Admin"
7280 summary: Modify a VIM
7281 description: Modify a VIM
7282 operationId: editVIM
7283 requestBody:
7284 $ref: '#/components/requestBodies/EditVimRequest'
7285 responses:
7286 '202':
7287 description: Accepted
7288 content:
7289 application/json:
7290 schema:
7291 $ref: '#/components/schemas/OpId'
7292 application/yaml:
7293 schema:
7294 $ref: '#/components/schemas/OpId'
7295 '400':
7296 $ref: '#/components/responses/BadRequest'
7297 '401':
7298 $ref: '#/components/responses/Unauthorized'
7299 '403':
7300 $ref: '#/components/responses/Forbidden'
7301 '404':
7302 $ref: '#/components/responses/NotFound'
7303 '405':
7304 $ref: '#/components/responses/MethodNotAllowed'
7305 '406':
7306 $ref: '#/components/responses/NotAcceptable'
7307 '409':
7308 $ref: '#/components/responses/Conflict'
7309 '422':
7310 $ref: '#/components/responses/UnprocessableEntity'
7311 '500':
7312 $ref: '#/components/responses/InternalServerError'
7313 '503':
7314 $ref: '#/components/responses/ServiceUnavailable'
7315 '5XX':
7316 $ref: '#/components/responses/UnexpectedError'
7317 default:
7318 $ref: '#/components/responses/UnexpectedError'
7319 delete:
7320 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7321 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7322 - "Admin"
7323 summary: Delete a VIM
7324 description: Delete a VIM
7325 operationId: deleteVIM
7326 responses:
7327 '202':
7328 description: Accepted
7329 '400':
7330 $ref: '#/components/responses/BadRequest'
7331 '401':
7332 $ref: '#/components/responses/Unauthorized'
7333 '403':
7334 $ref: '#/components/responses/Forbidden'
7335 '404':
7336 $ref: '#/components/responses/NotFound'
7337 '405':
7338 $ref: '#/components/responses/MethodNotAllowed'
7339 '406':
7340 $ref: '#/components/responses/NotAcceptable'
7341 '409':
7342 $ref: '#/components/responses/Conflict'
7343 '422':
7344 $ref: '#/components/responses/UnprocessableEntity'
7345 '500':
7346 $ref: '#/components/responses/InternalServerError'
7347 '503':
7348 $ref: '#/components/responses/ServiceUnavailable'
7349 '5XX':
7350 $ref: '#/components/responses/UnexpectedError'
7351 default:
7352 $ref: '#/components/responses/UnexpectedError'
7353 '/admin/v1/vim_accounts':
7354 get:
7355 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7356 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7357 - "Admin"
7358 summary: Query information about multiple VIM Accounts
7359 description: Query information about multiple VIM Accounts
7360 operationId: getVimAccounts
7361 responses:
7362 '200':
7363 description: OK
7364 content:
7365 application/json:
7366 schema:
7367 $ref: '#/components/schemas/ArrayOfVimInfo'
7368 application/yaml:
7369 schema:
7370 $ref: '#/components/schemas/ArrayOfVimInfo'
7371 '400':
7372 $ref: '#/components/responses/BadRequest'
7373 '401':
7374 $ref: '#/components/responses/Unauthorized'
7375 '403':
7376 $ref: '#/components/responses/Forbidden'
7377 '404':
7378 $ref: '#/components/responses/NotFound'
7379 '405':
7380 $ref: '#/components/responses/MethodNotAllowed'
7381 '406':
7382 $ref: '#/components/responses/NotAcceptable'
7383 '409':
7384 $ref: '#/components/responses/Conflict'
7385 '422':
7386 $ref: '#/components/responses/UnprocessableEntity'
7387 '500':
7388 $ref: '#/components/responses/InternalServerError'
7389 '503':
7390 $ref: '#/components/responses/ServiceUnavailable'
7391 '5XX':
7392 $ref: '#/components/responses/UnexpectedError'
7393 default:
7394 $ref: '#/components/responses/UnexpectedError'
7395 post:
7396 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7397 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7398 - "Admin"
7399 summary: Create a new VIM Account
7400 description: Create a new VIM Account
7401 operationId: createVimAccount
7402 requestBody:
7403 $ref: '#/components/requestBodies/CreateVimRequest'
7404 responses:
7405 '202':
7406 description: Accepted
7407 content:
7408 application/json:
7409 schema:
7410 $ref: '#/components/schemas/ObjectId_plus_OpId'
7411 application/yaml:
7412 schema:
7413 $ref: '#/components/schemas/ObjectId_plus_OpId'
7414 '400':
7415 $ref: '#/components/responses/BadRequest'
7416 '401':
7417 $ref: '#/components/responses/Unauthorized'
7418 '403':
7419 $ref: '#/components/responses/Forbidden'
7420 '404':
7421 $ref: '#/components/responses/NotFound'
7422 '405':
7423 $ref: '#/components/responses/MethodNotAllowed'
7424 '406':
7425 $ref: '#/components/responses/NotAcceptable'
7426 '409':
7427 $ref: '#/components/responses/Conflict'
7428 '422':
7429 $ref: '#/components/responses/UnprocessableEntity'
7430 '500':
7431 $ref: '#/components/responses/InternalServerError'
7432 '503':
7433 $ref: '#/components/responses/ServiceUnavailable'
7434 '5XX':
7435 $ref: '#/components/responses/UnexpectedError'
7436 default:
7437 $ref: '#/components/responses/UnexpectedError'
7438 '/admin/v1/vim_accounts/{vimAccountId}':
7439 parameters:
7440 - name: vimAccountId
7441 in: path
7442 required: true
7443 description: VIM Account ID
7444 schema:
7445 type: string
7446 format: uuid
7447 get:
7448 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7449 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7450 - "Admin"
7451 summary: Query information about an individual VIM Account
7452 description: Query information about an individual VIM Account
7453 operationId: getVimAccount
7454 responses:
7455 '200':
7456 description: OK
7457 content:
7458 application/json:
7459 schema:
7460 $ref: '#/components/schemas/VimInfo'
7461 application/yaml:
7462 schema:
7463 $ref: '#/components/schemas/VimInfo'
7464 '400':
7465 $ref: '#/components/responses/BadRequest'
7466 '401':
7467 $ref: '#/components/responses/Unauthorized'
7468 '403':
7469 $ref: '#/components/responses/Forbidden'
7470 '404':
7471 $ref: '#/components/responses/NotFound'
7472 '405':
7473 $ref: '#/components/responses/MethodNotAllowed'
7474 '406':
7475 $ref: '#/components/responses/NotAcceptable'
7476 '409':
7477 $ref: '#/components/responses/Conflict'
7478 '422':
7479 $ref: '#/components/responses/UnprocessableEntity'
7480 '500':
7481 $ref: '#/components/responses/InternalServerError'
7482 '503':
7483 $ref: '#/components/responses/ServiceUnavailable'
7484 '5XX':
7485 $ref: '#/components/responses/UnexpectedError'
7486 default:
7487 $ref: '#/components/responses/UnexpectedError'
7488 patch:
7489 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7490 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7491 - "Admin"
7492 summary: Modify a VIM Account
7493 description: Modify a VIM Account
7494 operationId: editVimAccount
7495 requestBody:
7496 $ref: '#/components/requestBodies/EditVimRequest'
7497 responses:
7498 '202':
7499 description: Accepted
7500 content:
7501 application/json:
7502 schema:
7503 $ref: '#/components/schemas/OpId'
7504 application/yaml:
7505 schema:
7506 $ref: '#/components/schemas/OpId'
7507 '400':
7508 $ref: '#/components/responses/BadRequest'
7509 '401':
7510 $ref: '#/components/responses/Unauthorized'
7511 '403':
7512 $ref: '#/components/responses/Forbidden'
7513 '404':
7514 $ref: '#/components/responses/NotFound'
7515 '405':
7516 $ref: '#/components/responses/MethodNotAllowed'
7517 '406':
7518 $ref: '#/components/responses/NotAcceptable'
7519 '409':
7520 $ref: '#/components/responses/Conflict'
7521 '422':
7522 $ref: '#/components/responses/UnprocessableEntity'
7523 '500':
7524 $ref: '#/components/responses/InternalServerError'
7525 '503':
7526 $ref: '#/components/responses/ServiceUnavailable'
7527 '5XX':
7528 $ref: '#/components/responses/UnexpectedError'
7529 default:
7530 $ref: '#/components/responses/UnexpectedError'
7531 delete:
7532 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7533 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7534 - "Admin"
7535 summary: Delete a VIM Account
7536 description: Delete a VIM Account
7537 operationId: deleteVimAccount
7538 responses:
7539 '202':
7540 description: Accepted
7541 '400':
7542 $ref: '#/components/responses/BadRequest'
7543 '401':
7544 $ref: '#/components/responses/Unauthorized'
7545 '403':
7546 $ref: '#/components/responses/Forbidden'
7547 '404':
7548 $ref: '#/components/responses/NotFound'
7549 '405':
7550 $ref: '#/components/responses/MethodNotAllowed'
7551 '406':
7552 $ref: '#/components/responses/NotAcceptable'
7553 '409':
7554 $ref: '#/components/responses/Conflict'
7555 '422':
7556 $ref: '#/components/responses/UnprocessableEntity'
7557 '500':
7558 $ref: '#/components/responses/InternalServerError'
7559 '503':
7560 $ref: '#/components/responses/ServiceUnavailable'
7561 '5XX':
7562 $ref: '#/components/responses/UnexpectedError'
7563 default:
7564 $ref: '#/components/responses/UnexpectedError'
7565 '/admin/v1/wim_accounts':
7566 get:
7567 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7568 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7569 - "Admin"
7570 summary: Query information about multiple WIM Accounts
7571 description: Query information about multiple WIM Accounts
7572 operationId: getWimAccounts
7573 responses:
7574 '200':
7575 description: OK
7576 content:
7577 application/json:
7578 schema:
7579 $ref: '#/components/schemas/ArrayOfWimInfo'
7580 application/yaml:
7581 schema:
7582 $ref: '#/components/schemas/ArrayOfWimInfo'
7583 '400':
7584 $ref: '#/components/responses/BadRequest'
7585 '401':
7586 $ref: '#/components/responses/Unauthorized'
7587 '403':
7588 $ref: '#/components/responses/Forbidden'
7589 '404':
7590 $ref: '#/components/responses/NotFound'
7591 '405':
7592 $ref: '#/components/responses/MethodNotAllowed'
7593 '406':
7594 $ref: '#/components/responses/NotAcceptable'
7595 '409':
7596 $ref: '#/components/responses/Conflict'
7597 '422':
7598 $ref: '#/components/responses/UnprocessableEntity'
7599 '500':
7600 $ref: '#/components/responses/InternalServerError'
7601 '503':
7602 $ref: '#/components/responses/ServiceUnavailable'
7603 '5XX':
7604 $ref: '#/components/responses/UnexpectedError'
7605 default:
7606 $ref: '#/components/responses/UnexpectedError'
7607 post:
7608 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7609 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7610 - "Admin"
7611 summary: Create a new WIM Account
7612 description: Create a new WIM Account
7613 operationId: createWimAccount
7614 requestBody:
7615 $ref: '#/components/requestBodies/CreateWimRequest'
7616 responses:
7617 '202':
7618 description: Accepted
7619 content:
7620 application/json:
7621 schema:
7622 $ref: '#/components/schemas/ObjectId_plus_OpId'
7623 application/yaml:
7624 schema:
7625 $ref: '#/components/schemas/ObjectId_plus_OpId'
7626 '400':
7627 $ref: '#/components/responses/BadRequest'
7628 '401':
7629 $ref: '#/components/responses/Unauthorized'
7630 '403':
7631 $ref: '#/components/responses/Forbidden'
7632 '404':
7633 $ref: '#/components/responses/NotFound'
7634 '405':
7635 $ref: '#/components/responses/MethodNotAllowed'
7636 '406':
7637 $ref: '#/components/responses/NotAcceptable'
7638 '409':
7639 $ref: '#/components/responses/Conflict'
7640 '422':
7641 $ref: '#/components/responses/UnprocessableEntity'
7642 '500':
7643 $ref: '#/components/responses/InternalServerError'
7644 '503':
7645 $ref: '#/components/responses/ServiceUnavailable'
7646 '5XX':
7647 $ref: '#/components/responses/UnexpectedError'
7648 default:
7649 $ref: '#/components/responses/UnexpectedError'
7650 '/admin/v1/wim_accounts/{wimAccountId}':
7651 parameters:
7652 - name: wimAccountId
7653 in: path
7654 required: true
7655 description: WIM Account ID
7656 schema:
7657 type: string
7658 format: uuid
7659 get:
7660 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7661 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7662 - "Admin"
7663 summary: Query information about an individual WIM Account
7664 description: Query information about an individual WIM Account
7665 operationId: getWimAccount
7666 responses:
7667 '200':
7668 description: OK
7669 content:
7670 application/json:
7671 schema:
7672 $ref: '#/components/schemas/WimInfo'
7673 application/yaml:
7674 schema:
7675 $ref: '#/components/schemas/WimInfo'
7676 '400':
7677 $ref: '#/components/responses/BadRequest'
7678 '401':
7679 $ref: '#/components/responses/Unauthorized'
7680 '403':
7681 $ref: '#/components/responses/Forbidden'
7682 '404':
7683 $ref: '#/components/responses/NotFound'
7684 '405':
7685 $ref: '#/components/responses/MethodNotAllowed'
7686 '406':
7687 $ref: '#/components/responses/NotAcceptable'
7688 '409':
7689 $ref: '#/components/responses/Conflict'
7690 '422':
7691 $ref: '#/components/responses/UnprocessableEntity'
7692 '500':
7693 $ref: '#/components/responses/InternalServerError'
7694 '503':
7695 $ref: '#/components/responses/ServiceUnavailable'
7696 '5XX':
7697 $ref: '#/components/responses/UnexpectedError'
7698 default:
7699 $ref: '#/components/responses/UnexpectedError'
7700 patch:
7701 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7702 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7703 - "Admin"
7704 summary: Modify a WIM Account
7705 description: Modify a WIM Account
7706 operationId: editWimAccount
7707 requestBody:
7708 $ref: '#/components/requestBodies/EditWimRequest'
7709 responses:
7710 '202':
7711 description: Accepted
7712 content:
7713 application/json:
7714 schema:
7715 $ref: '#/components/schemas/OpId'
7716 application/yaml:
7717 schema:
7718 $ref: '#/components/schemas/OpId'
7719 '400':
7720 $ref: '#/components/responses/BadRequest'
7721 '401':
7722 $ref: '#/components/responses/Unauthorized'
7723 '403':
7724 $ref: '#/components/responses/Forbidden'
7725 '404':
7726 $ref: '#/components/responses/NotFound'
7727 '405':
7728 $ref: '#/components/responses/MethodNotAllowed'
7729 '406':
7730 $ref: '#/components/responses/NotAcceptable'
7731 '409':
7732 $ref: '#/components/responses/Conflict'
7733 '422':
7734 $ref: '#/components/responses/UnprocessableEntity'
7735 '500':
7736 $ref: '#/components/responses/InternalServerError'
7737 '503':
7738 $ref: '#/components/responses/ServiceUnavailable'
7739 '5XX':
7740 $ref: '#/components/responses/UnexpectedError'
7741 default:
7742 $ref: '#/components/responses/UnexpectedError'
7743 delete:
7744 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7745 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7746 - "Admin"
7747 summary: Delete a WIM Account
7748 description: Delete a WIM Account
7749 operationId: deleteWimAccount
7750 responses:
7751 '202':
7752 description: Accepted
7753 '400':
7754 $ref: '#/components/responses/BadRequest'
7755 '401':
7756 $ref: '#/components/responses/Unauthorized'
7757 '403':
7758 $ref: '#/components/responses/Forbidden'
7759 '404':
7760 $ref: '#/components/responses/NotFound'
7761 '405':
7762 $ref: '#/components/responses/MethodNotAllowed'
7763 '406':
7764 $ref: '#/components/responses/NotAcceptable'
7765 '409':
7766 $ref: '#/components/responses/Conflict'
7767 '422':
7768 $ref: '#/components/responses/UnprocessableEntity'
7769 '500':
7770 $ref: '#/components/responses/InternalServerError'
7771 '503':
7772 $ref: '#/components/responses/ServiceUnavailable'
7773 '5XX':
7774 $ref: '#/components/responses/UnexpectedError'
7775 default:
7776 $ref: '#/components/responses/UnexpectedError'
7777 '/admin/v1/sdns':
7778 get:
7779 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7780 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7781 - "Admin"
7782 summary: Query information about multiple SDNs
7783 description: Query information about multiple SDNs
7784 operationId: getSDNs
7785 responses:
7786 '200':
7787 description: OK
7788 content:
7789 application/json:
7790 schema:
7791 $ref: '#/components/schemas/ArrayOfSdnInfo'
7792 application/yaml:
7793 schema:
7794 $ref: '#/components/schemas/ArrayOfSdnInfo'
7795 '400':
7796 $ref: '#/components/responses/BadRequest'
7797 '401':
7798 $ref: '#/components/responses/Unauthorized'
7799 '403':
7800 $ref: '#/components/responses/Forbidden'
7801 '404':
7802 $ref: '#/components/responses/NotFound'
7803 '405':
7804 $ref: '#/components/responses/MethodNotAllowed'
7805 '406':
7806 $ref: '#/components/responses/NotAcceptable'
7807 '409':
7808 $ref: '#/components/responses/Conflict'
7809 '422':
7810 $ref: '#/components/responses/UnprocessableEntity'
7811 '500':
7812 $ref: '#/components/responses/InternalServerError'
7813 '503':
7814 $ref: '#/components/responses/ServiceUnavailable'
7815 '5XX':
7816 $ref: '#/components/responses/UnexpectedError'
7817 default:
7818 $ref: '#/components/responses/UnexpectedError'
7819 post:
7820 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7821 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7822 - "Admin"
7823 summary: Create a new SDN
7824 description: Create a new SDN
7825 operationId: createSDN
7826 requestBody:
7827 $ref: '#/components/requestBodies/CreateSdnRequest'
7828 responses:
7829 '202':
7830 description: Accepted
7831 content:
7832 application/json:
7833 schema:
7834 $ref: '#/components/schemas/ObjectId_plus_OpId'
7835 application/yaml:
7836 schema:
7837 $ref: '#/components/schemas/ObjectId_plus_OpId'
7838 '400':
7839 $ref: '#/components/responses/BadRequest'
7840 '401':
7841 $ref: '#/components/responses/Unauthorized'
7842 '403':
7843 $ref: '#/components/responses/Forbidden'
7844 '404':
7845 $ref: '#/components/responses/NotFound'
7846 '405':
7847 $ref: '#/components/responses/MethodNotAllowed'
7848 '406':
7849 $ref: '#/components/responses/NotAcceptable'
7850 '409':
7851 $ref: '#/components/responses/Conflict'
7852 '422':
7853 $ref: '#/components/responses/UnprocessableEntity'
7854 '500':
7855 $ref: '#/components/responses/InternalServerError'
7856 '503':
7857 $ref: '#/components/responses/ServiceUnavailable'
7858 '5XX':
7859 $ref: '#/components/responses/UnexpectedError'
7860 default:
7861 $ref: '#/components/responses/UnexpectedError'
7862 '/admin/v1/sdns/{sdnId}':
7863 parameters:
7864 - name: sdnId
7865 in: path
7866 required: true
7867 description: SDN ID
7868 schema:
7869 type: string
7870 format: uuid
7871 get:
7872 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7873 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7874 - "Admin"
7875 summary: Query information about an individual SDN
7876 description: Query information about an individual SDN
7877 operationId: getSDN
7878 responses:
7879 '200':
7880 description: OK
7881 content:
7882 application/json:
7883 schema:
7884 $ref: '#/components/schemas/SdnInfo'
7885 application/yaml:
7886 schema:
7887 $ref: '#/components/schemas/SdnInfo'
7888 '400':
7889 $ref: '#/components/responses/BadRequest'
7890 '401':
7891 $ref: '#/components/responses/Unauthorized'
7892 '403':
7893 $ref: '#/components/responses/Forbidden'
7894 '404':
7895 $ref: '#/components/responses/NotFound'
7896 '405':
7897 $ref: '#/components/responses/MethodNotAllowed'
7898 '406':
7899 $ref: '#/components/responses/NotAcceptable'
7900 '409':
7901 $ref: '#/components/responses/Conflict'
7902 '422':
7903 $ref: '#/components/responses/UnprocessableEntity'
7904 '500':
7905 $ref: '#/components/responses/InternalServerError'
7906 '503':
7907 $ref: '#/components/responses/ServiceUnavailable'
7908 '5XX':
7909 $ref: '#/components/responses/UnexpectedError'
7910 default:
7911 $ref: '#/components/responses/UnexpectedError'
7912 patch:
7913 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7914 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7915 - "Admin"
7916 summary: Modify a SDN
7917 description: Modify a SDN
7918 operationId: editSDN
7919 requestBody:
7920 $ref: '#/components/requestBodies/EditSdnRequest'
7921 responses:
7922 '202':
7923 description: Accepted
7924 content:
7925 application/json:
7926 schema:
7927 $ref: '#/components/schemas/OpId'
7928 application/yaml:
7929 schema:
7930 $ref: '#/components/schemas/OpId'
7931 '400':
7932 $ref: '#/components/responses/BadRequest'
7933 '401':
7934 $ref: '#/components/responses/Unauthorized'
7935 '403':
7936 $ref: '#/components/responses/Forbidden'
7937 '404':
7938 $ref: '#/components/responses/NotFound'
7939 '405':
7940 $ref: '#/components/responses/MethodNotAllowed'
7941 '406':
7942 $ref: '#/components/responses/NotAcceptable'
7943 '409':
7944 $ref: '#/components/responses/Conflict'
7945 '422':
7946 $ref: '#/components/responses/UnprocessableEntity'
7947 '500':
7948 $ref: '#/components/responses/InternalServerError'
7949 '503':
7950 $ref: '#/components/responses/ServiceUnavailable'
7951 '5XX':
7952 $ref: '#/components/responses/UnexpectedError'
7953 default:
7954 $ref: '#/components/responses/UnexpectedError'
7955 delete:
7956 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7957 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7958 - "Admin"
7959 summary: Delete a SDN
7960 description: Delete a SDN
7961 operationId: deleteSDN
7962 responses:
7963 '202':
7964 description: Accepted
7965 '400':
7966 $ref: '#/components/responses/BadRequest'
7967 '401':
7968 $ref: '#/components/responses/Unauthorized'
7969 '403':
7970 $ref: '#/components/responses/Forbidden'
7971 '404':
7972 $ref: '#/components/responses/NotFound'
7973 '405':
7974 $ref: '#/components/responses/MethodNotAllowed'
7975 '406':
7976 $ref: '#/components/responses/NotAcceptable'
7977 '409':
7978 $ref: '#/components/responses/Conflict'
7979 '422':
7980 $ref: '#/components/responses/UnprocessableEntity'
7981 '500':
7982 $ref: '#/components/responses/InternalServerError'
7983 '503':
7984 $ref: '#/components/responses/ServiceUnavailable'
7985 '5XX':
7986 $ref: '#/components/responses/UnexpectedError'
7987 default:
7988 $ref: '#/components/responses/UnexpectedError'
7989 '/admin/v1/k8sclusters':
7990 get:
7991 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7992 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7993 - "Admin"
7994 summary: Query information about multiple K8s Clusters
7995 description: Query information about multiple K8s Clusters
7996 operationId: getK8sClusters
7997 responses:
7998 '200':
7999 description: OK
8000 content:
8001 application/json:
8002 schema:
8003 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
8004 application/yaml:
8005 schema:
8006 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
8007 '400':
8008 $ref: '#/components/responses/BadRequest'
8009 '401':
8010 $ref: '#/components/responses/Unauthorized'
8011 '403':
8012 $ref: '#/components/responses/Forbidden'
8013 '404':
8014 $ref: '#/components/responses/NotFound'
8015 '405':
8016 $ref: '#/components/responses/MethodNotAllowed'
8017 '406':
8018 $ref: '#/components/responses/NotAcceptable'
8019 '409':
8020 $ref: '#/components/responses/Conflict'
8021 '422':
8022 $ref: '#/components/responses/UnprocessableEntity'
8023 '500':
8024 $ref: '#/components/responses/InternalServerError'
8025 '503':
8026 $ref: '#/components/responses/ServiceUnavailable'
8027 '5XX':
8028 $ref: '#/components/responses/UnexpectedError'
8029 default:
8030 $ref: '#/components/responses/UnexpectedError'
8031 post:
8032 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8033 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8034 - "Admin"
8035 summary: Create a new K8s Cluster
8036 description: Create a new K8s Cluster
8037 operationId: createK8sCluster
8038 requestBody:
8039 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
8040 responses:
8041 '202':
8042 description: Accepted
8043 content:
8044 application/json:
8045 schema:
8046 $ref: '#/components/schemas/ObjectId_plus_OpId'
8047 application/yaml:
8048 schema:
8049 $ref: '#/components/schemas/ObjectId_plus_OpId'
8050 '400':
8051 $ref: '#/components/responses/BadRequest'
8052 '401':
8053 $ref: '#/components/responses/Unauthorized'
8054 '403':
8055 $ref: '#/components/responses/Forbidden'
8056 '404':
8057 $ref: '#/components/responses/NotFound'
8058 '405':
8059 $ref: '#/components/responses/MethodNotAllowed'
8060 '406':
8061 $ref: '#/components/responses/NotAcceptable'
8062 '409':
8063 $ref: '#/components/responses/Conflict'
8064 '422':
8065 $ref: '#/components/responses/UnprocessableEntity'
8066 '500':
8067 $ref: '#/components/responses/InternalServerError'
8068 '503':
8069 $ref: '#/components/responses/ServiceUnavailable'
8070 '5XX':
8071 $ref: '#/components/responses/UnexpectedError'
8072 default:
8073 $ref: '#/components/responses/UnexpectedError'
8074 '/admin/v1/k8sclusters/{k8sClusterId}':
8075 parameters:
8076 - name: k8sClusterId
8077 in: path
8078 required: true
8079 description: K8s Cluster ID
8080 schema:
8081 type: string
8082 format: uuid
8083 get:
8084 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8085 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8086 - "Admin"
8087 summary: Query information about an individual K8s Cluster
8088 description: Query information about an individual K8s Cluster
8089 operationId: getK8sCluster
8090 responses:
8091 '200':
8092 description: OK
8093 content:
8094 application/json:
8095 schema:
8096 $ref: '#/components/schemas/K8sClusterInfo'
8097 application/yaml:
8098 schema:
8099 $ref: '#/components/schemas/K8sClusterInfo'
8100 '400':
8101 $ref: '#/components/responses/BadRequest'
8102 '401':
8103 $ref: '#/components/responses/Unauthorized'
8104 '403':
8105 $ref: '#/components/responses/Forbidden'
8106 '404':
8107 $ref: '#/components/responses/NotFound'
8108 '405':
8109 $ref: '#/components/responses/MethodNotAllowed'
8110 '406':
8111 $ref: '#/components/responses/NotAcceptable'
8112 '409':
8113 $ref: '#/components/responses/Conflict'
8114 '422':
8115 $ref: '#/components/responses/UnprocessableEntity'
8116 '500':
8117 $ref: '#/components/responses/InternalServerError'
8118 '503':
8119 $ref: '#/components/responses/ServiceUnavailable'
8120 '5XX':
8121 $ref: '#/components/responses/UnexpectedError'
8122 default:
8123 $ref: '#/components/responses/UnexpectedError'
8124 patch:
8125 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8126 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8127 - "Admin"
8128 summary: Modify a K8s Cluster
8129 description: Modify a K8s Cluster
8130 operationId: editK8sCluster
8131 requestBody:
8132 $ref: '#/components/requestBodies/EditK8sClusterRequest'
8133 responses:
8134 '202':
8135 description: Accepted
8136 content:
8137 application/json:
8138 schema:
8139 $ref: '#/components/schemas/OpId'
8140 application/yaml:
8141 schema:
8142 $ref: '#/components/schemas/OpId'
8143 '400':
8144 $ref: '#/components/responses/BadRequest'
8145 '401':
8146 $ref: '#/components/responses/Unauthorized'
8147 '403':
8148 $ref: '#/components/responses/Forbidden'
8149 '404':
8150 $ref: '#/components/responses/NotFound'
8151 '405':
8152 $ref: '#/components/responses/MethodNotAllowed'
8153 '406':
8154 $ref: '#/components/responses/NotAcceptable'
8155 '409':
8156 $ref: '#/components/responses/Conflict'
8157 '422':
8158 $ref: '#/components/responses/UnprocessableEntity'
8159 '500':
8160 $ref: '#/components/responses/InternalServerError'
8161 '503':
8162 $ref: '#/components/responses/ServiceUnavailable'
8163 '5XX':
8164 $ref: '#/components/responses/UnexpectedError'
8165 default:
8166 $ref: '#/components/responses/UnexpectedError'
8167 delete:
8168 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8169 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8170 - "Admin"
8171 summary: Delete a K8s Cluster
8172 description: Delete a K8s Cluster
8173 operationId: deleteK8sCluster
8174 responses:
8175 '202':
8176 description: Accepted
8177 '400':
8178 $ref: '#/components/responses/BadRequest'
8179 '401':
8180 $ref: '#/components/responses/Unauthorized'
8181 '403':
8182 $ref: '#/components/responses/Forbidden'
8183 '404':
8184 $ref: '#/components/responses/NotFound'
8185 '405':
8186 $ref: '#/components/responses/MethodNotAllowed'
8187 '406':
8188 $ref: '#/components/responses/NotAcceptable'
8189 '409':
8190 $ref: '#/components/responses/Conflict'
8191 '422':
8192 $ref: '#/components/responses/UnprocessableEntity'
8193 '500':
8194 $ref: '#/components/responses/InternalServerError'
8195 '503':
8196 $ref: '#/components/responses/ServiceUnavailable'
8197 '5XX':
8198 $ref: '#/components/responses/UnexpectedError'
8199 default:
8200 $ref: '#/components/responses/UnexpectedError'
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]8201 '/admin/v1/vca':
8202 get:
8203 tags:
8204 - "Infrastructure"
8205 - "Admin"
8206 summary: Query information about multiple VCAs
8207 description: Query information about multiple VCAs
8208 operationId: getVcas
8209 responses:
8210 '200':
8211 description: OK
8212 content:
8213 application/json:
8214 schema:
8215 $ref: '#/components/schemas/ArrayOfVcaInfo'
8216 application/yaml:
8217 schema:
8218 $ref: '#/components/schemas/ArrayOfVcaInfo'
8219 '400':
8220 $ref: '#/components/responses/BadRequest'
8221 '401':
8222 $ref: '#/components/responses/Unauthorized'
8223 '403':
8224 $ref: '#/components/responses/Forbidden'
8225 '404':
8226 $ref: '#/components/responses/NotFound'
8227 '405':
8228 $ref: '#/components/responses/MethodNotAllowed'
8229 '406':
8230 $ref: '#/components/responses/NotAcceptable'
8231 '409':
8232 $ref: '#/components/responses/Conflict'
8233 '422':
8234 $ref: '#/components/responses/UnprocessableEntity'
8235 '500':
8236 $ref: '#/components/responses/InternalServerError'
8237 '503':
8238 $ref: '#/components/responses/ServiceUnavailable'
8239 '5XX':
8240 $ref: '#/components/responses/UnexpectedError'
8241 default:
8242 $ref: '#/components/responses/UnexpectedError'
8243 post:
8244 tags:
8245 - "Infrastructure"
8246 - "Admin"
8247 summary: Create a new VCA
8248 description: Create a new VCA
8249 operationId: createVca
8250 requestBody:
8251 $ref: '#/components/requestBodies/CreateVcaRequest'
8252 responses:
8253 '202':
8254 description: Accepted
8255 content:
8256 application/json:
8257 schema:
8258 $ref: '#/components/schemas/ObjectId_plus_OpId'
8259 application/yaml:
8260 schema:
8261 $ref: '#/components/schemas/ObjectId_plus_OpId'
8262 '400':
8263 $ref: '#/components/responses/BadRequest'
8264 '401':
8265 $ref: '#/components/responses/Unauthorized'
8266 '403':
8267 $ref: '#/components/responses/Forbidden'
8268 '404':
8269 $ref: '#/components/responses/NotFound'
8270 '405':
8271 $ref: '#/components/responses/MethodNotAllowed'
8272 '406':
8273 $ref: '#/components/responses/NotAcceptable'
8274 '409':
8275 $ref: '#/components/responses/Conflict'
8276 '422':
8277 $ref: '#/components/responses/UnprocessableEntity'
8278 '500':
8279 $ref: '#/components/responses/InternalServerError'
8280 '503':
8281 $ref: '#/components/responses/ServiceUnavailable'
8282 '5XX':
8283 $ref: '#/components/responses/UnexpectedError'
8284 default:
8285 $ref: '#/components/responses/UnexpectedError'
8286 '/admin/v1/vca/{vcaId}':
8287 parameters:
8288 - name: vcaId
8289 in: path
8290 required: true
8291 description: VCA ID
8292 schema:
8293 type: string
8294 format: uuid
8295 get:
8296 tags:
8297 - "Infrastructure"
8298 - "Admin"
8299 summary: Query information about an individual VCA
8300 description: Query information about an individual VCA
8301 operationId: getVca
8302 responses:
8303 '200':
8304 description: OK
8305 content:
8306 application/json:
8307 schema:
8308 $ref: '#/components/schemas/VcaInfo'
8309 application/yaml:
8310 schema:
8311 $ref: '#/components/schemas/VcaInfo'
8312 '400':
8313 $ref: '#/components/responses/BadRequest'
8314 '401':
8315 $ref: '#/components/responses/Unauthorized'
8316 '403':
8317 $ref: '#/components/responses/Forbidden'
8318 '404':
8319 $ref: '#/components/responses/NotFound'
8320 '405':
8321 $ref: '#/components/responses/MethodNotAllowed'
8322 '406':
8323 $ref: '#/components/responses/NotAcceptable'
8324 '409':
8325 $ref: '#/components/responses/Conflict'
8326 '422':
8327 $ref: '#/components/responses/UnprocessableEntity'
8328 '500':
8329 $ref: '#/components/responses/InternalServerError'
8330 '503':
8331 $ref: '#/components/responses/ServiceUnavailable'
8332 '5XX':
8333 $ref: '#/components/responses/UnexpectedError'
8334 default:
8335 $ref: '#/components/responses/UnexpectedError'
8336 patch:
8337 tags:
8338 - "Infrastructure"
8339 - "Admin"
8340 summary: Modify a VCA
8341 description: Modify a VCA
8342 operationId: editVca
8343 requestBody:
8344 $ref: '#/components/requestBodies/EditVcaRequest'
8345 responses:
8346 '202':
8347 description: Accepted
8348 content:
8349 application/json:
8350 schema:
8351 $ref: '#/components/schemas/OpId'
8352 application/yaml:
8353 schema:
8354 $ref: '#/components/schemas/OpId'
8355 '400':
8356 $ref: '#/components/responses/BadRequest'
8357 '401':
8358 $ref: '#/components/responses/Unauthorized'
8359 '403':
8360 $ref: '#/components/responses/Forbidden'
8361 '404':
8362 $ref: '#/components/responses/NotFound'
8363 '405':
8364 $ref: '#/components/responses/MethodNotAllowed'
8365 '406':
8366 $ref: '#/components/responses/NotAcceptable'
8367 '409':
8368 $ref: '#/components/responses/Conflict'
8369 '422':
8370 $ref: '#/components/responses/UnprocessableEntity'
8371 '500':
8372 $ref: '#/components/responses/InternalServerError'
8373 '503':
8374 $ref: '#/components/responses/ServiceUnavailable'
8375 '5XX':
8376 $ref: '#/components/responses/UnexpectedError'
8377 default:
8378 $ref: '#/components/responses/UnexpectedError'
8379 delete:
8380 tags:
8381 - "Infrastructure"
8382 - "Admin"
8383 summary: Delete a VCA
8384 description: Delete a VCA
8385 operationId: deleteVca
8386 responses:
8387 '202':
8388 description: Accepted
8389 '400':
8390 $ref: '#/components/responses/BadRequest'
8391 '401':
8392 $ref: '#/components/responses/Unauthorized'
8393 '403':
8394 $ref: '#/components/responses/Forbidden'
8395 '404':
8396 $ref: '#/components/responses/NotFound'
8397 '405':
8398 $ref: '#/components/responses/MethodNotAllowed'
8399 '406':
8400 $ref: '#/components/responses/NotAcceptable'
8401 '409':
8402 $ref: '#/components/responses/Conflict'
8403 '422':
8404 $ref: '#/components/responses/UnprocessableEntity'
8405 '500':
8406 $ref: '#/components/responses/InternalServerError'
8407 '503':
8408 $ref: '#/components/responses/ServiceUnavailable'
8409 '5XX':
8410 $ref: '#/components/responses/UnexpectedError'
8411 default:
8412 $ref: '#/components/responses/UnexpectedError'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8413 '/admin/v1/k8srepos':
8414 get:
8415 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8416 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8417 - "Admin"
8418 summary: Query information about multiple K8s Repos
8419 description: Query information about multiple K8s Repos
8420 operationId: getK8sRepos
8421 responses:
8422 '200':
8423 description: OK
8424 content:
8425 application/json:
8426 schema:
8427 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
8428 application/yaml:
8429 schema:
8430 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
8431 '400':
8432 $ref: '#/components/responses/BadRequest'
8433 '401':
8434 $ref: '#/components/responses/Unauthorized'
8435 '403':
8436 $ref: '#/components/responses/Forbidden'
8437 '404':
8438 $ref: '#/components/responses/NotFound'
8439 '405':
8440 $ref: '#/components/responses/MethodNotAllowed'
8441 '406':
8442 $ref: '#/components/responses/NotAcceptable'
8443 '409':
8444 $ref: '#/components/responses/Conflict'
8445 '422':
8446 $ref: '#/components/responses/UnprocessableEntity'
8447 '500':
8448 $ref: '#/components/responses/InternalServerError'
8449 '503':
8450 $ref: '#/components/responses/ServiceUnavailable'
8451 '5XX':
8452 $ref: '#/components/responses/UnexpectedError'
8453 default:
8454 $ref: '#/components/responses/UnexpectedError'
8455 post:
8456 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8457 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8458 - "Admin"
8459 summary: Create a new K8s Repo
8460 description: Create a new K8s Repo
8461 operationId: createK8sRepo
8462 requestBody:
8463 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
8464 responses:
8465 '202':
8466 description: Accepted
8467 content:
8468 application/json:
8469 schema:
8470 $ref: '#/components/schemas/ObjectId_plus_OpId'
8471 application/yaml:
8472 schema:
8473 $ref: '#/components/schemas/ObjectId_plus_OpId'
8474 '400':
8475 $ref: '#/components/responses/BadRequest'
8476 '401':
8477 $ref: '#/components/responses/Unauthorized'
8478 '403':
8479 $ref: '#/components/responses/Forbidden'
8480 '404':
8481 $ref: '#/components/responses/NotFound'
8482 '405':
8483 $ref: '#/components/responses/MethodNotAllowed'
8484 '406':
8485 $ref: '#/components/responses/NotAcceptable'
8486 '409':
8487 $ref: '#/components/responses/Conflict'
8488 '422':
8489 $ref: '#/components/responses/UnprocessableEntity'
8490 '500':
8491 $ref: '#/components/responses/InternalServerError'
8492 '503':
8493 $ref: '#/components/responses/ServiceUnavailable'
8494 '5XX':
8495 $ref: '#/components/responses/UnexpectedError'
8496 default:
8497 $ref: '#/components/responses/UnexpectedError'
8498 '/admin/v1/k8srepos/{k8sRepoId}':
8499 parameters:
8500 - name: k8sRepoId
8501 in: path
8502 required: true
8503 description: K8s Repo ID
8504 schema:
8505 type: string
8506 format: uuid
8507 get:
8508 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8509 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8510 - "Admin"
8511 summary: Query information about an individual K8s Repo
8512 description: Query information about an individual K8s Repo
8513 operationId: getK8sRepo
8514 responses:
8515 '200':
8516 description: OK
8517 content:
8518 application/json:
8519 schema:
8520 $ref: '#/components/schemas/K8sRepoInfo'
8521 application/yaml:
8522 schema:
8523 $ref: '#/components/schemas/K8sRepoInfo'
8524 '400':
8525 $ref: '#/components/responses/BadRequest'
8526 '401':
8527 $ref: '#/components/responses/Unauthorized'
8528 '403':
8529 $ref: '#/components/responses/Forbidden'
8530 '404':
8531 $ref: '#/components/responses/NotFound'
8532 '405':
8533 $ref: '#/components/responses/MethodNotAllowed'
8534 '406':
8535 $ref: '#/components/responses/NotAcceptable'
8536 '409':
8537 $ref: '#/components/responses/Conflict'
8538 '422':
8539 $ref: '#/components/responses/UnprocessableEntity'
8540 '500':
8541 $ref: '#/components/responses/InternalServerError'
8542 '503':
8543 $ref: '#/components/responses/ServiceUnavailable'
8544 '5XX':
8545 $ref: '#/components/responses/UnexpectedError'
8546 default:
8547 $ref: '#/components/responses/UnexpectedError'
8548 delete:
8549 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8550 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8551 - "Admin"
8552 summary: Delete a K8s Repo
8553 description: Delete a K8s Repo
8554 operationId: deleteK8sRepo
8555 responses:
8556 '202':
8557 description: Accepted
8558 '400':
8559 $ref: '#/components/responses/BadRequest'
8560 '401':
8561 $ref: '#/components/responses/Unauthorized'
8562 '403':
8563 $ref: '#/components/responses/Forbidden'
8564 '404':
8565 $ref: '#/components/responses/NotFound'
8566 '405':
8567 $ref: '#/components/responses/MethodNotAllowed'
8568 '406':
8569 $ref: '#/components/responses/NotAcceptable'
8570 '409':
8571 $ref: '#/components/responses/Conflict'
8572 '422':
8573 $ref: '#/components/responses/UnprocessableEntity'
8574 '500':
8575 $ref: '#/components/responses/InternalServerError'
8576 '503':
8577 $ref: '#/components/responses/ServiceUnavailable'
8578 '5XX':
8579 $ref: '#/components/responses/UnexpectedError'
8580 default:
8581 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8582# END Admin
8583
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8584externalDocs:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8585 description: Find out more about OSM
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]8586 url: 'https://osm.etsi.org/docs/user-guide/'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8587
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8588components:
8589 responses:
8590 BadRequest:
8591 description: Bad request. The server cannot process the request due to a client error.
8592 content:
8593 application/json:
8594 schema:
8595 $ref: '#/components/schemas/ProblemDetails'
8596 Unauthorized:
8597 description: Authorization information is missing or invalid.
8598 content:
8599 application/json:
8600 schema:
8601 $ref: '#/components/schemas/ProblemDetails'
8602 Forbidden:
8603 description: Not enough permissions to do this operation.
8604 content:
8605 application/json:
8606 schema:
8607 $ref: '#/components/schemas/ProblemDetails'
8608 NotFound:
8609 description: The specified resource was not found.
8610 content:
8611 application/json:
8612 schema:
8613 $ref: '#/components/schemas/ProblemDetails'
8614 MethodNotAllowed:
8615 description: This method is not supported for the requested resource.
8616 content:
8617 application/json:
8618 schema:
8619 $ref: '#/components/schemas/ProblemDetails'
8620 NotAcceptable:
8621 description: The requested resource content cannot match the Accept headers sent in the request.
8622 content:
8623 application/json:
8624 schema:
8625 $ref: '#/components/schemas/ProblemDetails'
8626 Conflict:
8627 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
8628 content:
8629 application/json:
8630 schema:
8631 $ref: '#/components/schemas/ProblemDetails'
8632 UnprocessableEntity:
8633 description: The request was well-formed but was unable to be followed due to semantic errors.
8634 content:
8635 application/json:
8636 schema:
8637 $ref: '#/components/schemas/ProblemDetails'
8638 InternalServerError:
8639 description: Internal server error.
8640 content:
8641 application/json:
8642 schema:
8643 $ref: '#/components/schemas/ProblemDetails'
8644 ServiceUnavailable:
8645 description: Service temporarily unavailable.
8646 content:
8647 application/json:
8648 schema:
8649 $ref: '#/components/schemas/ProblemDetails'
8650 UnexpectedError:
8651 description: Unexpected error.
8652 content:
8653 application/json:
8654 schema:
8655 $ref: '#/components/schemas/ProblemDetails'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8656 VnfDescriptor:
8657 description: VNF Descriptor (plaintext)
8658 content:
8659 text/plain:
8660 schema:
8661 $ref: '#/components/schemas/VnfDescriptor'
8662 VnfPackage:
8663 description: VNF Package (compressed)
8664 content:
8665 application/zip:
8666 schema:
8667 $ref: '#/components/schemas/VnfPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8668 NsDescriptor:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8669 description: NS Descriptor (plaintext)
8670 content:
8671 text/plain:
8672 schema:
8673 $ref: '#/components/schemas/NsDescriptor'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8674 NsPackage:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8675 description: NS Package (compressed)
8676 content:
8677 application/zip:
8678 schema:
8679 $ref: '#/components/schemas/NsPackage'
8680 NetSliceTemplate:
8681 description: NetSlice Template (plaintext)
8682 content:
8683 text/plain:
8684 schema:
8685 $ref: '#/components/schemas/NetSliceTemplate'
8686 NetSlicePackage:
8687 description: NetSlice Package (compressed)
8688 content:
8689 application/zip:
8690 schema:
8691 $ref: '#/components/schemas/NetSlicePackage'
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]8692 NslcmSubscriptionResponse:
8693 description: NslcmSubscriptionResponse
8694 content:
8695 application/json:
8696 schema:
8697 $ref: '#/components/schemas/NslcmSubscriptionResponse'
8698 application/yaml:
8699 schema:
8700 $ref: '#/components/schemas/NslcmSubscriptionResponse'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8701 # END RESPONSES
8702
8703 schemas:
8704 ObjectId:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8705 type: object
8706 properties:
8707 id:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8708 type: string
8709 format: uuid
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]8710 ObjectIdList:
8711 type: object
8712 properties:
8713 ns_ids:
8714 type: array
8715 items:
8716 type: string
8717 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8718 KeyValuePairs:
8719 # A free list of key:value pairs
8720 type: object
8721 additionalProperties: true
8722 NsDescriptor:
8723 type: string
8724 format: yaml|json
8725 NsPackage:
8726 type: string
8727 format: binary
8728 CreateNsdInfoRequest:
8729 # A free list of key:value pairs
8730 type: object
8731 additionalProperties: true
8732 NsdInfoModifications:
8733 description: |
8734 NS Descriptor Information
8735 Only generic fields (id, name, description) are described
8736 For a full specification of the NS Descriptor see:
8737 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
8738 type: object
8739 properties:
8740 id:
8741 description: NSD Identifier
8742 type: string
8743 name:
8744 description: NSD Name
8745 type: string
8746 description:
8747 description: NSD Description
8748 type: string
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]8749 AlarmInfoModifications:
8750 description: |
8751 Alarm Information
8752 type: object
8753 properties:
8754 id:
8755 description: UUID
8756 type: string
8757 is_enable:
8758 description: To enable/disable the alarm.
8759 type: string
8760 threshold:
8761 description: Threshold value of the Alarm
8762 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8763 NsdInfo:
8764 description: |
8765 NS Descriptor Information
8766 Only generic fields (_id, id, name, description) are described
8767 For a full specification of the NS Descriptor see:
8768 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
8769 type: object
8770 properties:
8771 _id:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8772 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8773 Identifier of the onboarded individual NS descriptor
8774 resource. This identifier is allocated by the NFVO.
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8775 type: string
8776 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8777 id:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8778 description: |
8779 This identifier, which is allocated by the NSD
8780 designer, identifies the NSD in a globally unique
8781 way. It is copied from the NSD content and shall be
8782 present after the NSD content is on-boarded.
8783 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8784 name:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8785 description: |
8786 Name of the onboarded NSD. This information is
8787 copied from the NSD content and shall be present
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8788 after the NSD content is on-boarded.
8789 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8790 description:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8791 description: |
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8792 Description of the onboarded NSD.
8793 This information is copied from the NSD content.
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8794 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8795 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8796 - _id
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8797 - id
8798 ArrayOfNsdInfo:
8799 type: array
8800 items:
8801 $ref: '#/components/schemas/NsdInfo'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]8802 ProblemDetails:
8803 type: object
8804 properties:
8805 type:
8806 type: string
8807 format: uri
8808 title:
8809 type: string
8810 status:
8811 type: integer
8812 detail:
8813 type: string
8814 instance:
8815 type: string
8816 format: uri
8817 additionalProperties: true
8818 required:
8819 - status
8820 - detail
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]8821 CreateNsConfigTemplateInfoRequest:
8822 type: object
8823 properties:
8824 name:
8825 description: Ns Config Template name
8826 type: string
8827 nsdId:
8828 description: |
8829 ID of NS descriptor to which
8830 template is associated
8831 type: string
8832 config:
8833 description: Instantiation parameters
8834 type: object
8835 additionalProperties: false
8836 required:
8837 - name
8838 - nsdId
8839 - config
8840 additionalProperties: false
8841 NsConfigTemplateInfo:
8842 description: |
8843 Ns Config template information includes NSD ID, name
8844 and instantiation parameters of vld, vnf, additionParamForVnf,
8845 additionalParamsForNs.
8846 type: object
8847 properties:
8848 _id:
8849 description: |
8850 Identifier of the inboarded Ns config template resource.
8851 type: string
8852 format: uuid
8853 name:
8854 description: |
8855 Name of the onboarded Ns config template. This information
8856 is given by the user and it is unique.
8857 type: string
8858 nsdId:
8859 description: |
8860 Identifier of the NS descriptor, which is associated
8861 with Ns config template
8862 type: string
8863 config:
8864 description: |
8865 It includes instantiation parameters such as
8866 vld, vnf, additionalParamforVnf.
8867 type: object
8868 ArrayOfNsConfigTemplateInfo:
8869 type: array
8870 items:
8871 $ref: '#/components/schemas/NsConfigTemplateInfo'
8872 NsConfigTemplateInfoModifications:
8873 description: |
8874 Ns Config Template information
8875 It includes name of the template and instantiation parameters.
8876 Ns descriptor id cannot be edited.
8877 type: object
8878 properties:
8879 name:
8880 description: |
8881 Name of the template
8882 type: string
8883 config:
8884 description: |
8885 Instantiation parameters such as vld, vnf, additionalParamsForVnf
8886 can be edit.
8887 type: object
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8888 VnfDescriptor:
8889 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8890 format: yaml|json
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8891 VnfPackage:
8892 type: string
8893 format: binary
8894 CreateVnfPkgInfoRequest:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8895 # A free list of key:value pairs
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8896 type: object
8897 additionalProperties: true
8898 VnfPkgInfoModifications:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8899 description: |
8900 VNF Package Information
8901 Only generic fields (id, name, description) are described
8902 For a full specification of the VNF Descriptor see:
8903 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8904 type: object
8905 properties:
8906 id:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8907 description: VNF Package Identifier
8908 type: string
8909 name:
8910 description: VNF Package Name
8911 type: string
8912 description:
8913 description: VNF Package description
8914 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8915 VnfPkgInfo:
8916 description: |
8917 VNF Package Information
8918 Only generic fields (_id, id, name, description) are described
8919 For a full specification of the VNF Descriptor see:
8920 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
8921 type: object
8922 properties:
8923 _id:
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8924 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8925 Identifier of the VNF package. This identifier is allocated by the NFVO.
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8926 type: string
8927 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8928 id:
8929 description: VNF Package Identifier
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8930 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8931 name:
8932 description: VNF Package Name
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8933 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8934 description:
8935 description: VNF Package description
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8936 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8937 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8938 - _id
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8939 - id
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]8940 ArrayOfVnfPkgInfo:
8941 type: array
8942 items:
8943 $ref: '#/components/schemas/VnfPkgInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8944 # CreateNsRequest:
8945 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8946 NsInstance:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8947 description: |
8948 NS Instance Information
8949 Only generic fields (_id, id, name, description) are described
8950 For a full specification of the NS Instance see:
8951 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8952 type: object
8953 properties:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8954 _id:
8955 description: Identifier of the NS instance.
8956 type: string
8957 format: uuid
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8958 id:
8959 description: Identifier of the NS instance.
8960 type: string
8961 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8962 name:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8963 description: Human readable name of the NS instance.
8964 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8965 description:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8966 description: Human readable description of the NS instance.
8967 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8968 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8969 - _id
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8970 - id
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8971 - name
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8972 InstantiateNsRequest:
8973 type: object
8974 properties:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8975 nsName:
8976 description: |
8977 Human-readable name of the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8978 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8979 nsdId:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8980 description: |
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8981 Identifier of the NSD that defines the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8982 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8983 format: uuid
8984 vimAccountId:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8985 description: |
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8986 Identifier of the VIM Account where the NS instance shall be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]8987 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]8988 format: uuid
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]8989 nsConfigTemplateId:
8990 description: |
8991 Identifier of the Ns config template which is selected
8992 while instantiation
8993 type: string
8994 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8995 lcmOperationType:
8996 type: string
8997 nsInstanceId:
8998 type: string
8999 format: uuid
9000 netsliceInstanceId:
9001 type: string
9002 format: uuid
9003 nsDescription:
9004 type: string
9005 nullable: true
9006 wimAccountId:
9007 oneOf:
9008 - type: string
9009 - type: boolean
9010 nullable: true
9011 additionalParamsForNs:
9012 type: object
9013 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9014 additionalParamsForVnf: &additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9015 type: array
9016 items:
9017 type: object
9018 properties:
9019 member-vnf-index:
9020 type: string
9021 additionalParams:
9022 type: object
9023 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9024 k8s-namespace:
9025 type: string
9026 description: |
9027 use this namespace for all the KDU deployed in this VNF
9028 (if any). By default it is used the id of the project
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9029 additionalParamsForVdu:
9030 type: array
9031 items:
9032 type: object
9033 properties:
9034 vdu_id:
9035 type: string
9036 additionalParams:
9037 type: object
9038 additionalProperties: true
9039 required:
9040 - vdu_id
9041 - additionalParams
9042 additionalProperties: false
9043 additionalParamsForKdu:
9044 type: array
9045 items:
9046 type: object
9047 properties:
9048 kdu_name:
9049 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9050 k8s-namespace:
9051 type: string
9052 description: use this namespace for this KDU
9053 kdu_model:
9054 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9055 additionalParams:
9056 type: object
9057 additionalProperties: true
9058 required:
9059 - kdu_name
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9060 minProperties: 2
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9061 additionalProperties: false
9062 required:
9063 - member-vnf-index
9064 minProperties: 2
9065 additionalProperties: false
9066 ssh_keys:
9067 type: array
9068 items:
9069 type: string
9070 nsr_id:
9071 type: string
9072 format: uuid
9073 vduImage:
9074 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9075 placement-engine:
9076 type: string
9077 description: |
9078 To compute automatically the target VIM for each VNF based on
9079 constrains, e.g. latency. Currently only 'PLA' is supported
9080 placement-constraints:
9081 type: object
9082 additionalProperties: true
9083 k8s-namespace:
9084 type: string
9085 timeout_ns_deploy:
9086 type: integer
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9087 vnf:
9088 type: array
9089 items:
9090 type: object
9091 properties:
9092 member-vnf-index:
9093 type: string
9094 vimAccountId:
9095 type: string
9096 format: uuid
9097 vdu:
9098 type: array
9099 items:
9100 type: object
9101 properties:
9102 id:
9103 type: string
9104 volume:
9105 type: array
9106 items:
9107 type: object
9108 properties:
9109 name:
9110 type: string
9111 vim-volume-id:
9112 type: string
9113 required:
9114 - name
9115 - vim-volume-id
9116 additionalProperties: false
9117 minItems: 1
9118 interface:
9119 type: array
9120 items:
9121 type: object
9122 properties:
9123 name:
9124 type: string
9125 ip-address:
9126 type: string
9127 format: ipv4
9128 mac-address:
9129 type: string
9130 format: mac_address
9131 floating-ip-required:
9132 type: boolean
9133 required:
9134 - name
9135 additionalProperties: false
9136 minItems: 1
9137 required:
9138 - id
9139 additionalProperties: false
9140 minItems: 1
9141 internal-vld:
9142 type: array
9143 items:
9144 type: object
9145 properties:
9146 name:
9147 type: string
9148 vim-network-name:
9149 type: string
9150 vim-network-id:
9151 type: string
9152 ip-profile:
9153 type: object
9154 properties:
9155 ip-version:
9156 type: string
9157 enum:
9158 - ipv4
9159 - ipv6
9160 subnet-address:
9161 type: string
9162 format: ip_prefix
9163 nullable: true
9164 gateway-address:
9165 type: string
9166 format: ipv4
9167 nullable: true
9168 dns-server:
9169 type: array
9170 items:
9171 type: object
9172 properties:
9173 address:
9174 type: string
9175 format: ipv4
9176 required:
9177 - address
9178 additionalProperties: false
9179 minItems: 1
9180 nullable: true
9181 dhcp-params:
9182 type: object
9183 properties:
9184 enabled:
9185 type: boolean
9186 count:
9187 type: integer
9188 minimum: 1
9189 start-address:
9190 type: string
9191 format: ipv4
9192 additionalProperties: false
9193 nullable: true
9194 additionalProperties: false
9195 provider-network:
9196 type: object
9197 properties:
9198 physical-network:
9199 type: string
9200 segmentation-id:
9201 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9202 network-type:
9203 type: string
9204 sdn-ports:
9205 description: |
9206 connect additional ports to the created underlay SDN connectivity.
9207 Normally for external connectivy.
9208 type: array
9209 items:
9210 type: object
9211 properties:
9212 switch_id:
9213 type: string
9214 switch_port:
9215 type: string
9216 mac_address:
9217 type: string
9218 format: mac_address
9219 vlan:
9220 type: integer
9221 additionalProperties: true
9222 required:
9223 - switch_id
9224 - switch_port
9225 minItems: 1
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9226 additionalProperties: false
9227 internal-connection-point:
9228 type: array
9229 items:
9230 type: object
9231 properties:
9232 id-ref:
9233 type: string
9234 ip-address:
9235 type: string
9236 format: ipv4
9237 required:
9238 - id-ref
9239 minProperties: 2
9240 additionalProperties: False
9241 minItems: 1
9242 required:
9243 - name
9244 minProperties: 2
9245 additionalProperties: false
9246 minItems: 1
9247 required:
9248 - member-vnf-index
9249 minProperties: 2
9250 additionalProperties: false
9251 minItems: 1
9252 vld:
9253 type: array
9254 items:
9255 type: object
9256 properties:
9257 name:
9258 type: string
9259 vim-network-name:
9260 oneOf:
9261 - type: string
9262 - type: object
9263 vim-network-id:
9264 oneOf:
9265 - type: string
9266 - type: object
9267 ns-net:
9268 type: object
9269 additionalProperties: true
9270 wimAccountId:
9271 oneOf:
9272 - type: string
9273 - type: boolean
9274 nullable: true
9275 ip-profile:
9276 type: object
9277 additionalProperties: true
9278 provider-network:
9279 type: object
9280 properties:
9281 physical-network:
9282 type: string
9283 segmentation-id:
9284 type: string
9285 additionalProperties: false
9286 vnfd-connection-point-ref:
9287 type: array
9288 items:
9289 type: object
9290 properties:
9291 member-vnf-index-ref:
9292 type: string
9293 vnfd-connection-point-ref:
9294 type: string
9295 ip-address:
9296 type: string
9297 format: ipv4
9298 required:
9299 - member-vnf-index-ref
9300 - vnfd-connection-point-ref
9301 minProperties: 3
9302 additionalProperties: false
9303 minItems: 1
9304 required:
9305 - name
9306 additionalProperties: false
9307 minItems: 1
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9308 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9309 - nsName
9310 - nsdId
9311 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9312 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9313 ScaleNsRequest:
9314 type: object
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9315 properties:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9316 scaleType:
9317 type: string
9318 enum:
9319 - SCALE_VNF
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9320 timeout_ns_scale:
9321 description: timeout for the scale operation
9322 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9323 scaleVnfData:
9324 type: object
9325 properties:
9326 scaleVnfType:
9327 type: string
9328 enum:
9329 - SCALE_IN
9330 - SCALE_OUT
9331 scaleByStepData:
9332 type: object
9333 properties:
9334 scaling-group-descriptor:
9335 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9336 scaling-policy:
9337 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9338 member-vnf-index:
9339 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9340 required:
9341 - scaling-group-descriptor
9342 - member-vnf-index
9343 additionalProperties: false
9344 required:
9345 - scaleVnfType
9346 - scaleByStepData
9347 additionalProperties: false
9348 required:
9349 - scaleType
9350 - scaleVnfData
9351 additionalProperties: false
garciadeblasb5a065f2022-02-11 00:27:47 +0100[diff] [blame]9352 HealNsRequest:
9353 description: >
9354 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
9355 instance by healing one or more of the VNF that are part of this NS.
9356 type: object
9357 properties:
9358 timeout_ns_heal:
9359 description: timeout for the heal operation in seconds
9360 type: integer
9361 healVnfData:
9362 description: >
9363 List of VNF to be healed, together with the information needed to heal each.
9364 type: array
9365 items:
9366 $ref: "#/components/schemas/HealVnfData"
9367 required:
9368 - healVnfData
9369 HealVnfData:
9370 description: >
9371 This type represents the information to heal a VNF that is part of an NS.
9372 type: object
9373 required:
9374 - vnfInstanceId
9375 properties:
9376 vnfInstanceId:
9377 description: >
9378 Identifies the VNF instance, part of the NS, requiring a
9379 healing action.
9380 type: string
9381 format: uuid
9382 cause:
9383 description: >
9384 Indicates the reason why a healing procedure is required.
9385 type: string
9386 additionalParams:
9387 description: >
9388 Additional parameters passed by the NFVO as input to
9389 the healing process, specific to the VNF being healed.
9390 type: object
9391 properties:
9392 run-day1:
9393 description: >
9394 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
9395 type: boolean
9396 default: false
9397 vdu:
9398 description: >
9399 List of VDU to be healed, together with the information needed to heal each.
9400 type: array
9401 items:
9402 $ref: "#/components/schemas/HealVduData"
9403 HealVduData:
9404 description: >
9405 This type represents the information to heal a VDU that is part of a VNF.
9406 type: object
9407 required:
9408 - vdu-id
9409 properties:
9410 vdu-id:
9411 description: >
9412 Identifies the VDU id, part of the VNF, requiring a healing action.
9413 type: string
9414 format: uuid
9415 count-index:
9416 description: >
9417 Indicates the VDU number when the VDU is part of a scale-group.
9418 type: integer
9419 minimum: 0
9420 run-day1:
9421 description: >
9422 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
9423 type: boolean
9424 default: false
elumalai4b120f12022-04-28 16:44:35 +0530[diff] [blame]9425 NSinstanceMigrateRequest:
9426 description: >
9427 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
9428 instance by migrating one or more of the VDUs that are part of this NS.
9429 type: object
9430 properties:
9431 vnfInstanceId:
9432 type: string
9433 migrateToHost:
9434 type: string
9435 vdu:
9436 type: object
9437 properties:
9438 vduId:
9439 type: string
9440 vduCountIndex:
9441 type: integer
9442 required:
9443 - vduId
9444 required:
9445 - vnfInstanceId
9446 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9447 TerminateNsRequest:
9448 type: object
9449 properties:
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9450 timeout_ns_terminate:
9451 description: timeout for terminate operation
9452 type: integer
9453 autoremove:
9454 description: remove network service if termination end without error
9455 type: boolean
9456 skip_terminate_primitives:
9457 description: Do not execute network service termination primitives
9458 type: boolean
9459 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9460 ArrayOfNsInstance:
9461 type: array
9462 items:
9463 $ref: '#/components/schemas/NsInstance'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9464 NSinstanceActionRequest:
9465 type: object
9466 properties:
9467 primitive:
9468 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9469 description: |
9470 name of the primitive in the 'config-descriptor'. If the target is
9471 a kdu it can be also 'status', 'rollback' or 'upgrade'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9472 primitive_params:
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9473 description: parameters of this primitive
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9474 $ref: '#/components/schemas/KeyValuePairs'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9475 member_vnf_index:
9476 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9477 description: provide if the target action is for a vnf, vdu or kdu
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9478 vdu_id:
9479 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9480 description: provide if the target action is for a vdu
9481 kdu_name:
9482 type: string
9483 description: provide if the target action is for a kdu
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9484 vdu_count_index:
9485 type: integer
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9486 timeout_ns_action:
9487 description: timeout for the day 1/2 operation
9488 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9489 required:
9490 - primitive
9491 - primitive_params
9492 additionalProperties: false
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]9493 UpdateNsRequest:
9494 description: >
9495 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
9496 instance by updating one or more of the VNFs that are part of this NS.
9497 type: object
9498 properties:
9499 updateType:
9500 type: string
9501 enum:
9502 - CHANGE_VNFPKG
9503 - REMOVE_VNF
9504 - MODIFY_VNF_INFORMATION
k4.rahul66c884c2022-06-21 06:38:49 +0000[diff] [blame]9505 - OPERATE_VNF
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9506 - VERTICAL_SCALE
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]9507 changeVnfPackageData:
9508 type: object
9509 properties:
9510 vnfInstanceId:
9511 type: string
9512 vnfdId:
9513 type: string
9514 required:
9515 - vnfInstanceId
9516 - vnfdId
9517 removeVnfInstanceId:
9518 type: string
9519 modifyVnfInfoData:
9520 type: object
9521 properties:
9522 vnfInstanceId:
9523 type: string
9524 vnfdId:
9525 type: string
9526 required:
9527 - vnfInstanceId
9528 - vnfdId
k4.rahul66c884c2022-06-21 06:38:49 +0000[diff] [blame]9529 operateVnfData:
9530 type: object
9531 properties:
9532 vnfInstanceId:
9533 type: string
9534 changeStateTo:
9535 type: string
9536 additionalParam:
9537 type: object
9538 properties:
9539 run-day1:
9540 type: boolean
9541 vdu_id:
9542 type: string
9543 count-index:
9544 type: number
9545 required:
9546 - vdu_id
9547 - count-index
9548 required:
9549 - vnfInstanceId
9550 - changeStateTo
9551 additionalProperties: false
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9552 verticalScaleVnf:
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]9553 type: object
9554 properties:
9555 vnfInstanceId:
9556 type: string
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9557 vnfdId:
9558 type: string
9559 vduId:
9560 type: string
9561 countIndex:
9562 type: number
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]9563 required:
9564 - vnfInstanceId
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9565 - vnfdId
9566 - vduId
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]9567 required:
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9568 - updateType
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]9569 additionalProperties: false
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]9570 MultiNsTerminateRequest:
9571 type: object
9572 properties:
9573 ns_ids:
9574 description: List of Ns instance Ids to be deleted
9575 type: array
9576 items:
9577 type: string
9578 format: uuid
9579 autoremove:
9580 description: remove network service if termination end without error
9581 type: boolean
9582 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9583 # CreateNSinstanceContentRequest:
9584 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9585 CreateNSinstanceContentResponse:
9586 type: object
9587 properties:
9588 id:
9589 type: string
9590 format: uuid
9591 nslcmop_id:
9592 type: string
9593 format: uuid
9594 NsLcmOpOcc:
9595 type: object
9596 properties:
9597 _id:
9598 type: string
9599 format: uuid
9600 id:
9601 type: string
9602 format: uuid
9603 lcmOperationType:
9604 type: string
9605 nsInstanceId:
9606 type: string
9607 format: uuid
9608 isAutomaticInvocation:
9609 type: boolean
9610 isCancelPending:
9611 type: boolean
9612 startTime:
9613 type: number
9614 format: float
9615 statusEnteredTime:
9616 type: number
9617 format: float
9618 operationParams:
9619 type: object
9620 properties:
9621 nsName:
9622 type: string
9623 nsdId:
9624 type: string
9625 format: uuid
9626 vimAccountId:
9627 type: string
9628 format: uuid
9629 nsInstanceId:
9630 type: string
9631 format: uuid
9632 lcmOperationType:
9633 type: string
9634 operationState:
9635 type: string
9636 detailed-status:
9637 type: string
9638 links:
9639 type: object
9640 properties:
9641 self:
9642 type: string
9643 format: path # uri?
9644 nsInstance:
9645 type: string
9646 format: path # uri?
9647 ArrayOfNsLcmOpOcc:
9648 type: array
9649 items:
9650 $ref: '#/components/schemas/NsLcmOpOcc'
9651 VnfInstanceInfo:
9652 description: |
9653 VNF Instance Information
9654 Only generic fields (_id, id) are described
9655 For a full specification of the VNF Instance see:
9656 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
9657 type: object
9658 properties:
9659 _id:
9660 type: string
9661 format: uuid
9662 id:
9663 type: string
9664 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9665 ArrayOfVnfInstanceInfo:
9666 type: array
9667 items:
9668 $ref: '#/components/schemas/VnfInstanceInfo'
9669 NstInfo:
9670 description: |
9671 NetSlice Template Information
9672 Only generic fields (_id, id, name) are described
9673 For a full specification of the NetSlice Template see:
9674 http://osm-download.etsi.org/ftp/osm-doc/nst.html
9675 type: object
9676 properties:
9677 _id:
9678 description: NetSlice Template Identifier
9679 type: string
9680 format: uuid
9681 id:
9682 description: Human readable NetSlice Template Identifier
9683 type: string
9684 name:
9685 description: Human readable name of the NetSlice Template
9686 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9687 ArrayOfNstInfo:
9688 type: array
9689 items:
9690 $ref: '#/components/schemas/NstInfo'
9691 CreateNstInfoRequest:
9692 # A free list of key:value pairs
9693 type: object
9694 additionalProperties: true
9695 NetSliceTemplate:
9696 type: string
9697 format: yaml|json
9698 NetSlicePackage:
9699 type: string
9700 format: binary
9701 NstInfoModifications:
9702 description: |
9703 NetSlice Template Information
9704 Only generic fields (id, name) are described
9705 For a full specification of the NetSlice Template see:
9706 http://osm-download.etsi.org/ftp/osm-doc/nst.html
9707 type: object
9708 properties:
9709 id:
9710 description: NST Identifier
9711 type: string
9712 name:
9713 description: NST Name
9714 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9715 NetSliceInstance:
9716 description: |
9717 NetSlice Instance Information
9718 Only generic fields (_id, id, name, description) are described
9719 For a full specification of the NetSlice Instance see:
9720 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
9721 type: object
9722 properties:
9723 _id:
9724 description: Identifier of the NetSlice instance.
9725 type: string
9726 format: uuid
9727 id:
9728 description: Identifier of the NetSlice instance.
9729 type: string
9730 format: uuid
9731 name:
9732 description: Human readable name of the NetSlice instance.
9733 type: string
9734 description:
9735 description: Human readable description of the NetSlice instance.
9736 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9737 required:
9738 - _id
9739 - id
9740 - name
9741 ArrayOfNetSliceInstance:
9742 type: array
9743 items:
9744 $ref: '#/components/schemas/NetSliceInstance'
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]9745 Alarm:
9746 description: |
9747 Alarm Information
9748 type: object
9749 properties:
9750 _id:
9751 description: Identifier of the Alarm.
9752 type: string
9753 format: uuid
9754 id:
9755 description: Identifier of the Alarm.
9756 type: string
9757 format: uuid
9758 metric:
9759 description: Alarm metric.
9760 type: string
9761 threshold:
9762 description: Threshold value of the Alarm.
9763 type: number
9764 format: float
9765 operation:
9766 description: Operation to be applied.
9767 type: string
9768 action:
9769 description: Action to be taken.
9770 type: string
9771 status:
9772 description: Current status of the alarm.
9773 type: string
9774 required:
9775 - _id
9776 - id
9777 - metric
9778 - threshold
9779 - operation
9780 ArrayOfAlarm:
9781 type: array
9782 items:
9783 $ref: '#/components/schemas/Alarm'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9784 # CreateNsiRequest:
9785 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9786 InstantiateNsiRequest:
9787 type: object
9788 properties:
9789 nsiName:
9790 description: |
9791 Human-readable name of the NetSlice instance to be created.
9792 type: string
9793 nstId:
9794 description: |
9795 Identifier of the NST that defines the NetSlice instance to be created.
9796 type: string
9797 format: uuid
9798 vimAccountId:
9799 description: |
9800 Identifier of the VIM Account where the NetSlice instance shall be created.
9801 type: string
9802 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9803 lcmOperationType:
9804 type: string
9805 netsliceInstanceId:
9806 type: string
9807 format: uuid
9808 nsiDescription:
9809 type: string
9810 nullable: true
9811 ssh_keys:
9812 type: string
9813 nsi_id:
9814 type: string
9815 format: uuid
9816 additionalParamsForNsi:
9817 type: object
9818 additionalProperties: true
9819 netslice-subnet:
9820 type: array
9821 items:
9822 type: object
9823 properties:
9824 id:
9825 type: string
9826 nsName:
9827 type: string
9828 nsdId:
9829 type: string
9830 format: uuid
9831 vimAccountId:
9832 type: string
9833 format: uuid
9834 lcmOperationType:
9835 type: string
9836 nsInstanceId:
9837 type: string
9838 format: uuid
9839 netsliceInstanceId:
9840 type: string
9841 format: uuid
9842 nsDescription:
9843 type: string
9844 nullable: true
9845 wimAccountId:
9846 oneOf:
9847 - type: string
9848 - type: boolean
9849 nullable: true
9850 additionalParamsForNs:
9851 type: object
9852 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9853 additionalParamsForVnf: *additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9854 ssh_keys:
9855 type: array
9856 items:
9857 type: string
9858 nsr_id:
9859 type: string
9860 format: uuid
9861 vduImage:
9862 type: string
9863 vnf:
9864 type: array
9865 items:
9866 type: object
9867 properties:
9868 member-vnf-index:
9869 type: string
9870 vimAccountId:
9871 type: string
9872 format: uuid
9873 vdu:
9874 type: array
9875 items:
9876 type: object
9877 properties:
9878 id:
9879 type: string
9880 volume:
9881 type: array
9882 items:
9883 type: object
9884 properties:
9885 name:
9886 type: string
9887 vim-volume-id:
9888 type: string
9889 required:
9890 - name
9891 - vim-volume-id
9892 additionalProperties: false
9893 minItems: 1
9894 interface:
9895 type: array
9896 items:
9897 type: object
9898 properties:
9899 name:
9900 type: string
9901 ip-address:
9902 type: string
9903 format: ipv4
9904 mac-address:
9905 type: string
9906 format: mac_address
9907 floating-ip-required:
9908 type: boolean
9909 required:
9910 - name
9911 additionalProperties: false
9912 minItems: 1
9913 required:
9914 - id
9915 additionalProperties: false
9916 minItems: 1
9917 internal-vld:
9918 type: array
9919 items:
9920 type: object
9921 properties:
9922 name:
9923 type: string
9924 vim-network-name:
9925 type: string
9926 vim-network-id:
9927 type: string
9928 ip-profile:
9929 type: object
9930 properties:
9931 ip-version:
9932 type: string
9933 enum:
9934 - ipv4
9935 - ipv6
9936 subnet-address:
9937 type: string
9938 format: ip_prefix
9939 nullable: true
9940 gateway-address:
9941 type: string
9942 format: ipv4
9943 nullable: true
9944 dns-server:
9945 type: array
9946 items:
9947 type: object
9948 properties:
9949 address:
9950 type: string
9951 format: ipv4
9952 required:
9953 - address
9954 additionalProperties: false
9955 minItems: 1
9956 nullable: true
9957 dhcp-params:
9958 type: object
9959 properties:
9960 enabled:
9961 type: boolean
9962 count:
9963 type: integer
9964 minimum: 1
9965 start-address:
9966 type: string
9967 format: ipv4
9968 additionalProperties: false
9969 nullable: true
9970 additionalProperties: false
9971 provider-network:
9972 type: object
9973 properties:
9974 physical-network:
9975 type: string
9976 segmentation-id:
9977 type: string
9978 additionalProperties: false
9979 internal-connection-point:
9980 type: array
9981 items:
9982 type: object
9983 properties:
9984 id-ref:
9985 type: string
9986 ip-address:
9987 type: string
9988 format: ipv4
9989 required:
9990 - id-ref
9991 minProperties: 2
9992 additionalProperties: False
9993 minItems: 1
9994 required:
9995 - name
9996 minProperties: 2
9997 additionalProperties: false
9998 minItems: 1
9999 required:
10000 - member-vnf-index
10001 minProperties: 2
10002 additionalProperties: false
10003 minItems: 1
10004 vld:
10005 type: array
10006 items:
10007 type: object
10008 properties:
10009 name:
10010 type: string
10011 vim-network-name:
10012 oneOf:
10013 - type: string
10014 - type: object
10015 vim-network-id:
10016 oneOf:
10017 - type: string
10018 - type: object
10019 ns-net:
10020 type: object
10021 additionalProperties: true
10022 wimAccountId:
10023 oneOf:
10024 - type: string
10025 - type: boolean
10026 nullable: true
10027 ip-profile:
10028 type: object
10029 additionalProperties: true
10030 provider-network:
10031 type: object
10032 properties:
10033 physical-network:
10034 type: string
10035 segmentation-id:
10036 type: string
10037 additionalProperties: false
10038 vnfd-connection-point-ref:
10039 type: array
10040 items:
10041 type: object
10042 properties:
10043 member-vnf-index-ref:
10044 type: string
10045 vnfd-connection-point-ref:
10046 type: string
10047 ip-address:
10048 type: string
10049 format: ipv4
10050 required:
10051 - member-vnf-index-ref
10052 - vnfd-connection-point-ref
10053 minProperties: 3
10054 additionalProperties: false
10055 minItems: 1
10056 required:
10057 - name
10058 additionalProperties: false
10059 minItems: 1
10060 additionalProperties: false
10061 minItems: 1
10062 netslice-vld:
10063 type: array
10064 items:
10065 type: object
10066 properties:
10067 name:
10068 type: string
10069 vim-network-name:
10070 oneOf:
10071 - type: string
10072 - type: object
10073 vim-network-id:
10074 oneOf:
10075 - type: string
10076 - type: object
10077 ip-profile:
10078 type: object
10079 additionalProperties: true
10080 required:
10081 - name
10082 additionalProperties: false
10083 minItems: 1
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10084 required:
10085 - nsiName
10086 - nstId
10087 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10088 additionalProperties: false
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10089 TerminateNsiRequest:
10090 type: object
10091 properties:
10092 terminationTime:
10093 description: |
10094 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
10095 automatically at this timestamp. Cardinality "0" indicates the NSI termination
10096 takes place immediately.
10097 type: string
10098 format: date-time
10099 NsiActionRequest:
10100 type: object
10101 properties:
10102 primitive:
10103 type: string
10104 primitive_params:
10105 $ref: '#/components/schemas/KeyValuePairs'
10106 lcmOperationType:
10107 type: string
10108 netsliceInstanceId:
10109 type: string
10110 format: uuid
10111 required:
10112 - primitive
10113 - primitive_params
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10114 # CreateNsiContentRequest:
10115 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10116 CreateNsiContentResponse:
10117 type: object
10118 properties:
10119 id:
10120 type: string
10121 format: uuid
10122 nsilcmop_id:
10123 type: string
10124 format: uuid
10125 NsiLcmOpOcc:
10126 type: object
10127 properties:
10128 _id:
10129 type: string
10130 format: uuid
10131 id:
10132 type: string
10133 format: uuid
10134 lcmOperationType:
10135 type: string
10136 netsliceInstanceId:
10137 type: string
10138 format: uuid
10139 isAutomaticInvocation:
10140 type: boolean
10141 isCancelPending:
10142 type: boolean
10143 startTime:
10144 type: number
10145 format: float
10146 statusEnteredTime:
10147 type: number
10148 format: float
10149 operationParams:
10150 type: object
10151 properties:
10152 nsiName:
10153 type: string
10154 nstId:
10155 type: string
10156 format: uuid
10157 vimAccountId:
10158 type: string
10159 format: uuid
10160 netsliceInstanceId:
10161 type: string
10162 format: uuid
10163 lcmOperationType:
10164 type: string
10165 nslcmops_ids:
10166 type: array
10167 items:
10168 type: string
10169 format: uuid
10170 operationState:
10171 type: string
10172 detailed-status:
10173 type: string
10174 links:
10175 type: object
10176 properties:
10177 self:
10178 type: string
10179 format: path # uri?
10180 netsliceInstanceId:
10181 type: string
10182 format: path # uri?
10183 ArrayOfNsiLcmOpOcc:
10184 type: array
10185 items:
10186 $ref: '#/components/schemas/NsiLcmOpOcc'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10187 TokenInfo:
10188 type: object
10189 properties:
10190 _id:
10191 type: string
10192 id:
10193 type: string
10194 admin:
10195 type: boolean
selvi.j9058fd92023-04-18 14:58:14 +0000[diff] [blame]10196 admin_show:
10197 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10198 project_id:
10199 type: string
10200 format: uuid
10201 user_id:
10202 type: string
10203 format: uuid
10204 project_name:
10205 type: string
10206 username:
10207 type: string
10208 issued_at:
10209 type: number
10210 format: float
selvi.j9058fd92023-04-18 14:58:14 +0000[diff] [blame]10211 user_show:
10212 type: boolean
10213 last_login:
10214 type: number
10215 format: float
10216 login_count:
10217 type: number
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10218 expires:
10219 type: number
10220 format: float
10221 remote_host:
10222 type: string
10223 format: ipv4
10224 remote_port:
10225 type: integer
10226 roles:
10227 type: array
10228 items:
10229 type: object
10230 properties:
10231 id:
10232 type: string
10233 format: uuid
10234 name:
10235 type: string
selvi.ja6f638b2022-03-23 12:27:35 +0000[diff] [blame]10236 PasswordExpiryInfo:
10237 type: object
10238 properties:
10239 id:
10240 type: string
10241 message:
10242 type: string
10243 user_id:
10244 type: string
10245 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10246 ArrayOfTokenInfo:
10247 type: array
10248 items:
10249 $ref: '#/components/schemas/TokenInfo'
10250 CreateTokenRequest:
10251 type: object
10252 properties:
10253 username:
10254 type: string
10255 password:
10256 type: string
10257 project_id:
10258 type: string
10259 required:
10260 - username
10261 - password
10262 UserInfo:
10263 type: object
10264 properties:
10265 _id:
10266 type: string
10267 format: uuid
10268 username:
10269 type: string
10270 password:
10271 type: string
10272 project_role_mappings:
10273 type: array
10274 items:
10275 type: object
10276 properties:
10277 project:
10278 type: string
10279 format: uuid
10280 role:
10281 type: string
10282 format: uuid
10283 project_name:
10284 type: string
10285 role_name:
10286 type: string
10287 projects:
10288 type: array
10289 items:
10290 type: string
10291 ArrayOfUserInfo:
10292 type: array
10293 items:
10294 $ref: '#/components/schemas/UserInfo'
10295 ProjectRoleMappings:
10296 type: array
10297 items:
10298 type: object
10299 properties:
10300 project:
10301 type: string
10302 role:
10303 type: string
10304 required:
10305 - project
10306 - role
10307 additionalProperties: false
10308 ProjectRoleMappingsOpt:
10309 type: array
10310 items:
10311 type: object
10312 properties:
10313 project:
10314 type: string
10315 role:
10316 type: string
10317 required:
10318 - project
10319 additionalProperties: false
10320 CreateUserRequest:
10321 type: object
10322 properties:
10323 username:
10324 type: string
10325 password:
10326 type: string
10327 projects:
10328 type: array
10329 items:
10330 type: string
10331 project_role_mappings:
10332 $ref: '#/components/schemas/ProjectRoleMappings'
10333 required:
10334 - username
10335 - password
10336 additionalProperties: false
10337 ShortNameList:
10338 type: array
10339 items:
10340 type: string
10341 ArrayEditionSchema:
10342 type: object
10343 additionalProperties: true
10344 minProperties: 1
10345 description: |
10346 Array edition keys must start with '$'
10347 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
10348 EditUserRequest:
10349 type: object
10350 properties:
10351 username:
10352 type: string
10353 password:
10354 type: string
selvi.j9058fd92023-04-18 14:58:14 +0000[diff] [blame]10355 old_password:
10356 type: string
10357 system_admin_id:
10358 type: string
10359 format: uuid
10360 unlock:
10361 type: boolean
10362 renew:
10363 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10364 projects:
10365 oneOf:
10366 - $ref: '#/components/schemas/ShortNameList'
10367 - $ref: '#/components/schemas/ArrayEditionSchema'
10368 project_role_mappings:
10369 $ref: '#/components/schemas/ProjectRoleMappings'
10370 add_project_role_mappings:
10371 $ref: '#/components/schemas/ProjectRoleMappings'
10372 remove_project_role_mappings:
10373 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
10374 QuotasInfo:
10375 type: object
10376 properties:
10377 vnfds:
10378 type: integer
10379 minimum: 0
10380 nullable: false
10381 nsds:
10382 type: integer
10383 minimum: 0
10384 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10385 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10386 type: integer
10387 minimum: 0
10388 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10389 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10390 type: integer
10391 minimum: 0
10392 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10393 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10394 type: integer
10395 minimum: 0
10396 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10397 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10398 type: integer
10399 minimum: 0
10400 nullable: false
10401 vim_accounts:
10402 type: integer
10403 minimum: 0
10404 nullable: false
10405 wim_accounts:
10406 type: integer
10407 minimum: 0
10408 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10409 sdn_controllers:
10410 type: integer
10411 minimum: 0
10412 nullable: false
10413 k8sclusters:
10414 type: integer
10415 minimum: 0
10416 nullable: false
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10417 vca:
10418 type: integer
10419 minimum: 0
10420 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10421 k8srepos:
10422 type: integer
10423 minimum: 0
10424 nullable: false
10425 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10426 type: integer
10427 minimum: 0
10428 nullable: false
10429 additionalProperties: false
10430 EditQuotasInfo:
10431 type: object
10432 properties:
10433 vnfds:
10434 type: integer
10435 minimum: 0
10436 nullable: true
10437 nsds:
10438 type: integer
10439 minimum: 0
10440 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10441 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10442 type: integer
10443 minimum: 0
10444 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10445 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10446 type: integer
10447 minimum: 0
10448 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10449 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10450 type: integer
10451 minimum: 0
10452 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10453 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10454 type: integer
10455 minimum: 0
10456 nullable: true
10457 vim_accounts:
10458 type: integer
10459 minimum: 0
10460 nullable: true
10461 wim_accounts:
10462 type: integer
10463 minimum: 0
10464 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10465 sdn_controllers:
10466 type: integer
10467 minimum: 0
10468 nullable: true
10469 k8sclusters:
10470 type: integer
10471 minimum: 0
10472 nullable: true
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10473 vca:
10474 type: integer
10475 minimum: 0
10476 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10477 k8srepos:
10478 type: integer
10479 minimum: 0
10480 nullable: true
10481 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10482 type: integer
10483 minimum: 0
10484 nullable: true
10485 additionalProperties: false
10486 ProjectInfo:
10487 type: object
10488 properties:
10489 _id:
10490 type: string
10491 format: uuid
10492 name:
10493 type: string
10494 quotas:
10495 $ref: '#/components/schemas/QuotasInfo'
10496 ArrayOfProjectInfo:
10497 type: array
10498 items:
10499 $ref: '#/components/schemas/ProjectInfo'
10500 CreateProjectRequest:
10501 type: object
10502 properties:
10503 name:
10504 type: string
10505 admin:
10506 type: boolean
10507 quotas:
10508 $ref: '#/components/schemas/QuotasInfo'
10509 required:
10510 - name
10511 additionalProperties: false
10512 EditProjectRequest:
10513 type: object
10514 properties:
10515 name:
10516 type: string
10517 admin:
10518 type: boolean
10519 quotas:
10520 $ref: '#/components/schemas/EditQuotasInfo'
10521 additionalProperties: false
10522 PermissionsInfo:
10523 type: object
10524 additionalProperties:
10525 type: boolean
10526 nullable: false
10527 description: |
10528 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
10529 Permission values are either true or false
10530 EditPermissionsInfo:
10531 type: object
10532 additionalProperties:
10533 type: boolean
10534 nullable: true
10535 description: |
10536 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
10537 Permission values are either true, false, or null
10538 RoleInfo:
10539 type: object
10540 properties:
10541 _id:
10542 type: string
10543 format: uuid
10544 name:
10545 type: string
10546 permissions:
10547 $ref: '#/components/schemas/PermissionsInfo'
10548 ArrayOfRoleInfo:
10549 type: array
10550 items:
10551 $ref: '#/components/schemas/RoleInfo'
10552 CreateRoleRequest:
10553 type: object
10554 properties:
10555 name:
10556 type: string
10557 permissions:
10558 $ref: '#/components/schemas/PermissionsInfo'
10559 required:
10560 - name
10561 additionalProperties: false
10562 EditRoleRequest:
10563 type: object
10564 properties:
10565 name:
10566 type: string
10567 permissions:
10568 $ref: '#/components/schemas/EditPermissionsInfo'
10569 additionalProperties: false
10570 VimType:
10571 type: string
10572 enum:
10573 - openvim
10574 - openstack
10575 - vmware
10576 - opennebula
10577 - aws
10578 - azure
10579 - fos
10580 VimInfo:
10581 type: object
10582 properties:
10583 _id:
10584 type: string
10585 format: uuid
10586 schema_version:
10587 type: string
10588 format: X.Y[.Z]
10589 schema_type:
10590 type: string
10591 name:
10592 type: string
10593 description:
10594 type: string
10595 vim:
10596 type: string
10597 datacenter:
10598 type: string
10599 vim_type:
10600 $ref: '#/components/schemas/VimType'
10601 vim_url:
10602 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]10603 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10604 vim_tenant_name:
10605 type: string
10606 vim_user:
10607 type: string
10608 vim_password:
10609 type: string
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10610 vca:
10611 type: string
10612 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10613 config:
10614 type: object
10615 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +0000[diff] [blame]10616 resources:
10617 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10618 ArrayOfVimInfo:
10619 type: array
10620 items:
10621 $ref: '#/components/schemas/VimInfo'
10622 CreateVimRequest:
10623 type: object
10624 properties:
10625 schema_version:
10626 type: string
10627 format: X.Y[.Z]
10628 schema_type:
10629 type: string
10630 name:
10631 type: string
10632 description:
10633 type: string
10634 vim:
10635 type: string
10636 datacenter:
10637 type: string
10638 vim_type:
10639 $ref: '#/components/schemas/VimType'
10640 vim_url:
10641 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]10642 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10643 vim_tenant_name:
10644 type: string
10645 vim_user:
10646 type: string
10647 vim_password:
10648 type: string
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10649 vca:
10650 type: string
10651 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10652 config:
10653 type: object
10654 additionalProperties: true
garciadeblas6229f2f2022-11-24 15:03:56 +0100[diff] [blame]10655 prometheus-config:
10656 type: object
10657 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +0000[diff] [blame]10658 resources:
10659 type: object
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame^]10660 creds:
10661 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10662 required:
10663 - name
10664 - vim_url
10665 - vim_type
10666 - vim_user
10667 - vim_password
10668 - vim_tenant_name
10669 additionalProperties: false
10670 EditVimRequest:
10671 type: object
10672 properties:
10673 name:
10674 type: string
10675 description:
10676 type: string
10677 vim:
10678 type: string
10679 datacenter:
10680 type: string
10681 vim_type:
10682 $ref: '#/components/schemas/VimType'
10683 vim_url:
10684 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]10685 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10686 vim_tenant_name:
10687 type: string
10688 vim_user:
10689 type: string
10690 vim_password:
10691 type: string
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10692 vca:
10693 type: string
10694 format: uuid
garciadeblas6229f2f2022-11-24 15:03:56 +0100[diff] [blame]10695 prometheus-config:
10696 type: object
10697 additionalProperties: true
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10698 config:
10699 type: object
10700 additionalProperties: true
10701 additionalProperties: false
10702 ObjectId_plus_OpId:
10703 type: object
10704 properties:
10705 id:
10706 type: string
10707 format: uuid
10708 op_id:
10709 type: string
10710 format: uuid
10711 OpId:
10712 type: object
10713 properties:
10714 op_id:
10715 type: string
10716 format: uuid
10717 WimType:
10718 type: string
10719 enum:
10720 - onos
10721 - odl
10722 - tapi
10723 - dynpac
10724 - fake
10725 WimInfo:
10726 type: object
10727 properties:
10728 _id:
10729 type: string
10730 format: uuid
10731 schema_version:
10732 type: string
10733 format: X.Y[.Z]
10734 schema_type:
10735 type: string
10736 name:
10737 type: string
10738 description:
10739 type: string
10740 wim:
10741 type: string
10742 wim_type:
10743 $ref: '#/components/schemas/WimType'
10744 wim_url:
10745 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]10746 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10747 user:
10748 type: string
10749 password:
10750 type: string
10751 config:
10752 type: object
10753 additionalProperties: true
10754 ArrayOfWimInfo:
10755 type: array
10756 items:
10757 $ref: '#/components/schemas/WimInfo'
10758 CreateWimRequest:
10759 type: object
10760 properties:
10761 schema_version:
10762 type: string
10763 format: X.Y[.Z]
10764 schema_type:
10765 type: string
10766 name:
10767 type: string
10768 description:
10769 type: string
10770 wim:
10771 type: string
10772 wim_type:
10773 $ref: '#/components/schemas/WimType'
10774 wim_url:
10775 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]10776 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10777 user:
10778 type: string
10779 password:
10780 type: string
10781 config:
10782 type: object
10783 additionalProperties: true
10784 required:
10785 - name
10786 - wim_url
10787 - wim_type
10788 additionalProperties: false
10789 EditWimRequest:
10790 type: object
10791 properties:
10792 name:
10793 type: string
10794 description:
10795 type: string
10796 wim:
10797 type: string
10798 wim_type:
10799 type: string
10800 wim_url:
10801 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]10802 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10803 user:
10804 type: string
10805 password:
10806 type: string
10807 config:
10808 type: object
10809 additionalProperties: true
10810 additionalProperties: false
10811 SdnBasicProperties:
10812 type: object
10813 properties:
10814 name:
10815 type: string
10816 description:
10817 type: string
10818 dpid:
10819 type: string
10820 format: mac_address
10821 ip:
10822 type: string
10823 format: ipv4
10824 port:
10825 type: integer
10826 type:
10827 type: string
10828 enum:
10829 - floodlight
10830 - opendaylight
10831 - onos
10832 version:
10833 type: string
10834 user:
10835 type: string
10836 password:
10837 type: string
10838 SdnExtraProperties:
10839 type: object
10840 properties:
10841 _id:
10842 type: string
10843 format: uuid
10844 schema_version:
10845 type: string
10846 format: X.Y[.Z]
10847 SdnInfo:
10848 allOf:
10849 - $ref: '#/components/schemas/SdnExtraProperties'
10850 - $ref: '#/components/schemas/SdnBasicProperties'
10851 ArrayOfSdnInfo:
10852 type: array
10853 items:
10854 $ref: '#/components/schemas/SdnInfo'
10855 CreateSdnRequest:
10856 allOf:
10857 - $ref: '#/components/schemas/SdnBasicProperties'
10858 required:
10859 - name
10860 - type
10861 - ip
10862 - port
10863 - dpid
10864 additionalProperties: false
10865 EditSdnRequest:
10866 allOf:
10867 - $ref: '#/components/schemas/SdnBasicProperties'
10868 additionalProperties: false
10869 NsPmJobReportInfo:
10870 type: object
10871 properties:
10872 entries:
10873 type: array
10874 items:
10875 type: object
10876 properties:
10877 objectInstanceId:
10878 type: string
10879 format: uuid
10880 performanceMetric:
10881 type: string
10882 performanceValue:
10883 type: object
10884 properties:
10885 performanceValue:
10886 type: object
10887 properties:
10888 performanceValue:
10889 type: number
10890 vnfMemberIndex:
10891 type: string
10892 vduName:
10893 type: string
10894 timestamp:
10895 type: number
10896 PduInterfaces:
10897 type: array
10898 items:
10899 type: object
10900 properties:
10901 name:
10902 type: string
10903 mgmt:
10904 type: boolean
10905 type:
10906 type: string
10907 enum:
10908 - overlay
10909 - underlay
10910 ip-address:
10911 type: string
10912 format: ipv4
10913 mac-address:
10914 type: string
10915 format: mac_address
10916 vim-network-name:
10917 type: string
10918 vim-network-id:
10919 type: string
10920 required:
10921 - name
10922 - mgmt
10923 - ip-address
10924 additionalProperties: false
10925 PduInfo:
10926 type: object
10927 properties:
10928 _id:
10929 type: string
10930 format: uuid
10931 name:
10932 type: string
10933 type:
10934 type: string
10935 description:
10936 type: string
10937 shared:
10938 type: boolean
10939 vims:
10940 type: array
10941 items:
10942 type: string
10943 vim_accounts:
10944 type: array
10945 items:
10946 type: string
10947 interfaces:
10948 $ref: '#/components/schemas/PduInterfaces'
10949 ArrayOfPduInfo:
10950 type: array
10951 items:
10952 $ref: '#/components/schemas/PduInfo'
10953 CreatePduRequest:
10954 type: object
10955 properties:
10956 name:
10957 type: string
10958 type:
10959 type: string
10960 description:
10961 type: string
10962 shared:
10963 type: boolean
10964 vims:
10965 type: array
10966 items:
10967 type: string
10968 vim_accounts:
10969 type: array
10970 items:
10971 type: string
10972 interfaces:
10973 $ref: '#/components/schemas/PduInterfaces'
10974 required:
10975 - name
10976 - type
10977 - interfaces
10978 additionalProperties: false
10979 EditPduRequest:
10980 type: object
10981 properties:
10982 name:
10983 type: string
10984 type:
10985 type: string
10986 description:
10987 type: string
10988 shared:
10989 type: boolean
10990 vims:
10991 type: array
10992 items:
10993 type: string
10994 vim_accounts:
10995 type: array
10996 items:
10997 type: string
10998 interfaces:
10999 $ref: '#/components/schemas/PduInterfaces'
11000 additionalProperties: false
11001 K8sClusterNetList:
11002 type: array
11003 items:
11004 type: object
Gabriel Cubab77d0df2022-03-22 14:43:11 -0500[diff] [blame]11005 additionalProperties: false
11006 K8sClusterDeploymentMethods:
11007 type: object
11008 properties:
Gabriel Cubab77d0df2022-03-22 14:43:11 -0500[diff] [blame]11009 juju-bundle:
11010 type: boolean
11011 helm-chart-v3:
11012 type: boolean
11013 additionalProperties: false
11014 minProperties: 3
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11015 K8sClusterInfo:
11016 type: object
11017 properties:
11018 _id:
11019 type: string
11020 format: uuid
11021 schema_version:
11022 type: string
11023 format: X.Y[.Z]
11024 schema_type:
11025 type: string
11026 name:
11027 type: string
11028 description:
11029 type: string
11030 credentials:
11031 type: object
11032 additionalProperties: true
11033 vim_account:
11034 type: string
11035 format: uuid
11036 k8s_version:
11037 type: string
11038 nets:
11039 $ref: '#/components/schemas/K8sClusterNetList'
Gabriel Cubab77d0df2022-03-22 14:43:11 -0500[diff] [blame]11040 deployment_methods:
11041 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11042 namespace:
11043 type: string
11044 cni:
11045 type: array
11046 items:
11047 type: string
11048 ArrayOfK8sClusterInfo:
11049 type: array
11050 items:
11051 $ref: '#/components/schemas/K8sClusterInfo'
11052 CreateK8sClusterRequest:
11053 type: object
11054 properties:
11055 schema_version:
11056 type: string
11057 format: X.Y[.Z]
11058 schema_type:
11059 type: string
11060 name:
11061 type: string
11062 description:
11063 type: string
11064 credentials:
11065 type: object
11066 additionalProperties: true
11067 vim_account:
11068 type: string
11069 format: uuid
11070 k8s_version:
11071 type: string
11072 nets:
11073 $ref: '#/components/schemas/K8sClusterNetList'
11074 namespace:
11075 type: string
11076 cni:
11077 type: array
11078 items:
11079 type: string
11080 required:
11081 - name
11082 - credentials
11083 - vim_account
11084 - k8s_version
11085 - nets
11086 additionalProperties: false
11087 EditK8sClusterRequest:
11088 type: object
11089 properties:
11090 name:
11091 type: string
11092 description:
11093 type: string
11094 credentials:
11095 type: object
11096 additionalProperties: true
11097 vim_account:
11098 type: string
11099 format: uuid
11100 k8s_version:
11101 type: string
11102 nets:
11103 $ref: '#/components/schemas/K8sClusterNetList'
11104 namespace:
11105 type: string
11106 cni:
11107 type: array
11108 items:
11109 type: string
11110 additionalProperties: false
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]11111 VcaInfo:
11112 type: object
11113 properties:
11114 _id:
11115 type: string
11116 format: uuid
11117 schema_version:
11118 type: string
11119 format: X.Y[.Z]
11120 schema_type:
11121 type: string
11122 name:
11123 type: string
11124 description:
11125 type: string
11126 endpoints:
11127 type: string
11128 user:
11129 type: string
11130 secret:
11131 type: string
11132 cacert:
11133 type: string
11134 lxd-cloud:
11135 type: string
11136 lxd-credentials:
11137 type: string
11138 k8s-cloud:
11139 type: string
11140 k8s-credentials:
11141 type: string
11142 model-config:
11143 type: object
11144 additionalProperties: true
11145 ArrayOfVcaInfo:
11146 type: array
11147 items:
11148 $ref: '#/components/schemas/VcaInfo'
11149 CreateVcaRequest:
11150 type: object
11151 properties:
11152 schema_version:
11153 type: string
11154 format: X.Y[.Z]
11155 schema_type:
11156 type: string
11157 name:
11158 type: string
11159 description:
11160 type: string
11161 endpoints:
11162 type: string
11163 user:
11164 type: string
11165 secret:
11166 type: string
11167 cacert:
11168 type: string
11169 lxd-cloud:
11170 type: string
11171 lxd-credentials:
11172 type: string
11173 k8s-cloud:
11174 type: string
11175 k8s-credentials:
11176 type: string
11177 model-config:
11178 type: object
11179 additionalProperties: true
11180 required:
11181 - name
11182 - endpoints
11183 - user
11184 - secret
11185 - cacert
11186 - lxd-cloud
11187 - lxd-credentials
11188 - k8s-cloud
11189 - k8s-credentials
11190 additionalProperties: false
11191 EditVcaRequest:
11192 type: object
11193 properties:
11194 name:
11195 type: string
11196 description:
11197 type: string
11198 endpoints:
11199 type: string
11200 user:
11201 type: string
11202 secret:
11203 type: string
11204 cacert:
11205 type: string
11206 lxd-cloud:
11207 type: string
11208 lxd-credentials:
11209 type: string
11210 k8s-cloud:
11211 type: string
11212 k8s-credentials:
11213 type: string
11214 model-config:
11215 type: object
11216 additionalProperties: true
11217 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11218 K8sRepoType:
11219 type: string
11220 enum:
11221 - chart
11222 - bundle
11223 K8sRepoInfo:
11224 type: object
11225 properties:
11226 _id:
11227 type: string
11228 format: uuid
11229 name:
11230 type: string
11231 description:
11232 type: string
11233 type:
11234 $ref: '#/components/schemas/K8sRepoType'
11235 url:
11236 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11237 format: uri
garciadeblas8bb3cce2022-02-11 00:41:18 +0100[diff] [blame]11238 username:
11239 type: string
11240 description: repository username
11241 password:
11242 type: string
11243 description: repository password
11244 ca-file:
11245 type: string
11246 description: verify certificates of HTTPS-enabled servers using this CA bundle
11247 cert-file:
11248 type: string
11249 description: identify HTTPS client using this SSL certificate file
11250 skip-tls-verify:
11251 type: boolean
11252 description: skip tls certificate checks for the repository
11253 key-file:
11254 type: string
11255 description: identify HTTPS client using this SSL key file
garciadeblas0881dcf2023-10-20 12:00:08 +0200[diff] [blame]11256 oci:
11257 type: boolean
11258 default: false
11259 description: >
11260 Flag to indicate whether or not it is an OCI-enabled repo (default: false)
11261 required:
11262 - name
11263 - type
11264 - url
11265 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11266 ArrayOfK8sRepoInfo:
11267 type: array
11268 items:
11269 $ref: '#/components/schemas/K8sRepoInfo'
11270 CreateK8sRepoRequest:
11271 type: object
11272 properties:
11273 name:
11274 type: string
11275 description:
11276 type: string
11277 type:
11278 $ref: '#/components/schemas/K8sRepoType'
11279 url:
11280 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11281 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11282 required:
11283 - name
11284 - type
11285 - url
11286 additionalProperties: false
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]11287 NslcmSubscriptionResponse:
11288 type: object
11289 properties:
11290 id:
11291 type: string
11292 format: uuid
11293 filter:
11294 type: object
11295 CallbackUri:
11296 type: string
11297 format: uri
11298 _links:
11299 type: object
11300 NslcmSubscriptionInfo:
11301 type: object
11302 properties:
11303 _id:
11304 type: string
11305 format: uuid
11306 _admin:
11307 type: object
11308 schema_version:
11309 type: string
11310 format: 'X.Y[.Z]'
11311 CallbackUri:
11312 type: string
11313 format: uri
11314 filter:
11315 type: object
11316 authentication:
11317 $ref: '#/components/schemas/Authenticationschema'
11318 ArrayOfNslcmSubscriptionInfo:
11319 type: array
11320 items:
11321 $ref: '#/components/schemas/NslcmSubscriptionInfo'
11322 NsInstanceSubscriptionFilter:
11323 description: |
11324 used to identify the network service
11325 type: object
11326 oneOf:
11327 - $ref: '#/components/schemas/nsdIds'
11328 - $ref: '#/components/schemas/vnfdIds'
11329 - $ref: '#/components/schemas/pnfdIds'
11330 - $ref: '#/components/schemas/nsInstanceIds'
11331 - $ref: '#/components/schemas/nsInstanceNames'
11332 nsdIds:
11333 type: array
11334 items:
11335 type: string
11336 vnfdIds:
11337 type: array
11338 items:
11339 type: string
11340 pnfdIds:
11341 type: array
11342 items:
11343 type: string
11344 nsInstanceIds:
11345 type: array
11346 items:
11347 type: string
11348 nsInstanceNames:
11349 type: array
11350 items:
11351 type: string
11352 Nslcmsubschema:
11353 type: object
11354 properties:
11355 nsInstanceSubscriptionFilter:
11356 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
11357 notificationTypes:
11358 description: |
11359 If NsLcmOperationOccurrenceNotification is selected then at least operationTypes or states is required. If NsLcmOperationOccurrenceNotification is selected then at least nsComponentTypes, lcmOpName and lcmOpOccStatus is required
11360 type: array
11361 items:
11362 type: string
11363 enum:
11364 - NsIdentifierCreationNotification
11365 - NsIdentifierDeletionNotification
11366 - NsLcmOperationOccurrenceNotification
11367 - NsChangeNotification
11368 operationTypes:
11369 type: array
11370 items:
11371 type: string
11372 enum:
11373 - INSTANTIATE
11374 - SCALE
11375 - TERMINATE
11376 - UPDATE
11377 - HEAL
11378 operationStates:
11379 type: array
11380 items:
11381 type: string
11382 enum:
11383 - PROCESSING
11384 - COMPLETED
11385 - PARTIALLY_COMPLETED
11386 - FAILED
11387 - FAILED_TEMP
11388 - ROLLING_BACK
11389 - ROLLED_BACK
11390 nsComponentTypes:
11391 type: array
11392 items:
11393 type: string
11394 enum:
11395 - VNF
11396 - NS
11397 - PNF
11398 lcmOpNameImpactingNsComponent:
11399 type: array
11400 items:
11401 type: string
11402 enum:
11403 - VNF_INSTANTIATE
11404 - VNF_SCALE
11405 - VNF_SCALE_TO_LEVEL
11406 - VNF_CHANGE_FLAVOUR
11407 - VNF_TERMINATE
11408 - VNF_HEAL
11409 - VNF_OPERATE
11410 - VNF_CHANGE_EXT_CONN
11411 - VNF_MODIFY_INFO
11412 - NS_INSTANTIATE
11413 - NS_SCALE
11414 - NS_UPDATE
11415 - NS_TERMINATE
11416 - NS_HEAL
11417 lcmOpOccStatusImpactingNsComponent:
11418 type: array
11419 items:
11420 type: string
11421 enum:
11422 - START
11423 - COMPLETED
11424 - PARTIALLY_COMPLETED
11425 - FAILED
11426 - ROLLED_BACK
11427 Authenticationschema:
11428 type: object
11429 properties:
11430 authType:
11431 type: string
11432 enum:
11433 - basic
11434 paramsBasic:
11435 type: object
11436 properties:
11437 userName:
11438 type: string
11439 password:
11440 type: string
11441 NslcmSubscriptionRequest:
11442 type: object
11443 properties:
11444 filter:
11445 $ref: '#/components/schemas/Nslcmsubschema'
11446 CallbackUri:
11447 type: string
11448 format: uri
11449 authentication:
11450 $ref: '#/components/schemas/Authenticationschema'
11451 required:
11452 - CallbackUri
Gabriel Cuba2c8be082023-11-14 16:52:01 -0500[diff] [blame]11453 CancelNSLCMOpOccRequest:
11454 type: object
11455 properties:
11456 cancelMode:
11457 type: string
11458 enum:
11459 - GRACEFUL
11460 - FORCEFUL
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame^]11461 CreateClusterInfo:
11462 type: object
11463 properties:
11464 name:
11465 type: string
11466 vim_account:
11467 type: string
11468 location:
11469 type: string
11470 k8s_version:
11471 type: string
11472 node_size:
11473 type: string
11474 node_count:
11475 type: string
11476 description:
11477 type: string
11478 region_name:
11479 type: string
11480 resource_group:
11481 type: string
11482 infra_controller_profiles:
11483 type: array
11484 items:
11485 type: string
11486 infra_config_profiles:
11487 type: array
11488 items:
11489 type: string
11490 resource_profiles:
11491 type: array
11492 items:
11493 type: string
11494 app_profiles:
11495 type: array
11496 items:
11497 type: string
11498 ScaleNodeInfo:
11499 type: object
11500 properties:
11501 node_count:
11502 type: integer
11503 ProfileInfo:
11504 type: object
11505 properties:
11506 name:
11507 type: string
11508 description:
11509 type: string
11510 UpgradeClusterInfo:
11511 type: object
11512 properties:
11513 k8s_version:
11514 type: string
11515 AttachDetachProfile:
11516 type: object
11517 properties:
11518 add_profile:
11519 type: array
11520 items:
11521 type: object
11522 properties:
11523 _id:
11524 type: string
11525 remove_profile:
11526 type: array
11527 items:
11528 type: object
11529 properties:
11530 _id:
11531 type: string
11532 OkaPackage:
11533 type: object
11534 properties:
11535 name:
11536 type: string
11537 description:
11538 type: string
11539 package:
11540 type: string
11541 format: binary
11542 MultipleKsu:
11543 type: object
11544 properties:
11545 ksus:
11546 type: array
11547 items:
11548 type: object
11549 properties:
11550 name:
11551 type: string
11552 profile:
11553 type: object
11554 properties:
11555 _id:
11556 type: string
11557 profile_type:
11558 type: string
11559 oka:
11560 type: array
11561 items:
11562 type: object
11563 properties:
11564 _id:
11565 type: string
11566 sw_catalog_path:
11567 type: string
11568 transformation:
11569 type: object
11570 description:
11571 type: string
11572 Ksu:
11573 type: object
11574 properties:
11575 name:
11576 type: string
11577 description:
11578 type: string
11579 profile:
11580 type: object
11581 properties:
11582 id:
11583 type: string
11584 profile_type:
11585 type: string
11586 oka:
11587 type: array
11588 items:
11589 type: object
11590 properties:
11591 _id:
11592 type: string
11593 sw_catalog_path:
11594 type: string
11595 transformation:
11596 type: object
11597 DeleteMultipleKsu:
11598 type: object
11599 properties:
11600 ksus:
11601 type: array
11602 items:
11603 type: object
11604 properties:
11605 _id:
11606 type: string
11607 CloneKsu:
11608 type: object
11609 properties:
11610 name:
11611 type: string
11612 profile:
11613 type: object
11614 properties:
11615 _id:
11616 type: string
11617 profile_type:
11618 type: string
11619 MoveKsu:
11620 type: object
11621 properties:
11622 profile:
11623 type: object
11624 properties:
11625 _id:
11626 type: string
11627 profile_type:
11628 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11629 # END SCHEMAS
11630
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]11631 requestBodies:
11632 CreateNsdInfoRequest:
11633 content:
11634 application/json:
11635 schema:
11636 $ref: '#/components/schemas/CreateNsdInfoRequest'
11637 application/yaml:
11638 schema:
11639 $ref: '#/components/schemas/CreateNsdInfoRequest'
11640 NsdInfoModifications:
11641 content:
11642 application/json:
11643 schema:
11644 $ref: '#/components/schemas/NsdInfoModifications'
11645 application/yaml:
11646 schema:
11647 $ref: '#/components/schemas/NsdInfoModifications'
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]11648 AlarmInfoModifications:
11649 content:
11650 application/json:
11651 schema:
11652 $ref: '#/components/schemas/AlarmInfoModifications'
11653 application/yaml:
11654 schema:
11655 $ref: '#/components/schemas/AlarmInfoModifications'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11656 NsDescriptor:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]11657 content:
11658 text/plain:
11659 schema:
11660 $ref: '#/components/schemas/NsDescriptor'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11661 NsPackage:
11662 content:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]11663 application/zip:
11664 schema:
11665 $ref: '#/components/schemas/NsPackage'
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]11666 CreateNsConfigTemplateInfoRequest:
11667 content:
11668 application/json:
11669 schema:
11670 $ref: '#/components/schemas/CreateNsdInfoRequest'
11671 application/yaml:
11672 schema:
11673 $ref: '#/components/schemas/CreateNsdInfoRequest'
11674 NsConfigTemplateInfoModifications:
11675 content:
11676 application/json:
11677 schema:
11678 $ref: '#/components/schemas/NsdInfoModifications'
11679 application/yaml:
11680 schema:
11681 $ref: '#/components/schemas/NsdInfoModifications'
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]11682 CreateVnfPkgInfoRequest:
11683 content:
11684 application/json:
11685 schema:
11686 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
11687 application/yaml:
11688 schema:
11689 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
11690 VnfPkgInfoModifications:
11691 content:
11692 application/json:
11693 schema:
11694 $ref: '#/components/schemas/VnfPkgInfoModifications'
11695 application/yaml:
11696 schema:
11697 $ref: '#/components/schemas/VnfPkgInfoModifications'
11698 VnfPackage:
11699 content:
11700 application/zip:
11701 schema:
11702 $ref: '#/components/schemas/VnfPackage'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11703 VnfDescriptor:
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]11704 content:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11705 text/plain:
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]11706 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11707 $ref: '#/components/schemas/VnfDescriptor'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11708 # CreateNsRequest:
11709 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]11710 InstantiateNsRequest:
11711 content:
11712 application/json:
11713 schema:
11714 $ref: '#/components/schemas/InstantiateNsRequest'
11715 application/yaml:
11716 schema:
11717 $ref: '#/components/schemas/InstantiateNsRequest'
garciadeblasb5a065f2022-02-11 00:27:47 +0100[diff] [blame]11718 HealNsRequest:
11719 content:
11720 application/json:
11721 schema:
11722 $ref: '#/components/schemas/HealNsRequest'
11723 application/yaml:
11724 schema:
11725 $ref: '#/components/schemas/HealNsRequest'
elumalai4b120f12022-04-28 16:44:35 +0530[diff] [blame]11726 NSinstanceMigrateRequest:
11727 content:
11728 application/json:
11729 schema:
11730 $ref: '#/components/schemas/NSinstanceMigrateRequest'
11731 application/yaml:
11732 schema:
11733 $ref: '#/components/schemas/NSinstanceMigrateRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]11734 ScaleNsRequest:
11735 content:
11736 application/json:
11737 schema:
11738 $ref: '#/components/schemas/ScaleNsRequest'
11739 application/yaml:
11740 schema:
11741 $ref: '#/components/schemas/ScaleNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]11742 TerminateNsRequest:
11743 content:
11744 application/json:
11745 schema:
11746 $ref: '#/components/schemas/TerminateNsRequest'
11747 application/yaml:
11748 schema:
11749 $ref: '#/components/schemas/TerminateNsRequest'
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]11750 UpdateNsRequest:
11751 content:
11752 application/json:
11753 schema:
11754 $ref: '#/components/schemas/UpdateNsRequest'
11755 application/yaml:
11756 schema:
11757 $ref: '#/components/schemas/UpdateNsRequest'
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]11758 MultiNsTerminateRequest:
11759 content:
11760 application/json:
11761 schema:
11762 $ref: '#/components/schemas/MultiNsTerminateRequest'
11763 application/yaml:
11764 schema:
11765 $ref: '#/components/schemas/MultiNsTerminateRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11766 # CreateNSinstanceContentRequest:
11767 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11768 CreateNstInfoRequest:
11769 content:
11770 application/json:
11771 schema:
11772 $ref: '#/components/schemas/CreateNstInfoRequest'
11773 application/yaml:
11774 schema:
11775 $ref: '#/components/schemas/CreateNstInfoRequest'
11776 NetSliceTemplate:
11777 content:
11778 text/plain:
11779 schema:
11780 $ref: '#/components/schemas/NetSliceTemplate'
11781 NetSlicePackage:
11782 content:
11783 application/zip:
11784 schema:
11785 $ref: '#/components/schemas/NetSlicePackage'
11786 NstInfoModifications:
11787 content:
11788 application/json:
11789 schema:
11790 $ref: '#/components/schemas/NstInfoModifications'
11791 application/yaml:
11792 schema:
11793 $ref: '#/components/schemas/NstInfoModifications'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11794 # CreateNsiRequest:
11795 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11796 InstantiateNsiRequest:
11797 content:
11798 application/json:
11799 schema:
11800 $ref: '#/components/schemas/InstantiateNsiRequest'
11801 application/yaml:
11802 schema:
11803 $ref: '#/components/schemas/InstantiateNsiRequest'
11804 TerminateNsiRequest:
11805 content:
11806 application/json:
11807 schema:
11808 $ref: '#/components/schemas/TerminateNsiRequest'
11809 application/yaml:
11810 schema:
11811 $ref: '#/components/schemas/TerminateNsiRequest'
11812 NsiActionRequest:
11813 content:
11814 application/json:
11815 schema:
11816 $ref: '#/components/schemas/NsiActionRequest'
11817 application/yaml:
11818 schema:
11819 $ref: '#/components/schemas/NsiActionRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11820 # CreateNsiContentRequest:
11821 # Substituted by InstantiateNsiRequest
11822 CreateTokenRequest:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11823 content:
11824 application/json:
11825 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11826 $ref: '#/components/schemas/CreateTokenRequest'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]11827 application/yaml:
11828 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11829 $ref: '#/components/schemas/CreateTokenRequest'
11830 CreateUserRequest:
11831 content:
11832 application/json:
11833 schema:
11834 $ref: '#/components/schemas/CreateUserRequest'
11835 application/yaml:
11836 schema:
11837 $ref: '#/components/schemas/CreateUserRequest'
11838 EditUserRequest:
11839 content:
11840 application/json:
11841 schema:
11842 $ref: '#/components/schemas/EditUserRequest'
11843 application/yaml:
11844 schema:
11845 $ref: '#/components/schemas/EditUserRequest'
11846 CreateProjectRequest:
11847 content:
11848 application/json:
11849 schema:
11850 $ref: '#/components/schemas/CreateProjectRequest'
11851 application/yaml:
11852 schema:
11853 $ref: '#/components/schemas/CreateProjectRequest'
11854 EditProjectRequest:
11855 content:
11856 application/json:
11857 schema:
11858 $ref: '#/components/schemas/EditProjectRequest'
11859 application/yaml:
11860 schema:
11861 $ref: '#/components/schemas/EditProjectRequest'
11862 CreateRoleRequest:
11863 content:
11864 application/json:
11865 schema:
11866 $ref: '#/components/schemas/CreateRoleRequest'
11867 application/yaml:
11868 schema:
11869 $ref: '#/components/schemas/CreateRoleRequest'
11870 EditRoleRequest:
11871 content:
11872 application/json:
11873 schema:
11874 $ref: '#/components/schemas/EditRoleRequest'
11875 application/yaml:
11876 schema:
11877 $ref: '#/components/schemas/EditRoleRequest'
11878 CreateVimRequest:
11879 content:
11880 application/json:
11881 schema:
11882 $ref: '#/components/schemas/CreateVimRequest'
11883 application/yaml:
11884 schema:
11885 $ref: '#/components/schemas/CreateVimRequest'
11886 EditVimRequest:
11887 content:
11888 application/json:
11889 schema:
11890 $ref: '#/components/schemas/EditVimRequest'
11891 application/yaml:
11892 schema:
11893 $ref: '#/components/schemas/EditVimRequest'
11894 CreateWimRequest:
11895 content:
11896 application/json:
11897 schema:
11898 $ref: '#/components/schemas/CreateWimRequest'
11899 application/yaml:
11900 schema:
11901 $ref: '#/components/schemas/CreateWimRequest'
11902 EditWimRequest:
11903 content:
11904 application/json:
11905 schema:
11906 $ref: '#/components/schemas/EditWimRequest'
11907 application/yaml:
11908 schema:
11909 $ref: '#/components/schemas/EditWimRequest'
11910 CreateSdnRequest:
11911 content:
11912 application/json:
11913 schema:
11914 $ref: '#/components/schemas/CreateSdnRequest'
11915 application/yaml:
11916 schema:
11917 $ref: '#/components/schemas/CreateSdnRequest'
11918 EditSdnRequest:
11919 content:
11920 application/json:
11921 schema:
11922 $ref: '#/components/schemas/EditSdnRequest'
11923 application/yaml:
11924 schema:
11925 $ref: '#/components/schemas/EditSdnRequest'
11926 CreatePduRequest:
11927 content:
11928 application/json:
11929 schema:
11930 $ref: '#/components/schemas/CreatePduRequest'
11931 application/yaml:
11932 schema:
11933 $ref: '#/components/schemas/CreatePduRequest'
11934 EditPduRequest:
11935 content:
11936 application/json:
11937 schema:
11938 $ref: '#/components/schemas/EditPduRequest'
11939 application/yaml:
11940 schema:
11941 $ref: '#/components/schemas/EditPduRequest'
11942 CreateK8sClusterRequest:
11943 content:
11944 application/json:
11945 schema:
11946 $ref: '#/components/schemas/CreateK8sClusterRequest'
11947 application/yaml:
11948 schema:
11949 $ref: '#/components/schemas/CreateK8sClusterRequest'
11950 EditK8sClusterRequest:
11951 content:
11952 application/json:
11953 schema:
11954 $ref: '#/components/schemas/EditK8sClusterRequest'
11955 application/yaml:
11956 schema:
11957 $ref: '#/components/schemas/EditK8sClusterRequest'
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]11958 CreateVcaRequest:
11959 content:
11960 application/json:
11961 schema:
11962 $ref: '#/components/schemas/CreateVcaRequest'
11963 application/yaml:
11964 schema:
11965 $ref: '#/components/schemas/CreateVcaRequest'
11966 EditVcaRequest:
11967 content:
11968 application/json:
11969 schema:
11970 $ref: '#/components/schemas/EditVcaRequest'
11971 application/yaml:
11972 schema:
11973 $ref: '#/components/schemas/EditVcaRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11974 CreateK8sRepoRequest:
11975 content:
11976 application/json:
11977 schema:
11978 $ref: '#/components/schemas/CreateK8sRepoRequest'
11979 application/yaml:
11980 schema:
11981 $ref: '#/components/schemas/CreateK8sRepoRequest'
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]11982 NslcmSubscriptionRequest:
11983 content:
11984 application/json:
11985 schema:
11986 $ref: '#/components/schemas/NslcmSubscriptionRequest'
11987 application/yaml:
11988 schema:
11989 $ref: '#/components/schemas/NslcmSubscriptionRequest'
Gabriel Cuba2c8be082023-11-14 16:52:01 -0500[diff] [blame]11990 CancelNSLCMOpOccRequest:
11991 content:
11992 application/json:
11993 schema:
11994 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
11995 application/yaml:
11996 schema:
11997 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame^]11998 CreateCluster:
11999 content:
12000 application/json:
12001 schema:
12002 $ref: '#/components/schemas/CreateClusterInfo'
12003 application/yaml:
12004 schema:
12005 $ref: '#/components/schemas/CreateClusterInfo'
12006 ScaleNode:
12007 content:
12008 application/json:
12009 schema:
12010 $ref: '#/components/schemas/ScaleNodeInfo'
12011 application/yaml:
12012 schema:
12013 $ref: '#/components/schemas/ScaleNodeInfo'
12014 UpgradeCluster:
12015 content:
12016 application/json:
12017 schema:
12018 $ref: '#/components/schemas/UpgradeClusterInfo'
12019 application/yaml:
12020 schema:
12021 $ref: '#/components/schemas/UpgradeClusterInfo'
12022 ProfileInfo:
12023 content:
12024 application/json:
12025 schema:
12026 $ref: '#/components/schemas/ProfileInfo'
12027 application/yaml:
12028 schema:
12029 $ref: '#/components/schemas/ProfileInfo'
12030 AttachDetachProfile:
12031 content:
12032 application/json:
12033 schema:
12034 $ref: '#/components/schemas/AttachDetachProfile'
12035 application/yaml:
12036 schema:
12037 $ref: '#/components/schemas/AttachDetachProfile'
12038 MultipleKsu:
12039 content:
12040 application/json:
12041 schema:
12042 $ref: '#/components/schemas/MultipleKsu'
12043 application/yaml:
12044 schema:
12045 $ref: '#/components/schemas/MultipleKsu'
12046 Ksu:
12047 content:
12048 application/json:
12049 schema:
12050 $ref: '#/components/schemas/Ksu'
12051 application/yaml:
12052 schema:
12053 $ref: '#/components/schemas/Ksu'
12054 DeleteMultipleKsu:
12055 content:
12056 application/json:
12057 schema:
12058 $ref: '#/components/schemas/DeleteMultipleKsu'
12059 application/yaml:
12060 schema:
12061 $ref: '#/components/schemas/DeleteMultipleKsu'
12062 CloneKsu:
12063 content:
12064 application/json:
12065 schema:
12066 $ref: '#/components/schemas/CloneKsu'
12067 application/yaml:
12068 schema:
12069 $ref: '#/components/schemas/CloneKsu'
12070 MoveKsu:
12071 content:
12072 application/json:
12073 schema:
12074 $ref: '#/components/schemas/MoveKsu'
12075 application/yaml:
12076 schema:
12077 $ref: '#/components/schemas/MoveKsu'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12078 # END REQUEST BODIES
12079
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]12080 securitySchemes:
12081 bearerAuth:
12082 type: http
12083 scheme: bearer