Gitiles
Code Review Sign In
osm.etsi.org / osm / SOL005 / d223b470a1c339266f617a7326c6ca582099cdb8 / . / osm-openapi.yaml
blob: ae4d0003e46f905a7315220e4a524399bdbcee88 [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:
garciadeblasd223b472024-11-06 13:00:10 +0100[diff] [blame^]691 - "NS Config Templates"
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]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:
garciadeblasd223b472024-11-06 13:00:10 +0100[diff] [blame^]731 - "NS Config Templates"
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]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:
garciadeblasd223b472024-11-06 13:00:10 +0100[diff] [blame^]790 - "NS Config Templates"
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]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:
garciadeblasd223b472024-11-06 13:00:10 +0100[diff] [blame^]830 - "NS Config Templates"
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]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:
garciadeblasd223b472024-11-06 13:00:10 +0100[diff] [blame^]871 - "NS Config Templates"
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]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:
garciadeblasd223b472024-11-06 13:00:10 +0100[diff] [blame^]924 - "NS Config Templates"
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]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
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4428 content:
4429 application/json:
4430 schema:
4431 $ref: '#/components/schemas/ArrayOfClusterInfo'
4432 application/yaml:
4433 schema:
4434 $ref: '#/components/schemas/ArrayOfClusterInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4435 '400':
4436 $ref: '#/components/responses/BadRequest'
4437 '401':
4438 $ref: '#/components/responses/Unauthorized'
4439 '403':
4440 $ref: '#/components/responses/Forbidden'
4441 '404':
4442 $ref: '#/components/responses/NotFound'
4443 '405':
4444 $ref: '#/components/responses/MethodNotAllowed'
4445 '406':
4446 $ref: '#/components/responses/NotAcceptable'
4447 '409':
4448 $ref: '#/components/responses/Conflict'
4449 '422':
4450 $ref: '#/components/responses/UnprocessableEntity'
4451 '500':
4452 $ref: '#/components/responses/InternalServerError'
4453 '503':
4454 $ref: '#/components/responses/ServiceUnavailable'
4455 '5XX':
4456 $ref: '#/components/responses/UnexpectedError'
4457 default:
4458 $ref: '#/components/responses/UnexpectedError'
4459 post:
4460 tags:
4461 - "K8s Cluster"
4462 summary: Creating a Cluster
4463 description: This API is used to create cluster
4464 operationId: createk8sCluster
4465 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4466 $ref: '#/components/requestBodies/CreateClusterInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4467 responses:
4468 '201':
4469 description: Created
4470 content:
4471 application/json:
4472 schema:
4473 $ref: '#/components/schemas/ObjectId'
4474 application/yaml:
4475 schema:
4476 $ref: '#/components/schemas/ObjectId'
4477 '400':
4478 $ref: '#/components/responses/BadRequest'
4479 '401':
4480 $ref: '#/components/responses/Unauthorized'
4481 '403':
4482 $ref: '#/components/responses/Forbidden'
4483 '404':
4484 $ref: '#/components/responses/NotFound'
4485 '405':
4486 $ref: '#/components/responses/MethodNotAllowed'
4487 '406':
4488 $ref: '#/components/responses/NotAcceptable'
4489 '409':
4490 $ref: '#/components/responses/Conflict'
4491 '422':
4492 $ref: '#/components/responses/UnprocessableEntity'
4493 '500':
4494 $ref: '#/components/responses/InternalServerError'
4495 '503':
4496 $ref: '#/components/responses/ServiceUnavailable'
4497 '5XX':
4498 $ref: '#/components/responses/UnexpectedError'
4499 default:
4500 $ref: '#/components/responses/UnexpectedError'
4501 '/k8scluster/v1/clusters/{cluster_id}':
4502 parameters:
4503 - name: cluster_id
4504 in: path
4505 required: true
4506 description: cluster_id
4507 schema:
4508 type: string
4509 get:
4510 tags:
4511 - 'K8s Cluster'
4512 summary: Reading a Specific Cluster
4513 description: This API is used to obtain details about a specified cluster.
4514 operationId: readk8sCluster
4515 responses:
4516 '200':
4517 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4518 content:
4519 application/json:
4520 schema:
4521 $ref: '#/components/schemas/ClusterInfo'
4522 application/yaml:
4523 schema:
4524 $ref: '#/components/schemas/ClusterInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4525 '400':
4526 $ref: '#/components/responses/BadRequest'
4527 '401':
4528 $ref: '#/components/responses/Unauthorized'
4529 '403':
4530 $ref: '#/components/responses/Forbidden'
4531 '404':
4532 $ref: '#/components/responses/NotFound'
4533 '405':
4534 $ref: '#/components/responses/MethodNotAllowed'
4535 '406':
4536 $ref: '#/components/responses/NotAcceptable'
4537 '409':
4538 $ref: '#/components/responses/Conflict'
4539 '422':
4540 $ref: '#/components/responses/UnprocessableEntity'
4541 '500':
4542 $ref: '#/components/responses/InternalServerError'
4543 '503':
4544 $ref: '#/components/responses/ServiceUnavailable'
4545 '5XX':
4546 $ref: '#/components/responses/UnexpectedError'
4547 default:
4548 $ref: '#/components/responses/UnexpectedError'
shahithya3d9a1c42024-11-18 07:59:53 +0000[diff] [blame]4549 patch:
4550 tags:
4551 - "K8s Cluster"
4552 summary: Patching Cluster
4553 description: This API is used to edit name and description of the cluster
4554 operationId: patchCluster
4555 requestBody:
4556 $ref: '#/components/requestBodies/ClusterEditRequest'
4557 responses:
4558 '202':
4559 description: Accepted
4560 content:
4561 application/json:
4562 schema:
4563 $ref: '#/components/schemas/OpId'
4564 application/yaml:
4565 schema:
4566 $ref: '#/components/schemas/OpId'
4567 '400':
4568 $ref: '#/components/responses/BadRequest'
4569 '401':
4570 $ref: '#/components/responses/Unauthorized'
4571 '403':
4572 $ref: '#/components/responses/Forbidden'
4573 '404':
4574 $ref: '#/components/responses/NotFound'
4575 '405':
4576 $ref: '#/components/responses/MethodNotAllowed'
4577 '406':
4578 $ref: '#/components/responses/NotAcceptable'
4579 '409':
4580 $ref: '#/components/responses/Conflict'
4581 '422':
4582 $ref: '#/components/responses/UnprocessableEntity'
4583 '500':
4584 $ref: '#/components/responses/InternalServerError'
4585 '503':
4586 $ref: '#/components/responses/ServiceUnavailable'
4587 '5XX':
4588 $ref: '#/components/responses/UnexpectedError'
4589 default:
4590 $ref: '#/components/responses/UnexpectedError'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4591 delete:
4592 tags:
4593 - "K8s Cluster"
4594 summary: Deleting a Cluster
4595 description: This API is used to delete a specified cluster.
4596 operationId: deletek8sCluster
4597 responses:
4598 '202':
4599 description: Accepted
4600 '400':
4601 $ref: '#/components/responses/BadRequest'
4602 '401':
4603 $ref: '#/components/responses/Unauthorized'
4604 '403':
4605 $ref: '#/components/responses/Forbidden'
4606 '404':
4607 $ref: '#/components/responses/NotFound'
4608 '405':
4609 $ref: '#/components/responses/MethodNotAllowed'
4610 '406':
4611 $ref: '#/components/responses/NotAcceptable'
4612 '409':
4613 $ref: '#/components/responses/Conflict'
4614 '422':
4615 $ref: '#/components/responses/UnprocessableEntity'
4616 '500':
4617 $ref: '#/components/responses/InternalServerError'
4618 '503':
4619 $ref: '#/components/responses/ServiceUnavailable'
4620 '5XX':
4621 $ref: '#/components/responses/UnexpectedError'
4622 default:
4623 $ref: '#/components/responses/UnexpectedError'
shahithyacb252bb2024-11-18 07:44:02 +0000[diff] [blame]4624 '/k8scluster/v1/clusters/register':
4625 post:
4626 tags:
4627 - "K8s Cluster"
4628 summary: Registering a Cluster
4629 description: This API is used to register a cluster
4630 operationId: registerk8sCluster
4631 requestBody:
4632 $ref: '#/components/requestBodies/RegisterClusterInfo'
4633 responses:
4634 '201':
4635 description: Created
4636 content:
4637 application/json:
4638 schema:
4639 $ref: '#/components/schemas/ObjectId'
4640 application/yaml:
4641 schema:
4642 $ref: '#/components/schemas/ObjectId'
4643 '400':
4644 $ref: '#/components/responses/BadRequest'
4645 '401':
4646 $ref: '#/components/responses/Unauthorized'
4647 '403':
4648 $ref: '#/components/responses/Forbidden'
4649 '404':
4650 $ref: '#/components/responses/NotFound'
4651 '405':
4652 $ref: '#/components/responses/MethodNotAllowed'
4653 '406':
4654 $ref: '#/components/responses/NotAcceptable'
4655 '409':
4656 $ref: '#/components/responses/Conflict'
4657 '422':
4658 $ref: '#/components/responses/UnprocessableEntity'
4659 '500':
4660 $ref: '#/components/responses/InternalServerError'
4661 '503':
4662 $ref: '#/components/responses/ServiceUnavailable'
4663 '5XX':
4664 $ref: '#/components/responses/UnexpectedError'
4665 default:
4666 $ref: '#/components/responses/UnexpectedError'
4667 '/k8scluster/v1/clusters/{cluster_id}/deregister':
4668 parameters:
4669 - name: cluster_id
4670 in: path
4671 required: true
4672 description: cluster_id
4673 schema:
4674 type: string
4675 delete:
4676 tags:
4677 - "K8s Cluster"
4678 summary: Deregister a Cluster
4679 description: This API is used to deregister a specified cluster.
4680 operationId: deregisterk8sCluster
4681 responses:
4682 '202':
4683 description: Accepted
4684 '400':
4685 $ref: '#/components/responses/BadRequest'
4686 '401':
4687 $ref: '#/components/responses/Unauthorized'
4688 '403':
4689 $ref: '#/components/responses/Forbidden'
4690 '404':
4691 $ref: '#/components/responses/NotFound'
4692 '405':
4693 $ref: '#/components/responses/MethodNotAllowed'
4694 '406':
4695 $ref: '#/components/responses/NotAcceptable'
4696 '409':
4697 $ref: '#/components/responses/Conflict'
4698 '422':
4699 $ref: '#/components/responses/UnprocessableEntity'
4700 '500':
4701 $ref: '#/components/responses/InternalServerError'
4702 '503':
4703 $ref: '#/components/responses/ServiceUnavailable'
4704 '5XX':
4705 $ref: '#/components/responses/UnexpectedError'
4706 default:
4707 $ref: '#/components/responses/UnexpectedError'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4708 '/k8scluster/v1/clusters/{cluster_id}/get_creds':
4709 parameters:
4710 - name: cluster_id
4711 in: path
4712 required: true
4713 description: cluster_id
4714 schema:
4715 type: string
4716 get:
4717 tags:
4718 - "K8s Cluster"
4719 summary: Get Credentials of the cluster
4720 description: This API is used to obtain a kube_config file of a specified cluster.
4721 operationId: getCreds
4722 responses:
4723 '200':
4724 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4725 content:
4726 application/json:
4727 schema:
4728 $ref: '#/components/schemas/OpId'
4729 application/yaml:
4730 schema:
4731 $ref: '#/components/schemas/OpId'
4732 '400':
4733 $ref: '#/components/responses/BadRequest'
4734 '401':
4735 $ref: '#/components/responses/Unauthorized'
4736 '403':
4737 $ref: '#/components/responses/Forbidden'
4738 '404':
4739 $ref: '#/components/responses/NotFound'
4740 '405':
4741 $ref: '#/components/responses/MethodNotAllowed'
4742 '406':
4743 $ref: '#/components/responses/NotAcceptable'
4744 '409':
4745 $ref: '#/components/responses/Conflict'
4746 '422':
4747 $ref: '#/components/responses/UnprocessableEntity'
4748 '500':
4749 $ref: '#/components/responses/InternalServerError'
4750 '503':
4751 $ref: '#/components/responses/ServiceUnavailable'
4752 '5XX':
4753 $ref: '#/components/responses/UnexpectedError'
4754 default:
4755 $ref: '#/components/responses/UnexpectedError'
4756 '/k8scluster/v1/clusters/{cluster_id}/get_creds_file/{operation_id}':
4757 parameters:
4758 - name: cluster_id
4759 in: path
4760 required: true
4761 description: cluster_id
4762 schema:
4763 type: string
4764 - name: operation_id
4765 in: path
4766 required: true
4767 description: operation_id
4768 schema:
4769 type: string
4770 get:
4771 tags:
4772 - "K8s Cluster"
4773 summary: Get Credentials of the cluster in file format
4774 description: This API is used to obtain a kube_config file of a specified cluster.
4775 operationId: getCredsfile
4776 responses:
4777 '200':
4778 description: OK
4779 content:
4780 application/json:
4781 schema:
4782 $ref: '#/components/schemas/ClusterCreds'
4783 application/yaml:
4784 schema:
4785 $ref: '#/components/schemas/ClusterCreds'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4786 '400':
4787 $ref: '#/components/responses/BadRequest'
4788 '401':
4789 $ref: '#/components/responses/Unauthorized'
4790 '403':
4791 $ref: '#/components/responses/Forbidden'
4792 '404':
4793 $ref: '#/components/responses/NotFound'
4794 '405':
4795 $ref: '#/components/responses/MethodNotAllowed'
4796 '406':
4797 $ref: '#/components/responses/NotAcceptable'
4798 '409':
4799 $ref: '#/components/responses/Conflict'
4800 '422':
4801 $ref: '#/components/responses/UnprocessableEntity'
4802 '500':
4803 $ref: '#/components/responses/InternalServerError'
4804 '503':
4805 $ref: '#/components/responses/ServiceUnavailable'
4806 '5XX':
4807 $ref: '#/components/responses/UnexpectedError'
4808 default:
4809 $ref: '#/components/responses/UnexpectedError'
4810 '/k8scluster/v1/clusters/{cluster_id}/scale':
4811 parameters:
4812 - name: cluster_id
4813 in: path
4814 required: true
4815 description: cluster_id
4816 schema:
4817 type: string
4818 post:
4819 tags:
4820 - "K8s Cluster"
4821 summary: Scaling Node
4822 description: This API is used to scale the node into a specified cluster
4823 operationId: nodeScaling
4824 requestBody:
4825 $ref: '#/components/requestBodies/ScaleNode'
4826 responses:
4827 '202':
4828 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4829 content:
4830 application/json:
4831 schema:
4832 $ref: '#/components/schemas/OpId'
4833 application/yaml:
4834 schema:
4835 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4836 '400':
4837 $ref: '#/components/responses/BadRequest'
4838 '401':
4839 $ref: '#/components/responses/Unauthorized'
4840 '403':
4841 $ref: '#/components/responses/Forbidden'
4842 '404':
4843 $ref: '#/components/responses/NotFound'
4844 '405':
4845 $ref: '#/components/responses/MethodNotAllowed'
4846 '406':
4847 $ref: '#/components/responses/NotAcceptable'
4848 '409':
4849 $ref: '#/components/responses/Conflict'
4850 '422':
4851 $ref: '#/components/responses/UnprocessableEntity'
4852 '500':
4853 $ref: '#/components/responses/InternalServerError'
4854 '503':
4855 $ref: '#/components/responses/ServiceUnavailable'
4856 '5XX':
4857 $ref: '#/components/responses/UnexpectedError'
4858 default:
4859 $ref: '#/components/responses/UnexpectedError'
4860 '/k8scluster/v1/clusters/{cluster_id}/upgrade':
4861 parameters:
4862 - name: cluster_id
4863 in: path
4864 required: true
4865 description: cluster_id
4866 schema:
4867 type: string
4868 post:
4869 tags:
4870 - "K8s Cluster"
4871 summary: Upgrading a Cluster
4872 description: This API is used to Upgrade a Cluster
4873 operationId: upgradeCluster
4874 requestBody:
4875 $ref: '#/components/requestBodies/UpgradeCluster'
4876 responses:
4877 '202':
4878 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4879 content:
4880 application/json:
4881 schema:
4882 $ref: '#/components/schemas/OpId'
4883 application/yaml:
4884 schema:
4885 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4886 '400':
4887 $ref: '#/components/responses/BadRequest'
4888 '401':
4889 $ref: '#/components/responses/Unauthorized'
4890 '403':
4891 $ref: '#/components/responses/Forbidden'
4892 '404':
4893 $ref: '#/components/responses/NotFound'
4894 '405':
4895 $ref: '#/components/responses/MethodNotAllowed'
4896 '406':
4897 $ref: '#/components/responses/NotAcceptable'
4898 '409':
4899 $ref: '#/components/responses/Conflict'
4900 '422':
4901 $ref: '#/components/responses/UnprocessableEntity'
4902 '500':
4903 $ref: '#/components/responses/InternalServerError'
4904 '503':
4905 $ref: '#/components/responses/ServiceUnavailable'
4906 '5XX':
4907 $ref: '#/components/responses/UnexpectedError'
4908 default:
4909 $ref: '#/components/responses/UnexpectedError'
shahithya3d9a1c42024-11-18 07:59:53 +0000[diff] [blame]4910 '/k8scluster/v1/clusters/{cluster_id}/update':
4911 parameters:
4912 - name: cluster_id
4913 in: path
4914 required: true
4915 description: cluster_id
4916 schema:
4917 type: string
4918 post:
4919 tags:
4920 - "K8s Cluster"
4921 summary: Update a Cluster
4922 description: This API is used to Update k8s_version, node_count and node_size of a Cluster
4923 operationId: updateCluster
4924 requestBody:
4925 $ref: '#/components/requestBodies/UpdateClusterRequest'
4926 responses:
4927 '202':
4928 description: Accepted
4929 content:
4930 application/json:
4931 schema:
4932 $ref: '#/components/schemas/OpId'
4933 application/yaml:
4934 schema:
4935 $ref: '#/components/schemas/OpId'
4936 '400':
4937 $ref: '#/components/responses/BadRequest'
4938 '401':
4939 $ref: '#/components/responses/Unauthorized'
4940 '403':
4941 $ref: '#/components/responses/Forbidden'
4942 '404':
4943 $ref: '#/components/responses/NotFound'
4944 '405':
4945 $ref: '#/components/responses/MethodNotAllowed'
4946 '406':
4947 $ref: '#/components/responses/NotAcceptable'
4948 '409':
4949 $ref: '#/components/responses/Conflict'
4950 '422':
4951 $ref: '#/components/responses/UnprocessableEntity'
4952 '500':
4953 $ref: '#/components/responses/InternalServerError'
4954 '503':
4955 $ref: '#/components/responses/ServiceUnavailable'
4956 '5XX':
4957 $ref: '#/components/responses/UnexpectedError'
4958 default:
4959 $ref: '#/components/responses/UnexpectedError'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4960 '/k8scluster/v1/app_profiles':
4961 post:
4962 tags:
4963 - "K8s Cluster"
4964 summary: Creating App-profiles
4965 description: This API is used to create App-profiles
4966 operationId: createAppProfile
4967 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]4968 $ref: '#/components/requestBodies/CreateProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]4969 responses:
4970 '201':
4971 description: Created
4972 content:
4973 application/json:
4974 schema:
4975 $ref: '#/components/schemas/ObjectId'
4976 application/yaml:
4977 schema:
4978 $ref: '#/components/schemas/ObjectId'
4979 '400':
4980 $ref: '#/components/responses/BadRequest'
4981 '401':
4982 $ref: '#/components/responses/Unauthorized'
4983 '403':
4984 $ref: '#/components/responses/Forbidden'
4985 '404':
4986 $ref: '#/components/responses/NotFound'
4987 '405':
4988 $ref: '#/components/responses/MethodNotAllowed'
4989 '406':
4990 $ref: '#/components/responses/NotAcceptable'
4991 '409':
4992 $ref: '#/components/responses/Conflict'
4993 '422':
4994 $ref: '#/components/responses/UnprocessableEntity'
4995 '500':
4996 $ref: '#/components/responses/InternalServerError'
4997 '503':
4998 $ref: '#/components/responses/ServiceUnavailable'
4999 '5XX':
5000 $ref: '#/components/responses/UnexpectedError'
5001 default:
5002 $ref: '#/components/responses/UnexpectedError'
5003 get:
5004 tags:
5005 - "K8s Cluster"
5006 summary: Listing App-profiles
5007 description: This API is used to list all App-profiles
5008 operationId: listAppProfile
5009 responses:
5010 '200':
5011 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5012 content:
5013 application/json:
5014 schema:
5015 $ref: '#/components/schemas/ArrayOfProfileInfo'
5016 application/yaml:
5017 schema:
5018 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5019 '400':
5020 $ref: '#/components/responses/BadRequest'
5021 '401':
5022 $ref: '#/components/responses/Unauthorized'
5023 '403':
5024 $ref: '#/components/responses/Forbidden'
5025 '404':
5026 $ref: '#/components/responses/NotFound'
5027 '405':
5028 $ref: '#/components/responses/MethodNotAllowed'
5029 '406':
5030 $ref: '#/components/responses/NotAcceptable'
5031 '409':
5032 $ref: '#/components/responses/Conflict'
5033 '422':
5034 $ref: '#/components/responses/UnprocessableEntity'
5035 '500':
5036 $ref: '#/components/responses/InternalServerError'
5037 '503':
5038 $ref: '#/components/responses/ServiceUnavailable'
5039 '5XX':
5040 $ref: '#/components/responses/UnexpectedError'
5041 default:
5042 $ref: '#/components/responses/UnexpectedError'
5043 '/k8scluster/v1/app_profiles/{app_profile_id}':
5044 parameters:
5045 - name: app_profile_id
5046 in: path
5047 required: true
5048 description: app_profile_id
5049 schema:
5050 type: string
5051 get:
5052 tags:
5053 - "K8s Cluster"
5054 summary: Reading App-profiles
5055 description: This API is used to reading specific App-profile
5056 operationId: readAppProfile
5057 responses:
5058 '200':
5059 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5060 content:
5061 application/json:
5062 schema:
5063 $ref: '#/components/schemas/ProfileInfo'
5064 application/yaml:
5065 schema:
5066 $ref: '#/components/schemas/ProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5067 '400':
5068 $ref: '#/components/responses/BadRequest'
5069 '401':
5070 $ref: '#/components/responses/Unauthorized'
5071 '403':
5072 $ref: '#/components/responses/Forbidden'
5073 '404':
5074 $ref: '#/components/responses/NotFound'
5075 '405':
5076 $ref: '#/components/responses/MethodNotAllowed'
5077 '406':
5078 $ref: '#/components/responses/NotAcceptable'
5079 '409':
5080 $ref: '#/components/responses/Conflict'
5081 '422':
5082 $ref: '#/components/responses/UnprocessableEntity'
5083 '500':
5084 $ref: '#/components/responses/InternalServerError'
5085 '503':
5086 $ref: '#/components/responses/ServiceUnavailable'
5087 '5XX':
5088 $ref: '#/components/responses/UnexpectedError'
5089 default:
5090 $ref: '#/components/responses/UnexpectedError'
5091 patch:
5092 tags:
5093 - "K8s Cluster"
5094 summary: Patching App-profiles
5095 description: This API is used to patch specific App-profile
5096 operationId: patchAppProfile
5097 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5098 $ref: '#/components/requestBodies/PatchProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5099 responses:
5100 '202':
5101 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5102 content:
5103 application/json:
5104 schema:
5105 $ref: '#/components/schemas/OpId'
5106 application/yaml:
5107 schema:
5108 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5109 '400':
5110 $ref: '#/components/responses/BadRequest'
5111 '401':
5112 $ref: '#/components/responses/Unauthorized'
5113 '403':
5114 $ref: '#/components/responses/Forbidden'
5115 '404':
5116 $ref: '#/components/responses/NotFound'
5117 '405':
5118 $ref: '#/components/responses/MethodNotAllowed'
5119 '406':
5120 $ref: '#/components/responses/NotAcceptable'
5121 '409':
5122 $ref: '#/components/responses/Conflict'
5123 '422':
5124 $ref: '#/components/responses/UnprocessableEntity'
5125 '500':
5126 $ref: '#/components/responses/InternalServerError'
5127 '503':
5128 $ref: '#/components/responses/ServiceUnavailable'
5129 '5XX':
5130 $ref: '#/components/responses/UnexpectedError'
5131 default:
5132 $ref: '#/components/responses/UnexpectedError'
5133 delete:
5134 tags:
5135 - "K8s Cluster"
5136 summary: Deleteing App-profiles
5137 description: This API is used to delete specific App-profile
5138 operationId: deleteAppProfile
5139 responses:
5140 '202':
5141 description: Accepted
5142 '400':
5143 $ref: '#/components/responses/BadRequest'
5144 '401':
5145 $ref: '#/components/responses/Unauthorized'
5146 '403':
5147 $ref: '#/components/responses/Forbidden'
5148 '404':
5149 $ref: '#/components/responses/NotFound'
5150 '405':
5151 $ref: '#/components/responses/MethodNotAllowed'
5152 '406':
5153 $ref: '#/components/responses/NotAcceptable'
5154 '409':
5155 $ref: '#/components/responses/Conflict'
5156 '422':
5157 $ref: '#/components/responses/UnprocessableEntity'
5158 '500':
5159 $ref: '#/components/responses/InternalServerError'
5160 '503':
5161 $ref: '#/components/responses/ServiceUnavailable'
5162 '5XX':
5163 $ref: '#/components/responses/UnexpectedError'
5164 default:
5165 $ref: '#/components/responses/UnexpectedError'
5166 '/k8scluster/v1/clusters/{cluster_id}/app_profiles':
5167 parameters:
5168 - name: cluster_id
5169 in: path
5170 required: true
5171 description: cluster_id
5172 schema:
5173 type: string
5174 patch:
5175 tags:
5176 - "K8s Cluster"
5177 summary: Adding or Removing App profile to cluster
5178 description: This API is used to add or remove app profiles to cluster
5179 operationId: addRemoveAppProfile
5180 requestBody:
5181 $ref: '#/components/requestBodies/AttachDetachProfile'
5182 responses:
5183 '202':
5184 description: Accepted
5185 '400':
5186 $ref: '#/components/responses/BadRequest'
5187 '401':
5188 $ref: '#/components/responses/Unauthorized'
5189 '403':
5190 $ref: '#/components/responses/Forbidden'
5191 '404':
5192 $ref: '#/components/responses/NotFound'
5193 '405':
5194 $ref: '#/components/responses/MethodNotAllowed'
5195 '406':
5196 $ref: '#/components/responses/NotAcceptable'
5197 '409':
5198 $ref: '#/components/responses/Conflict'
5199 '422':
5200 $ref: '#/components/responses/UnprocessableEntity'
5201 '500':
5202 $ref: '#/components/responses/InternalServerError'
5203 '503':
5204 $ref: '#/components/responses/ServiceUnavailable'
5205 '5XX':
5206 $ref: '#/components/responses/UnexpectedError'
5207 default:
5208 $ref: '#/components/responses/UnexpectedError'
5209 get:
5210 tags:
5211 - "K8s Cluster"
5212 summary: Getting App-profile in cluster
5213 description: This API is used to get app-profiles in specified cluster
5214 operationId: getAppProfile
5215 responses:
5216 '200':
5217 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5218 content:
5219 application/json:
5220 schema:
5221 $ref: '#/components/schemas/ArrayOfProfileInfo'
5222 application/yaml:
5223 schema:
5224 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5225 '400':
5226 $ref: '#/components/responses/BadRequest'
5227 '401':
5228 $ref: '#/components/responses/Unauthorized'
5229 '403':
5230 $ref: '#/components/responses/Forbidden'
5231 '404':
5232 $ref: '#/components/responses/NotFound'
5233 '405':
5234 $ref: '#/components/responses/MethodNotAllowed'
5235 '406':
5236 $ref: '#/components/responses/NotAcceptable'
5237 '409':
5238 $ref: '#/components/responses/Conflict'
5239 '422':
5240 $ref: '#/components/responses/UnprocessableEntity'
5241 '500':
5242 $ref: '#/components/responses/InternalServerError'
5243 '503':
5244 $ref: '#/components/responses/ServiceUnavailable'
5245 '5XX':
5246 $ref: '#/components/responses/UnexpectedError'
5247 default:
5248 $ref: '#/components/responses/UnexpectedError'
5249 '/k8scluster/v1/infra_controller_profiles':
5250 post:
5251 tags:
5252 - "K8s Cluster"
5253 summary: Creating Infra controller profiles
5254 description: This API is used to create Infra controllerprofiles
5255 operationId: createInfraControllerProfile
5256 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5257 $ref: '#/components/requestBodies/CreateProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5258 responses:
5259 '201':
5260 description: Created
5261 content:
5262 application/json:
5263 schema:
5264 $ref: '#/components/schemas/ObjectId'
5265 application/yaml:
5266 schema:
5267 $ref: '#/components/schemas/ObjectId'
5268 '400':
5269 $ref: '#/components/responses/BadRequest'
5270 '401':
5271 $ref: '#/components/responses/Unauthorized'
5272 '403':
5273 $ref: '#/components/responses/Forbidden'
5274 '404':
5275 $ref: '#/components/responses/NotFound'
5276 '405':
5277 $ref: '#/components/responses/MethodNotAllowed'
5278 '406':
5279 $ref: '#/components/responses/NotAcceptable'
5280 '409':
5281 $ref: '#/components/responses/Conflict'
5282 '422':
5283 $ref: '#/components/responses/UnprocessableEntity'
5284 '500':
5285 $ref: '#/components/responses/InternalServerError'
5286 '503':
5287 $ref: '#/components/responses/ServiceUnavailable'
5288 '5XX':
5289 $ref: '#/components/responses/UnexpectedError'
5290 default:
5291 $ref: '#/components/responses/UnexpectedError'
5292 get:
5293 tags:
5294 - "K8s Cluster"
5295 summary: Listing Infra controller profiles
5296 description: This API is used to list all Infra controller profiles
5297 operationId: listInfraControllerProfile
5298 responses:
5299 '200':
5300 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5301 content:
5302 application/json:
5303 schema:
5304 $ref: '#/components/schemas/ArrayOfProfileInfo'
5305 application/yaml:
5306 schema:
5307 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5308 '400':
5309 $ref: '#/components/responses/BadRequest'
5310 '401':
5311 $ref: '#/components/responses/Unauthorized'
5312 '403':
5313 $ref: '#/components/responses/Forbidden'
5314 '404':
5315 $ref: '#/components/responses/NotFound'
5316 '405':
5317 $ref: '#/components/responses/MethodNotAllowed'
5318 '406':
5319 $ref: '#/components/responses/NotAcceptable'
5320 '409':
5321 $ref: '#/components/responses/Conflict'
5322 '422':
5323 $ref: '#/components/responses/UnprocessableEntity'
5324 '500':
5325 $ref: '#/components/responses/InternalServerError'
5326 '503':
5327 $ref: '#/components/responses/ServiceUnavailable'
5328 '5XX':
5329 $ref: '#/components/responses/UnexpectedError'
5330 default:
5331 $ref: '#/components/responses/UnexpectedError'
5332 '/k8scluster/v1/infra_controller_profiles/{infra_controller_profile_id}':
5333 parameters:
5334 - name: infra_controller_profile_id
5335 in: path
5336 required: true
5337 description: infra_controller_profile_id
5338 schema:
5339 type: string
5340 get:
5341 tags:
5342 - "K8s Cluster"
5343 summary: Reading Infra controller profiles
5344 description: This API is used to reading specific Infra controller profile
5345 operationId: readInfraControllerProfile
5346 responses:
5347 '200':
5348 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5349 content:
5350 application/json:
5351 schema:
5352 $ref: '#/components/schemas/ProfileInfo'
5353 application/yaml:
5354 schema:
5355 $ref: '#/components/schemas/ProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5356 '400':
5357 $ref: '#/components/responses/BadRequest'
5358 '401':
5359 $ref: '#/components/responses/Unauthorized'
5360 '403':
5361 $ref: '#/components/responses/Forbidden'
5362 '404':
5363 $ref: '#/components/responses/NotFound'
5364 '405':
5365 $ref: '#/components/responses/MethodNotAllowed'
5366 '406':
5367 $ref: '#/components/responses/NotAcceptable'
5368 '409':
5369 $ref: '#/components/responses/Conflict'
5370 '422':
5371 $ref: '#/components/responses/UnprocessableEntity'
5372 '500':
5373 $ref: '#/components/responses/InternalServerError'
5374 '503':
5375 $ref: '#/components/responses/ServiceUnavailable'
5376 '5XX':
5377 $ref: '#/components/responses/UnexpectedError'
5378 default:
5379 $ref: '#/components/responses/UnexpectedError'
5380 patch:
5381 tags:
5382 - "K8s Cluster"
5383 summary: Patching Infra controller profiles
5384 description: This API is used to patch specific Infra controller profile
5385 operationId: patchInfraControllerProfile
5386 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5387 $ref: '#/components/requestBodies/PatchProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5388 responses:
5389 '202':
5390 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5391 content:
5392 application/json:
5393 schema:
5394 $ref: '#/components/schemas/OpId'
5395 application/yaml:
5396 schema:
5397 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5398 '400':
5399 $ref: '#/components/responses/BadRequest'
5400 '401':
5401 $ref: '#/components/responses/Unauthorized'
5402 '403':
5403 $ref: '#/components/responses/Forbidden'
5404 '404':
5405 $ref: '#/components/responses/NotFound'
5406 '405':
5407 $ref: '#/components/responses/MethodNotAllowed'
5408 '406':
5409 $ref: '#/components/responses/NotAcceptable'
5410 '409':
5411 $ref: '#/components/responses/Conflict'
5412 '422':
5413 $ref: '#/components/responses/UnprocessableEntity'
5414 '500':
5415 $ref: '#/components/responses/InternalServerError'
5416 '503':
5417 $ref: '#/components/responses/ServiceUnavailable'
5418 '5XX':
5419 $ref: '#/components/responses/UnexpectedError'
5420 default:
5421 $ref: '#/components/responses/UnexpectedError'
5422 delete:
5423 tags:
5424 - "K8s Cluster"
5425 summary: Deleteing Infra controller profiles
5426 description: This API is used to delete specific Infra controller profile
5427 operationId: deleteInfraControllerProfile
5428 responses:
5429 '202':
5430 description: Accepted
5431 '400':
5432 $ref: '#/components/responses/BadRequest'
5433 '401':
5434 $ref: '#/components/responses/Unauthorized'
5435 '403':
5436 $ref: '#/components/responses/Forbidden'
5437 '404':
5438 $ref: '#/components/responses/NotFound'
5439 '405':
5440 $ref: '#/components/responses/MethodNotAllowed'
5441 '406':
5442 $ref: '#/components/responses/NotAcceptable'
5443 '409':
5444 $ref: '#/components/responses/Conflict'
5445 '422':
5446 $ref: '#/components/responses/UnprocessableEntity'
5447 '500':
5448 $ref: '#/components/responses/InternalServerError'
5449 '503':
5450 $ref: '#/components/responses/ServiceUnavailable'
5451 '5XX':
5452 $ref: '#/components/responses/UnexpectedError'
5453 default:
5454 $ref: '#/components/responses/UnexpectedError'
5455 '/k8scluster/v1/clusters/{cluster_id}/infra_controller_profiles':
5456 parameters:
5457 - name: cluster_id
5458 in: path
5459 required: true
5460 description: cluster_id
5461 schema:
5462 type: string
5463 patch:
5464 tags:
5465 - "K8s Cluster"
5466 summary: Adding or Removing Infra controller profile to cluster
5467 description: This API is used to add or remove infra controller profile to cluster
5468 operationId: addremoveInfraControllerProfile
5469 requestBody:
5470 $ref: '#/components/requestBodies/AttachDetachProfile'
5471 responses:
5472 '202':
5473 description: Accepted
5474 '400':
5475 $ref: '#/components/responses/BadRequest'
5476 '401':
5477 $ref: '#/components/responses/Unauthorized'
5478 '403':
5479 $ref: '#/components/responses/Forbidden'
5480 '404':
5481 $ref: '#/components/responses/NotFound'
5482 '405':
5483 $ref: '#/components/responses/MethodNotAllowed'
5484 '406':
5485 $ref: '#/components/responses/NotAcceptable'
5486 '409':
5487 $ref: '#/components/responses/Conflict'
5488 '422':
5489 $ref: '#/components/responses/UnprocessableEntity'
5490 '500':
5491 $ref: '#/components/responses/InternalServerError'
5492 '503':
5493 $ref: '#/components/responses/ServiceUnavailable'
5494 '5XX':
5495 $ref: '#/components/responses/UnexpectedError'
5496 default:
5497 $ref: '#/components/responses/UnexpectedError'
5498 get:
5499 tags:
5500 - "K8s Cluster"
5501 summary: Getting Infra controller profile in cluster
5502 description: This API is used to get infra controller profiles in specified cluster
5503 operationId: getInfraControllerProfile
5504 responses:
5505 '200':
5506 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5507 content:
5508 application/json:
5509 schema:
5510 $ref: '#/components/schemas/ArrayOfProfileInfo'
5511 application/yaml:
5512 schema:
5513 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5514 '400':
5515 $ref: '#/components/responses/BadRequest'
5516 '401':
5517 $ref: '#/components/responses/Unauthorized'
5518 '403':
5519 $ref: '#/components/responses/Forbidden'
5520 '404':
5521 $ref: '#/components/responses/NotFound'
5522 '405':
5523 $ref: '#/components/responses/MethodNotAllowed'
5524 '406':
5525 $ref: '#/components/responses/NotAcceptable'
5526 '409':
5527 $ref: '#/components/responses/Conflict'
5528 '422':
5529 $ref: '#/components/responses/UnprocessableEntity'
5530 '500':
5531 $ref: '#/components/responses/InternalServerError'
5532 '503':
5533 $ref: '#/components/responses/ServiceUnavailable'
5534 '5XX':
5535 $ref: '#/components/responses/UnexpectedError'
5536 default:
5537 $ref: '#/components/responses/UnexpectedError'
5538 '/k8scluster/v1/infra_config_profiles':
5539 post:
5540 tags:
5541 - "K8s Cluster"
5542 summary: Creating Infra config profiles
5543 description: This API is used to create Infra config profiles
5544 operationId: createInfraConfigProfile
5545 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5546 $ref: '#/components/requestBodies/CreateProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5547 responses:
5548 '201':
5549 description: Created
5550 content:
5551 application/json:
5552 schema:
5553 $ref: '#/components/schemas/ObjectId'
5554 application/yaml:
5555 schema:
5556 $ref: '#/components/schemas/ObjectId'
5557 '400':
5558 $ref: '#/components/responses/BadRequest'
5559 '401':
5560 $ref: '#/components/responses/Unauthorized'
5561 '403':
5562 $ref: '#/components/responses/Forbidden'
5563 '404':
5564 $ref: '#/components/responses/NotFound'
5565 '405':
5566 $ref: '#/components/responses/MethodNotAllowed'
5567 '406':
5568 $ref: '#/components/responses/NotAcceptable'
5569 '409':
5570 $ref: '#/components/responses/Conflict'
5571 '422':
5572 $ref: '#/components/responses/UnprocessableEntity'
5573 '500':
5574 $ref: '#/components/responses/InternalServerError'
5575 '503':
5576 $ref: '#/components/responses/ServiceUnavailable'
5577 '5XX':
5578 $ref: '#/components/responses/UnexpectedError'
5579 default:
5580 $ref: '#/components/responses/UnexpectedError'
5581 get:
5582 tags:
5583 - "K8s Cluster"
5584 summary: Listing Infra config profiles
5585 description: This API is used to list all Infra config profiles
5586 operationId: listInfraConfigProfile
5587 responses:
5588 '200':
5589 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5590 content:
5591 application/json:
5592 schema:
5593 $ref: '#/components/schemas/ArrayOfProfileInfo'
5594 application/yaml:
5595 schema:
5596 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5597 '400':
5598 $ref: '#/components/responses/BadRequest'
5599 '401':
5600 $ref: '#/components/responses/Unauthorized'
5601 '403':
5602 $ref: '#/components/responses/Forbidden'
5603 '404':
5604 $ref: '#/components/responses/NotFound'
5605 '405':
5606 $ref: '#/components/responses/MethodNotAllowed'
5607 '406':
5608 $ref: '#/components/responses/NotAcceptable'
5609 '409':
5610 $ref: '#/components/responses/Conflict'
5611 '422':
5612 $ref: '#/components/responses/UnprocessableEntity'
5613 '500':
5614 $ref: '#/components/responses/InternalServerError'
5615 '503':
5616 $ref: '#/components/responses/ServiceUnavailable'
5617 '5XX':
5618 $ref: '#/components/responses/UnexpectedError'
5619 default:
5620 $ref: '#/components/responses/UnexpectedError'
5621 '/k8scluster/v1/infra_config_profiles/{infra_config_profile_id}':
5622 parameters:
5623 - name: infra_config_profile_id
5624 in: path
5625 required: true
5626 description: infra_config_profile_id
5627 schema:
5628 type: string
5629 get:
5630 tags:
5631 - "K8s Cluster"
5632 summary: Reading Infra config profiles
5633 description: This API is used to reading specific Infra config profile
5634 operationId: readInfraConfigProfile
5635 responses:
5636 '200':
5637 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5638 content:
5639 application/json:
5640 schema:
5641 $ref: '#/components/schemas/ProfileInfo'
5642 application/yaml:
5643 schema:
5644 $ref: '#/components/schemas/ProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5645 '400':
5646 $ref: '#/components/responses/BadRequest'
5647 '401':
5648 $ref: '#/components/responses/Unauthorized'
5649 '403':
5650 $ref: '#/components/responses/Forbidden'
5651 '404':
5652 $ref: '#/components/responses/NotFound'
5653 '405':
5654 $ref: '#/components/responses/MethodNotAllowed'
5655 '406':
5656 $ref: '#/components/responses/NotAcceptable'
5657 '409':
5658 $ref: '#/components/responses/Conflict'
5659 '422':
5660 $ref: '#/components/responses/UnprocessableEntity'
5661 '500':
5662 $ref: '#/components/responses/InternalServerError'
5663 '503':
5664 $ref: '#/components/responses/ServiceUnavailable'
5665 '5XX':
5666 $ref: '#/components/responses/UnexpectedError'
5667 default:
5668 $ref: '#/components/responses/UnexpectedError'
5669 patch:
5670 tags:
5671 - "K8s Cluster"
5672 summary: Patching Infra config profiles
5673 description: This API is used to patch specific Infra config profile
5674 operationId: patchInfraConfigProfile
5675 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5676 $ref: '#/components/requestBodies/PatchProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5677 responses:
5678 '202':
5679 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5680 content:
5681 application/json:
5682 schema:
5683 $ref: '#/components/schemas/OpId'
5684 application/yaml:
5685 schema:
5686 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5687 '400':
5688 $ref: '#/components/responses/BadRequest'
5689 '401':
5690 $ref: '#/components/responses/Unauthorized'
5691 '403':
5692 $ref: '#/components/responses/Forbidden'
5693 '404':
5694 $ref: '#/components/responses/NotFound'
5695 '405':
5696 $ref: '#/components/responses/MethodNotAllowed'
5697 '406':
5698 $ref: '#/components/responses/NotAcceptable'
5699 '409':
5700 $ref: '#/components/responses/Conflict'
5701 '422':
5702 $ref: '#/components/responses/UnprocessableEntity'
5703 '500':
5704 $ref: '#/components/responses/InternalServerError'
5705 '503':
5706 $ref: '#/components/responses/ServiceUnavailable'
5707 '5XX':
5708 $ref: '#/components/responses/UnexpectedError'
5709 default:
5710 $ref: '#/components/responses/UnexpectedError'
5711 delete:
5712 tags:
5713 - "K8s Cluster"
5714 summary: Deleteing Infra config profiles
5715 description: This API is used to delete specific Infra config profile
5716 operationId: deleteInfraConfigProfile
5717 responses:
5718 '202':
5719 description: Accepted
5720 '400':
5721 $ref: '#/components/responses/BadRequest'
5722 '401':
5723 $ref: '#/components/responses/Unauthorized'
5724 '403':
5725 $ref: '#/components/responses/Forbidden'
5726 '404':
5727 $ref: '#/components/responses/NotFound'
5728 '405':
5729 $ref: '#/components/responses/MethodNotAllowed'
5730 '406':
5731 $ref: '#/components/responses/NotAcceptable'
5732 '409':
5733 $ref: '#/components/responses/Conflict'
5734 '422':
5735 $ref: '#/components/responses/UnprocessableEntity'
5736 '500':
5737 $ref: '#/components/responses/InternalServerError'
5738 '503':
5739 $ref: '#/components/responses/ServiceUnavailable'
5740 '5XX':
5741 $ref: '#/components/responses/UnexpectedError'
5742 default:
5743 $ref: '#/components/responses/UnexpectedError'
5744 '/k8scluster/v1/clusters/{cluster_id}/infra_config_profiles':
5745 parameters:
5746 - name: cluster_id
5747 in: path
5748 required: true
5749 description: cluster_id
5750 schema:
5751 type: string
5752 patch:
5753 tags:
5754 - "K8s Cluster"
5755 summary: Adding or Removing Infra config profile to cluster
5756 description: This API is used to add or remove infra config profile to cluster
5757 operationId: addremoveInfraConfigProfile
5758 requestBody:
5759 $ref: '#/components/requestBodies/AttachDetachProfile'
5760 responses:
5761 '202':
5762 description: Accepted
5763 '400':
5764 $ref: '#/components/responses/BadRequest'
5765 '401':
5766 $ref: '#/components/responses/Unauthorized'
5767 '403':
5768 $ref: '#/components/responses/Forbidden'
5769 '404':
5770 $ref: '#/components/responses/NotFound'
5771 '405':
5772 $ref: '#/components/responses/MethodNotAllowed'
5773 '406':
5774 $ref: '#/components/responses/NotAcceptable'
5775 '409':
5776 $ref: '#/components/responses/Conflict'
5777 '422':
5778 $ref: '#/components/responses/UnprocessableEntity'
5779 '500':
5780 $ref: '#/components/responses/InternalServerError'
5781 '503':
5782 $ref: '#/components/responses/ServiceUnavailable'
5783 '5XX':
5784 $ref: '#/components/responses/UnexpectedError'
5785 default:
5786 $ref: '#/components/responses/UnexpectedError'
5787 get:
5788 tags:
5789 - "K8s Cluster"
5790 summary: Getting Infra config profile in cluster
5791 description: This API is used to get infra config profiles in specified cluster
5792 operationId: getInfraConfigProfile
5793 responses:
5794 '200':
5795 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5796 content:
5797 application/json:
5798 schema:
5799 $ref: '#/components/schemas/ArrayOfProfileInfo'
5800 application/yaml:
5801 schema:
5802 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5803 '400':
5804 $ref: '#/components/responses/BadRequest'
5805 '401':
5806 $ref: '#/components/responses/Unauthorized'
5807 '403':
5808 $ref: '#/components/responses/Forbidden'
5809 '404':
5810 $ref: '#/components/responses/NotFound'
5811 '405':
5812 $ref: '#/components/responses/MethodNotAllowed'
5813 '406':
5814 $ref: '#/components/responses/NotAcceptable'
5815 '409':
5816 $ref: '#/components/responses/Conflict'
5817 '422':
5818 $ref: '#/components/responses/UnprocessableEntity'
5819 '500':
5820 $ref: '#/components/responses/InternalServerError'
5821 '503':
5822 $ref: '#/components/responses/ServiceUnavailable'
5823 '5XX':
5824 $ref: '#/components/responses/UnexpectedError'
5825 default:
5826 $ref: '#/components/responses/UnexpectedError'
5827 '/k8scluster/v1/resource_profiles':
5828 post:
5829 tags:
5830 - "K8s Cluster"
5831 summary: Creating resource profiles
5832 description: This API is used to create resource profiles
5833 operationId: createResourceProfile
5834 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5835 $ref: '#/components/requestBodies/CreateProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5836 responses:
5837 '201':
5838 description: Created
5839 content:
5840 application/json:
5841 schema:
5842 $ref: '#/components/schemas/ObjectId'
5843 application/yaml:
5844 schema:
5845 $ref: '#/components/schemas/ObjectId'
5846 '400':
5847 $ref: '#/components/responses/BadRequest'
5848 '401':
5849 $ref: '#/components/responses/Unauthorized'
5850 '403':
5851 $ref: '#/components/responses/Forbidden'
5852 '404':
5853 $ref: '#/components/responses/NotFound'
5854 '405':
5855 $ref: '#/components/responses/MethodNotAllowed'
5856 '406':
5857 $ref: '#/components/responses/NotAcceptable'
5858 '409':
5859 $ref: '#/components/responses/Conflict'
5860 '422':
5861 $ref: '#/components/responses/UnprocessableEntity'
5862 '500':
5863 $ref: '#/components/responses/InternalServerError'
5864 '503':
5865 $ref: '#/components/responses/ServiceUnavailable'
5866 '5XX':
5867 $ref: '#/components/responses/UnexpectedError'
5868 default:
5869 $ref: '#/components/responses/UnexpectedError'
5870 get:
5871 tags:
5872 - "K8s Cluster"
5873 summary: Listing resource profiles
5874 description: This API is used to list all resource profiles
5875 operationId: listResourceProfile
5876 responses:
5877 '200':
5878 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5879 content:
5880 application/json:
5881 schema:
5882 $ref: '#/components/schemas/ArrayOfProfileInfo'
5883 application/yaml:
5884 schema:
5885 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5886 '400':
5887 $ref: '#/components/responses/BadRequest'
5888 '401':
5889 $ref: '#/components/responses/Unauthorized'
5890 '403':
5891 $ref: '#/components/responses/Forbidden'
5892 '404':
5893 $ref: '#/components/responses/NotFound'
5894 '405':
5895 $ref: '#/components/responses/MethodNotAllowed'
5896 '406':
5897 $ref: '#/components/responses/NotAcceptable'
5898 '409':
5899 $ref: '#/components/responses/Conflict'
5900 '422':
5901 $ref: '#/components/responses/UnprocessableEntity'
5902 '500':
5903 $ref: '#/components/responses/InternalServerError'
5904 '503':
5905 $ref: '#/components/responses/ServiceUnavailable'
5906 '5XX':
5907 $ref: '#/components/responses/UnexpectedError'
5908 default:
5909 $ref: '#/components/responses/UnexpectedError'
5910 '/k8scluster/v1/resource_profiles/{resource_profile_id}':
5911 parameters:
5912 - name: resource_profile_id
5913 in: path
5914 required: true
5915 description: resource_profile_id
5916 schema:
5917 type: string
5918 get:
5919 tags:
5920 - "K8s Cluster"
5921 summary: Reading resource profiles
5922 description: This API is used to reading specific resource profile
5923 operationId: readResourceProfile
5924 responses:
5925 '200':
5926 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5927 content:
5928 application/json:
5929 schema:
5930 $ref: '#/components/schemas/ProfileInfo'
5931 application/yaml:
5932 schema:
5933 $ref: '#/components/schemas/ProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5934 '400':
5935 $ref: '#/components/responses/BadRequest'
5936 '401':
5937 $ref: '#/components/responses/Unauthorized'
5938 '403':
5939 $ref: '#/components/responses/Forbidden'
5940 '404':
5941 $ref: '#/components/responses/NotFound'
5942 '405':
5943 $ref: '#/components/responses/MethodNotAllowed'
5944 '406':
5945 $ref: '#/components/responses/NotAcceptable'
5946 '409':
5947 $ref: '#/components/responses/Conflict'
5948 '422':
5949 $ref: '#/components/responses/UnprocessableEntity'
5950 '500':
5951 $ref: '#/components/responses/InternalServerError'
5952 '503':
5953 $ref: '#/components/responses/ServiceUnavailable'
5954 '5XX':
5955 $ref: '#/components/responses/UnexpectedError'
5956 default:
5957 $ref: '#/components/responses/UnexpectedError'
5958 patch:
5959 tags:
5960 - "K8s Cluster"
5961 summary: Patching resource profiles
5962 description: This API is used to patch specific resource profile
5963 operationId: patchResourceProfile
5964 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5965 $ref: '#/components/requestBodies/PatchProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5966 responses:
5967 '202':
5968 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]5969 content:
5970 application/json:
5971 schema:
5972 $ref: '#/components/schemas/OpId'
5973 application/yaml:
5974 schema:
5975 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]5976 '400':
5977 $ref: '#/components/responses/BadRequest'
5978 '401':
5979 $ref: '#/components/responses/Unauthorized'
5980 '403':
5981 $ref: '#/components/responses/Forbidden'
5982 '404':
5983 $ref: '#/components/responses/NotFound'
5984 '405':
5985 $ref: '#/components/responses/MethodNotAllowed'
5986 '406':
5987 $ref: '#/components/responses/NotAcceptable'
5988 '409':
5989 $ref: '#/components/responses/Conflict'
5990 '422':
5991 $ref: '#/components/responses/UnprocessableEntity'
5992 '500':
5993 $ref: '#/components/responses/InternalServerError'
5994 '503':
5995 $ref: '#/components/responses/ServiceUnavailable'
5996 '5XX':
5997 $ref: '#/components/responses/UnexpectedError'
5998 default:
5999 $ref: '#/components/responses/UnexpectedError'
6000 delete:
6001 tags:
6002 - "K8s Cluster"
6003 summary: Deleteing resource profiles
6004 description: This API is used to delete specific resource profile
6005 operationId: deleteResourceProfile
6006 responses:
6007 '202':
6008 description: Accepted
6009 '400':
6010 $ref: '#/components/responses/BadRequest'
6011 '401':
6012 $ref: '#/components/responses/Unauthorized'
6013 '403':
6014 $ref: '#/components/responses/Forbidden'
6015 '404':
6016 $ref: '#/components/responses/NotFound'
6017 '405':
6018 $ref: '#/components/responses/MethodNotAllowed'
6019 '406':
6020 $ref: '#/components/responses/NotAcceptable'
6021 '409':
6022 $ref: '#/components/responses/Conflict'
6023 '422':
6024 $ref: '#/components/responses/UnprocessableEntity'
6025 '500':
6026 $ref: '#/components/responses/InternalServerError'
6027 '503':
6028 $ref: '#/components/responses/ServiceUnavailable'
6029 '5XX':
6030 $ref: '#/components/responses/UnexpectedError'
6031 default:
6032 $ref: '#/components/responses/UnexpectedError'
6033 '/k8scluster/v1/clusters/{cluster_id}/resource_profiles':
6034 parameters:
6035 - name: cluster_id
6036 in: path
6037 required: true
6038 description: cluster_id
6039 schema:
6040 type: string
6041 patch:
6042 tags:
6043 - "K8s Cluster"
6044 summary: Adding or Removing Resource profile to cluster
6045 description: This API is used to add or remove resource profiles to cluster
6046 operationId: addremoveResourceProfile
6047 requestBody:
6048 $ref: '#/components/requestBodies/AttachDetachProfile'
6049 responses:
6050 '202':
6051 description: Accepted
6052 '400':
6053 $ref: '#/components/responses/BadRequest'
6054 '401':
6055 $ref: '#/components/responses/Unauthorized'
6056 '403':
6057 $ref: '#/components/responses/Forbidden'
6058 '404':
6059 $ref: '#/components/responses/NotFound'
6060 '405':
6061 $ref: '#/components/responses/MethodNotAllowed'
6062 '406':
6063 $ref: '#/components/responses/NotAcceptable'
6064 '409':
6065 $ref: '#/components/responses/Conflict'
6066 '422':
6067 $ref: '#/components/responses/UnprocessableEntity'
6068 '500':
6069 $ref: '#/components/responses/InternalServerError'
6070 '503':
6071 $ref: '#/components/responses/ServiceUnavailable'
6072 '5XX':
6073 $ref: '#/components/responses/UnexpectedError'
6074 default:
6075 $ref: '#/components/responses/UnexpectedError'
6076 get:
6077 tags:
6078 - "K8s Cluster"
6079 summary: Getting Resource profile in cluster
6080 description: This API is used to get resource profiles in specified cluster
6081 operationId: getResourceProfile
6082 responses:
6083 '200':
6084 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6085 content:
6086 application/json:
6087 schema:
6088 $ref: '#/components/schemas/ArrayOfProfileInfo'
6089 application/yaml:
6090 schema:
6091 $ref: '#/components/schemas/ArrayOfProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6092 '400':
6093 $ref: '#/components/responses/BadRequest'
6094 '401':
6095 $ref: '#/components/responses/Unauthorized'
6096 '403':
6097 $ref: '#/components/responses/Forbidden'
6098 '404':
6099 $ref: '#/components/responses/NotFound'
6100 '405':
6101 $ref: '#/components/responses/MethodNotAllowed'
6102 '406':
6103 $ref: '#/components/responses/NotAcceptable'
6104 '409':
6105 $ref: '#/components/responses/Conflict'
6106 '422':
6107 $ref: '#/components/responses/UnprocessableEntity'
6108 '500':
6109 $ref: '#/components/responses/InternalServerError'
6110 '503':
6111 $ref: '#/components/responses/ServiceUnavailable'
6112 '5XX':
6113 $ref: '#/components/responses/UnexpectedError'
6114 default:
6115 $ref: '#/components/responses/UnexpectedError'
6116#END k8s Cluster
6117
6118# BEGIN OKA packages
6119 '/oka/v1/oka_packages':
6120 get:
6121 tags:
6122 - "OKA packages"
6123 summary: List OKA package
6124 description: This API is used to List OKA packages
6125 operationId: getOKAPackage
6126 responses:
6127 '200':
6128 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6129 content:
6130 application/json:
6131 schema:
6132 $ref: '#/components/schemas/ArrayOfOkaPackage'
6133 application/yaml:
6134 schema:
6135 $ref: '#/components/schemas/ArrayOfOkaPackage'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6136 '400':
6137 $ref: '#/components/responses/BadRequest'
6138 '401':
6139 $ref: '#/components/responses/Unauthorized'
6140 '403':
6141 $ref: '#/components/responses/Forbidden'
6142 '404':
6143 $ref: '#/components/responses/NotFound'
6144 '405':
6145 $ref: '#/components/responses/MethodNotAllowed'
6146 '406':
6147 $ref: '#/components/responses/NotAcceptable'
6148 '409':
6149 $ref: '#/components/responses/Conflict'
6150 '422':
6151 $ref: '#/components/responses/UnprocessableEntity'
6152 '500':
6153 $ref: '#/components/responses/InternalServerError'
6154 '503':
6155 $ref: '#/components/responses/ServiceUnavailable'
6156 '5XX':
6157 $ref: '#/components/responses/UnexpectedError'
6158 default:
6159 $ref: '#/components/responses/UnexpectedError'
6160 post:
6161 tags:
6162 - "OKA packages"
6163 summary: Add OKA package
6164 description: This API is used to add OKA packages
6165 operationId: addOKAPackage
6166 requestBody:
6167 content:
6168 application/zip:
6169 schema:
6170 $ref: '#/components/schemas/OkaPackage'
6171 responses:
6172 '201':
6173 description: Created
6174 content:
6175 application/json:
6176 schema:
6177 $ref: '#/components/schemas/ObjectId'
6178 application/yaml:
6179 schema:
6180 $ref: '#/components/schemas/ObjectId'
6181 '400':
6182 $ref: '#/components/responses/BadRequest'
6183 '401':
6184 $ref: '#/components/responses/Unauthorized'
6185 '403':
6186 $ref: '#/components/responses/Forbidden'
6187 '404':
6188 $ref: '#/components/responses/NotFound'
6189 '405':
6190 $ref: '#/components/responses/MethodNotAllowed'
6191 '406':
6192 $ref: '#/components/responses/NotAcceptable'
6193 '409':
6194 $ref: '#/components/responses/Conflict'
6195 '422':
6196 $ref: '#/components/responses/UnprocessableEntity'
6197 '500':
6198 $ref: '#/components/responses/InternalServerError'
6199 '503':
6200 $ref: '#/components/responses/ServiceUnavailable'
6201 '5XX':
6202 $ref: '#/components/responses/UnexpectedError'
6203 default:
6204 $ref: '#/components/responses/UnexpectedError'
6205 '/oka/v1/oka_packages/{oka_pkg_id}':
6206 parameters:
6207 - name: oka_pkg_id
6208 in: path
6209 required: true
6210 description: oka_pkg_id
6211 schema:
6212 type: string
6213 get:
6214 tags:
6215 - "OKA packages"
6216 summary: Read OKA package
6217 description: This API is used to Read OKA packages
6218 operationId: readOKAPackage
6219 responses:
6220 '200':
6221 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6222 content:
6223 application/json:
6224 schema:
6225 $ref: '#/components/schemas/OkaPackageList'
6226 application/yaml:
6227 schema:
6228 $ref: '#/components/schemas/OkaPackageList'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6229 '400':
6230 $ref: '#/components/responses/BadRequest'
6231 '401':
6232 $ref: '#/components/responses/Unauthorized'
6233 '403':
6234 $ref: '#/components/responses/Forbidden'
6235 '404':
6236 $ref: '#/components/responses/NotFound'
6237 '405':
6238 $ref: '#/components/responses/MethodNotAllowed'
6239 '406':
6240 $ref: '#/components/responses/NotAcceptable'
6241 '409':
6242 $ref: '#/components/responses/Conflict'
6243 '422':
6244 $ref: '#/components/responses/UnprocessableEntity'
6245 '500':
6246 $ref: '#/components/responses/InternalServerError'
6247 '503':
6248 $ref: '#/components/responses/ServiceUnavailable'
6249 '5XX':
6250 $ref: '#/components/responses/UnexpectedError'
6251 default:
6252 $ref: '#/components/responses/UnexpectedError'
6253 patch:
6254 tags:
6255 - "OKA packages"
6256 summary: Update OKA package
6257 description: This API is used to Update OKA packages
6258 operationId: updateOKAPackage
6259 requestBody:
6260 content:
6261 application/zip:
6262 schema:
6263 $ref: '#/components/schemas/OkaPackage'
6264 responses:
6265 '202':
6266 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6267 content:
6268 application/json:
6269 schema:
6270 $ref: '#/components/schemas/OpId'
6271 application/yaml:
6272 schema:
6273 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6274 '400':
6275 $ref: '#/components/responses/BadRequest'
6276 '401':
6277 $ref: '#/components/responses/Unauthorized'
6278 '403':
6279 $ref: '#/components/responses/Forbidden'
6280 '404':
6281 $ref: '#/components/responses/NotFound'
6282 '405':
6283 $ref: '#/components/responses/MethodNotAllowed'
6284 '406':
6285 $ref: '#/components/responses/NotAcceptable'
6286 '409':
6287 $ref: '#/components/responses/Conflict'
6288 '422':
6289 $ref: '#/components/responses/UnprocessableEntity'
6290 '500':
6291 $ref: '#/components/responses/InternalServerError'
6292 '503':
6293 $ref: '#/components/responses/ServiceUnavailable'
6294 '5XX':
6295 $ref: '#/components/responses/UnexpectedError'
6296 default:
6297 $ref: '#/components/responses/UnexpectedError'
6298 delete:
6299 tags:
6300 - "OKA packages"
6301 summary: Delete OKA package
6302 description: This API is used to Delete OKA packages
6303 operationId: deleteOKAPackage
6304 responses:
6305 '202':
6306 description: Accepted
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# END OKA packages
6332
6333# BEGIN KSU
6334 '/ksu/v1/ksus':
6335 get:
6336 tags:
6337 - "KSU"
6338 summary: Get KSU
6339 description: This API is used to Get KSU
6340 operationId: getKSU
6341 responses:
6342 '200':
6343 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6344 content:
6345 application/json:
6346 schema:
6347 $ref: '#/components/schemas/ArrayOfKsuList'
6348 application/yaml:
6349 schema:
6350 $ref: '#/components/schemas/ArrayOfKsuList'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6351 '400':
6352 $ref: '#/components/responses/BadRequest'
6353 '401':
6354 $ref: '#/components/responses/Unauthorized'
6355 '403':
6356 $ref: '#/components/responses/Forbidden'
6357 '404':
6358 $ref: '#/components/responses/NotFound'
6359 '405':
6360 $ref: '#/components/responses/MethodNotAllowed'
6361 '406':
6362 $ref: '#/components/responses/NotAcceptable'
6363 '409':
6364 $ref: '#/components/responses/Conflict'
6365 '422':
6366 $ref: '#/components/responses/UnprocessableEntity'
6367 '500':
6368 $ref: '#/components/responses/InternalServerError'
6369 '503':
6370 $ref: '#/components/responses/ServiceUnavailable'
6371 '5XX':
6372 $ref: '#/components/responses/UnexpectedError'
6373 default:
6374 $ref: '#/components/responses/UnexpectedError'
6375 post:
6376 tags:
6377 - "KSU"
6378 summary: Add KSU
6379 description: This API is used to Add KSU
6380 operationId: addKSU
6381 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6382 $ref: '#/components/requestBodies/ArrayOfKsu'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6383 responses:
6384 '201':
6385 description: Created
6386 content:
6387 application/json:
6388 schema:
6389 $ref: '#/components/schemas/ObjectId'
6390 application/yaml:
6391 schema:
6392 $ref: '#/components/schemas/ObjectId'
6393 '400':
6394 $ref: '#/components/responses/BadRequest'
6395 '401':
6396 $ref: '#/components/responses/Unauthorized'
6397 '403':
6398 $ref: '#/components/responses/Forbidden'
6399 '404':
6400 $ref: '#/components/responses/NotFound'
6401 '405':
6402 $ref: '#/components/responses/MethodNotAllowed'
6403 '406':
6404 $ref: '#/components/responses/NotAcceptable'
6405 '409':
6406 $ref: '#/components/responses/Conflict'
6407 '422':
6408 $ref: '#/components/responses/UnprocessableEntity'
6409 '500':
6410 $ref: '#/components/responses/InternalServerError'
6411 '503':
6412 $ref: '#/components/responses/ServiceUnavailable'
6413 '5XX':
6414 $ref: '#/components/responses/UnexpectedError'
6415 default:
6416 $ref: '#/components/responses/UnexpectedError'
6417 '/ksu/v1/ksus/{ksu_id}':
6418 parameters:
6419 - name: ksu_id
6420 in: path
6421 required: true
6422 description: ksu_id
6423 schema:
6424 type: string
6425 get:
6426 tags:
6427 - "KSU"
6428 summary: Read KSU
6429 description: This API is used to Read KSU
6430 operationId: readKSU
6431 responses:
6432 '200':
6433 description: OK
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6434 content:
6435 application/json:
6436 schema:
6437 $ref: '#/components/schemas/KsuList'
6438 application/yaml:
6439 schema:
6440 $ref: '#/components/schemas/KsuList'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6441 '400':
6442 $ref: '#/components/responses/BadRequest'
6443 '401':
6444 $ref: '#/components/responses/Unauthorized'
6445 '403':
6446 $ref: '#/components/responses/Forbidden'
6447 '404':
6448 $ref: '#/components/responses/NotFound'
6449 '405':
6450 $ref: '#/components/responses/MethodNotAllowed'
6451 '406':
6452 $ref: '#/components/responses/NotAcceptable'
6453 '409':
6454 $ref: '#/components/responses/Conflict'
6455 '422':
6456 $ref: '#/components/responses/UnprocessableEntity'
6457 '500':
6458 $ref: '#/components/responses/InternalServerError'
6459 '503':
6460 $ref: '#/components/responses/ServiceUnavailable'
6461 '5XX':
6462 $ref: '#/components/responses/UnexpectedError'
6463 default:
6464 $ref: '#/components/responses/UnexpectedError'
6465 patch:
6466 tags:
6467 - "KSU"
6468 summary: Update KSU
6469 description: This API is used to Update KSU
6470 operationId: updateKSU
6471 requestBody:
6472 $ref: '#/components/requestBodies/Ksu'
6473 responses:
6474 '202':
6475 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6476 content:
6477 application/json:
6478 schema:
6479 $ref: '#/components/schemas/OpId'
6480 application/yaml:
6481 schema:
6482 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6483 '400':
6484 $ref: '#/components/responses/BadRequest'
6485 '401':
6486 $ref: '#/components/responses/Unauthorized'
6487 '403':
6488 $ref: '#/components/responses/Forbidden'
6489 '404':
6490 $ref: '#/components/responses/NotFound'
6491 '405':
6492 $ref: '#/components/responses/MethodNotAllowed'
6493 '406':
6494 $ref: '#/components/responses/NotAcceptable'
6495 '409':
6496 $ref: '#/components/responses/Conflict'
6497 '422':
6498 $ref: '#/components/responses/UnprocessableEntity'
6499 '500':
6500 $ref: '#/components/responses/InternalServerError'
6501 '503':
6502 $ref: '#/components/responses/ServiceUnavailable'
6503 '5XX':
6504 $ref: '#/components/responses/UnexpectedError'
6505 default:
6506 $ref: '#/components/responses/UnexpectedError'
6507 delete:
6508 tags:
6509 - "KSU"
6510 summary: Delete KSU
6511 description: This API is used to Delete KSU
6512 operationId: deleteKSU
6513 responses:
6514 '202':
6515 description: Accepted
6516 '400':
6517 $ref: '#/components/responses/BadRequest'
6518 '401':
6519 $ref: '#/components/responses/Unauthorized'
6520 '403':
6521 $ref: '#/components/responses/Forbidden'
6522 '404':
6523 $ref: '#/components/responses/NotFound'
6524 '405':
6525 $ref: '#/components/responses/MethodNotAllowed'
6526 '406':
6527 $ref: '#/components/responses/NotAcceptable'
6528 '409':
6529 $ref: '#/components/responses/Conflict'
6530 '422':
6531 $ref: '#/components/responses/UnprocessableEntity'
6532 '500':
6533 $ref: '#/components/responses/InternalServerError'
6534 '503':
6535 $ref: '#/components/responses/ServiceUnavailable'
6536 '5XX':
6537 $ref: '#/components/responses/UnexpectedError'
6538 default:
6539 $ref: '#/components/responses/UnexpectedError'
6540 '/ksu/v1/ksus/update':
6541 post:
6542 tags:
6543 - "KSU"
6544 summary: Update multiple KSU
6545 description: This API is used to Update multiple KSU
6546 operationId: updateMultipleKSU
6547 requestBody:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6548 $ref: '#/components/requestBodies/ArrayOfKsu'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6549 responses:
6550 '202':
6551 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6552 content:
6553 application/json:
6554 schema:
6555 $ref: '#/components/schemas/OpId'
6556 application/yaml:
6557 schema:
6558 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6559 '400':
6560 $ref: '#/components/responses/BadRequest'
6561 '401':
6562 $ref: '#/components/responses/Unauthorized'
6563 '403':
6564 $ref: '#/components/responses/Forbidden'
6565 '404':
6566 $ref: '#/components/responses/NotFound'
6567 '405':
6568 $ref: '#/components/responses/MethodNotAllowed'
6569 '406':
6570 $ref: '#/components/responses/NotAcceptable'
6571 '409':
6572 $ref: '#/components/responses/Conflict'
6573 '422':
6574 $ref: '#/components/responses/UnprocessableEntity'
6575 '500':
6576 $ref: '#/components/responses/InternalServerError'
6577 '503':
6578 $ref: '#/components/responses/ServiceUnavailable'
6579 '5XX':
6580 $ref: '#/components/responses/UnexpectedError'
6581 default:
6582 $ref: '#/components/responses/UnexpectedError'
6583 '/ksu/v1/ksus/delete':
6584 post:
6585 tags:
6586 - "KSU"
6587 summary: Delete multiple KSU
6588 description: This API is used to Delete multiple KSU
6589 operationId: deleteMultipleKSU
6590 requestBody:
6591 $ref: '#/components/requestBodies/DeleteMultipleKsu'
6592 responses:
6593 '202':
6594 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6595 content:
6596 application/json:
6597 schema:
6598 $ref: '#/components/schemas/OpId'
6599 application/yaml:
6600 schema:
6601 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6602 '400':
6603 $ref: '#/components/responses/BadRequest'
6604 '401':
6605 $ref: '#/components/responses/Unauthorized'
6606 '403':
6607 $ref: '#/components/responses/Forbidden'
6608 '404':
6609 $ref: '#/components/responses/NotFound'
6610 '405':
6611 $ref: '#/components/responses/MethodNotAllowed'
6612 '406':
6613 $ref: '#/components/responses/NotAcceptable'
6614 '409':
6615 $ref: '#/components/responses/Conflict'
6616 '422':
6617 $ref: '#/components/responses/UnprocessableEntity'
6618 '500':
6619 $ref: '#/components/responses/InternalServerError'
6620 '503':
6621 $ref: '#/components/responses/ServiceUnavailable'
6622 '5XX':
6623 $ref: '#/components/responses/UnexpectedError'
6624 default:
6625 $ref: '#/components/responses/UnexpectedError'
6626 '/ksu/v1/ksus/{ksu_id}/clone':
6627 parameters:
6628 - name: ksu_id
6629 in: path
6630 required: true
6631 description: ksu_id
6632 schema:
6633 type: string
6634 post:
6635 tags:
6636 - "KSU"
6637 summary: Clone KSU
6638 description: This API is used to Clone KSU
6639 operationId: cloneKSU
6640 requestBody:
6641 $ref: '#/components/requestBodies/CloneKsu'
6642 responses:
6643 '202':
6644 description: Accepted
6645 content:
6646 application/json:
6647 schema:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6648 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6649 application/yaml:
6650 schema:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6651 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6652 '400':
6653 $ref: '#/components/responses/BadRequest'
6654 '401':
6655 $ref: '#/components/responses/Unauthorized'
6656 '403':
6657 $ref: '#/components/responses/Forbidden'
6658 '404':
6659 $ref: '#/components/responses/NotFound'
6660 '405':
6661 $ref: '#/components/responses/MethodNotAllowed'
6662 '406':
6663 $ref: '#/components/responses/NotAcceptable'
6664 '409':
6665 $ref: '#/components/responses/Conflict'
6666 '422':
6667 $ref: '#/components/responses/UnprocessableEntity'
6668 '500':
6669 $ref: '#/components/responses/InternalServerError'
6670 '503':
6671 $ref: '#/components/responses/ServiceUnavailable'
6672 '5XX':
6673 $ref: '#/components/responses/UnexpectedError'
6674 default:
6675 $ref: '#/components/responses/UnexpectedError'
6676 '/ksu/v1/ksus/{ksu_id}/move':
6677 parameters:
6678 - name: ksu_id
6679 in: path
6680 required: true
6681 description: ksu_id
6682 schema:
6683 type: string
6684 post:
6685 tags:
6686 - "KSU"
6687 summary: Move KSU
6688 description: This API is used to Move KSU
6689 operationId: moveKSU
6690 requestBody:
6691 $ref: '#/components/requestBodies/MoveKsu'
6692 responses:
6693 '202':
6694 description: Accepted
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]6695 content:
6696 application/json:
6697 schema:
6698 $ref: '#/components/schemas/OpId'
6699 application/yaml:
6700 schema:
6701 $ref: '#/components/schemas/OpId'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]6702 '400':
6703 $ref: '#/components/responses/BadRequest'
6704 '401':
6705 $ref: '#/components/responses/Unauthorized'
6706 '403':
6707 $ref: '#/components/responses/Forbidden'
6708 '404':
6709 $ref: '#/components/responses/NotFound'
6710 '405':
6711 $ref: '#/components/responses/MethodNotAllowed'
6712 '406':
6713 $ref: '#/components/responses/NotAcceptable'
6714 '409':
6715 $ref: '#/components/responses/Conflict'
6716 '422':
6717 $ref: '#/components/responses/UnprocessableEntity'
6718 '500':
6719 $ref: '#/components/responses/InternalServerError'
6720 '503':
6721 $ref: '#/components/responses/ServiceUnavailable'
6722 '5XX':
6723 $ref: '#/components/responses/UnexpectedError'
6724 default:
6725 $ref: '#/components/responses/UnexpectedError'
6726# END KSU
6727
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]6728# BEGIN Admin
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6729 '/admin/v1/tokens':
6730 get:
6731 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6732 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6733 - "Admin"
6734 summary: Query information about multiple Tokens
6735 description: Query information about multiple Tokens
6736 operationId: getTokens
6737 responses:
6738 '200':
6739 description: OK
6740 content:
6741 application/json:
6742 schema:
6743 $ref: '#/components/schemas/ArrayOfTokenInfo'
6744 application/yaml:
6745 schema:
6746 $ref: '#/components/schemas/ArrayOfTokenInfo'
6747 '400':
6748 $ref: '#/components/responses/BadRequest'
6749 '401':
6750 $ref: '#/components/responses/Unauthorized'
6751 '403':
6752 $ref: '#/components/responses/Forbidden'
6753 '404':
6754 $ref: '#/components/responses/NotFound'
6755 '405':
6756 $ref: '#/components/responses/MethodNotAllowed'
6757 '406':
6758 $ref: '#/components/responses/NotAcceptable'
6759 '409':
6760 $ref: '#/components/responses/Conflict'
6761 '422':
6762 $ref: '#/components/responses/UnprocessableEntity'
6763 '500':
6764 $ref: '#/components/responses/InternalServerError'
6765 '503':
6766 $ref: '#/components/responses/ServiceUnavailable'
6767 '5XX':
6768 $ref: '#/components/responses/UnexpectedError'
6769 default:
6770 $ref: '#/components/responses/UnexpectedError'
6771 post:
6772 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6773 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6774 - "Admin"
6775 summary: Request a new Token
6776 description: Request a new Token
6777 operationId: createToken
6778 requestBody:
6779 $ref: '#/components/requestBodies/CreateTokenRequest'
6780 responses:
6781 '200':
6782 description: OK
6783 headers:
6784 Location:
6785 schema:
6786 type: string
6787 format: uri
6788 content:
6789 application/json:
6790 schema:
selvi.ja6f638b2022-03-23 12:27:35 +0000[diff] [blame]6791 oneOf:
6792 - $ref: '#/components/schemas/TokenInfo'
6793 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6794 application/yaml:
6795 schema:
selvi.ja6f638b2022-03-23 12:27:35 +0000[diff] [blame]6796 oneOf:
6797 - $ref: '#/components/schemas/TokenInfo'
6798 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6799 '400':
6800 $ref: '#/components/responses/BadRequest'
6801 '401':
6802 $ref: '#/components/responses/Unauthorized'
6803 '403':
6804 $ref: '#/components/responses/Forbidden'
6805 '404':
6806 $ref: '#/components/responses/NotFound'
6807 '405':
6808 $ref: '#/components/responses/MethodNotAllowed'
6809 '406':
6810 $ref: '#/components/responses/NotAcceptable'
6811 '409':
6812 $ref: '#/components/responses/Conflict'
6813 '422':
6814 $ref: '#/components/responses/UnprocessableEntity'
6815 '500':
6816 $ref: '#/components/responses/InternalServerError'
6817 '503':
6818 $ref: '#/components/responses/ServiceUnavailable'
6819 '5XX':
6820 $ref: '#/components/responses/UnexpectedError'
6821 default:
6822 $ref: '#/components/responses/UnexpectedError'
6823 delete:
6824 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6825 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6826 - "Admin"
6827 summary: Delete the Token indicated in the Authorization Header
6828 description: Delete the Token indicated in the Authorization Header
6829 operationId: deleteAuthToken
6830 responses:
6831 '200':
6832 description: OK
6833 content:
6834 application/json:
6835 schema:
6836 type: string
6837 application/yaml:
6838 schema:
6839 type: string
6840 '400':
6841 $ref: '#/components/responses/BadRequest'
6842 '401':
6843 $ref: '#/components/responses/Unauthorized'
6844 '403':
6845 $ref: '#/components/responses/Forbidden'
6846 '404':
6847 $ref: '#/components/responses/NotFound'
6848 '405':
6849 $ref: '#/components/responses/MethodNotAllowed'
6850 '406':
6851 $ref: '#/components/responses/NotAcceptable'
6852 '409':
6853 $ref: '#/components/responses/Conflict'
6854 '422':
6855 $ref: '#/components/responses/UnprocessableEntity'
6856 '500':
6857 $ref: '#/components/responses/InternalServerError'
6858 '503':
6859 $ref: '#/components/responses/ServiceUnavailable'
6860 '5XX':
6861 $ref: '#/components/responses/UnexpectedError'
6862 default:
6863 $ref: '#/components/responses/UnexpectedError'
6864 '/admin/v1/tokens/{tokenId}':
6865 parameters:
6866 - name: tokenId
6867 in: path
6868 required: true
6869 description: Token ID
6870 schema:
6871 type: string
6872 get:
6873 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6874 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6875 - "Admin"
6876 summary: Query information about an individual Token
6877 description: Query information about an individual Token
6878 operationId: getToken
6879 responses:
6880 '200':
6881 description: OK
6882 content:
6883 application/json:
6884 schema:
6885 $ref: '#/components/schemas/TokenInfo'
6886 application/yaml:
6887 schema:
6888 $ref: '#/components/schemas/TokenInfo'
6889 '400':
6890 $ref: '#/components/responses/BadRequest'
6891 '401':
6892 $ref: '#/components/responses/Unauthorized'
6893 '403':
6894 $ref: '#/components/responses/Forbidden'
6895 '404':
6896 $ref: '#/components/responses/NotFound'
6897 '405':
6898 $ref: '#/components/responses/MethodNotAllowed'
6899 '406':
6900 $ref: '#/components/responses/NotAcceptable'
6901 '409':
6902 $ref: '#/components/responses/Conflict'
6903 '422':
6904 $ref: '#/components/responses/UnprocessableEntity'
6905 '500':
6906 $ref: '#/components/responses/InternalServerError'
6907 '503':
6908 $ref: '#/components/responses/ServiceUnavailable'
6909 '5XX':
6910 $ref: '#/components/responses/UnexpectedError'
6911 default:
6912 $ref: '#/components/responses/UnexpectedError'
6913 delete:
6914 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6915 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6916 - "Admin"
6917 summary: Delete the Token indicated as parameter
6918 description: Delete the Token indicated as parameter
6919 operationId: deleteToken
6920 responses:
6921 '200':
6922 description: OK
6923 content:
6924 application/json:
6925 schema:
6926 type: string
6927 application/yaml:
6928 schema:
6929 type: string
6930 '400':
6931 $ref: '#/components/responses/BadRequest'
6932 '401':
6933 $ref: '#/components/responses/Unauthorized'
6934 '403':
6935 $ref: '#/components/responses/Forbidden'
6936 '404':
6937 $ref: '#/components/responses/NotFound'
6938 '405':
6939 $ref: '#/components/responses/MethodNotAllowed'
6940 '406':
6941 $ref: '#/components/responses/NotAcceptable'
6942 '409':
6943 $ref: '#/components/responses/Conflict'
6944 '422':
6945 $ref: '#/components/responses/UnprocessableEntity'
6946 '500':
6947 $ref: '#/components/responses/InternalServerError'
6948 '503':
6949 $ref: '#/components/responses/ServiceUnavailable'
6950 '5XX':
6951 $ref: '#/components/responses/UnexpectedError'
6952 default:
6953 $ref: '#/components/responses/UnexpectedError'
6954 '/admin/v1/users':
6955 get:
6956 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6957 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6958 - "Admin"
6959 summary: Query information about multiple Users
6960 description: Query information about multiple Users
6961 operationId: getUsers
6962 responses:
6963 '200':
6964 description: OK
6965 content:
6966 application/json:
6967 schema:
6968 $ref: '#/components/schemas/ArrayOfUserInfo'
6969 application/yaml:
6970 schema:
6971 $ref: '#/components/schemas/ArrayOfUserInfo'
6972 '400':
6973 $ref: '#/components/responses/BadRequest'
6974 '401':
6975 $ref: '#/components/responses/Unauthorized'
6976 '403':
6977 $ref: '#/components/responses/Forbidden'
6978 '404':
6979 $ref: '#/components/responses/NotFound'
6980 '405':
6981 $ref: '#/components/responses/MethodNotAllowed'
6982 '406':
6983 $ref: '#/components/responses/NotAcceptable'
6984 '409':
6985 $ref: '#/components/responses/Conflict'
6986 '422':
6987 $ref: '#/components/responses/UnprocessableEntity'
6988 '500':
6989 $ref: '#/components/responses/InternalServerError'
6990 '503':
6991 $ref: '#/components/responses/ServiceUnavailable'
6992 '5XX':
6993 $ref: '#/components/responses/UnexpectedError'
6994 default:
6995 $ref: '#/components/responses/UnexpectedError'
6996 post:
6997 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]6998 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]6999 - "Admin"
7000 summary: Create a new User
7001 description: Create a new User
7002 operationId: createUser
7003 requestBody:
7004 $ref: '#/components/requestBodies/CreateUserRequest'
7005 responses:
7006 '201':
7007 description: Created
7008 headers:
7009 Location:
7010 schema:
7011 type: string
7012 format: uri
7013 content:
7014 application/json:
7015 schema:
7016 $ref: '#/components/schemas/ObjectId'
7017 application/yaml:
7018 schema:
7019 $ref: '#/components/schemas/ObjectId'
7020 '400':
7021 $ref: '#/components/responses/BadRequest'
7022 '401':
7023 $ref: '#/components/responses/Unauthorized'
7024 '403':
7025 $ref: '#/components/responses/Forbidden'
7026 '404':
7027 $ref: '#/components/responses/NotFound'
7028 '405':
7029 $ref: '#/components/responses/MethodNotAllowed'
7030 '406':
7031 $ref: '#/components/responses/NotAcceptable'
7032 '409':
7033 $ref: '#/components/responses/Conflict'
7034 '422':
7035 $ref: '#/components/responses/UnprocessableEntity'
7036 '500':
7037 $ref: '#/components/responses/InternalServerError'
7038 '503':
7039 $ref: '#/components/responses/ServiceUnavailable'
7040 '5XX':
7041 $ref: '#/components/responses/UnexpectedError'
7042 default:
7043 $ref: '#/components/responses/UnexpectedError'
7044 '/admin/v1/users/{userId}':
7045 parameters:
7046 - name: userId
7047 in: path
7048 required: true
7049 description: User ID/Name
7050 schema:
7051 type: string
7052 get:
7053 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7054 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7055 - "Admin"
7056 summary: Query information about an individual User
7057 description: Query information about an individual User
7058 operationId: getUser
7059 responses:
7060 '200':
7061 description: OK
7062 content:
7063 application/json:
7064 schema:
7065 $ref: '#/components/schemas/UserInfo'
7066 application/yaml:
7067 schema:
7068 $ref: '#/components/schemas/UserInfo'
7069 '400':
7070 $ref: '#/components/responses/BadRequest'
7071 '401':
7072 $ref: '#/components/responses/Unauthorized'
7073 '403':
7074 $ref: '#/components/responses/Forbidden'
7075 '404':
7076 $ref: '#/components/responses/NotFound'
7077 '405':
7078 $ref: '#/components/responses/MethodNotAllowed'
7079 '406':
7080 $ref: '#/components/responses/NotAcceptable'
7081 '409':
7082 $ref: '#/components/responses/Conflict'
7083 '422':
7084 $ref: '#/components/responses/UnprocessableEntity'
7085 '500':
7086 $ref: '#/components/responses/InternalServerError'
7087 '503':
7088 $ref: '#/components/responses/ServiceUnavailable'
7089 '5XX':
7090 $ref: '#/components/responses/UnexpectedError'
7091 default:
7092 $ref: '#/components/responses/UnexpectedError'
7093 patch:
7094 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7095 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7096 - "Admin"
7097 summary: Modify a User
7098 description: Modify a User
7099 operationId: editUser
7100 requestBody:
7101 $ref: '#/components/requestBodies/EditUserRequest'
7102 responses:
7103 '204':
7104 description: No Content
7105 '400':
7106 $ref: '#/components/responses/BadRequest'
7107 '401':
7108 $ref: '#/components/responses/Unauthorized'
7109 '403':
7110 $ref: '#/components/responses/Forbidden'
7111 '404':
7112 $ref: '#/components/responses/NotFound'
7113 '405':
7114 $ref: '#/components/responses/MethodNotAllowed'
7115 '406':
7116 $ref: '#/components/responses/NotAcceptable'
7117 '409':
7118 $ref: '#/components/responses/Conflict'
7119 '422':
7120 $ref: '#/components/responses/UnprocessableEntity'
7121 '500':
7122 $ref: '#/components/responses/InternalServerError'
7123 '503':
7124 $ref: '#/components/responses/ServiceUnavailable'
7125 '5XX':
7126 $ref: '#/components/responses/UnexpectedError'
7127 default:
7128 $ref: '#/components/responses/UnexpectedError'
7129 delete:
7130 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7131 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7132 - "Admin"
7133 summary: Delete a User
7134 description: Delete a User
7135 operationId: deleteUser
7136 responses:
7137 '204':
7138 description: No Content
7139 '400':
7140 $ref: '#/components/responses/BadRequest'
7141 '401':
7142 $ref: '#/components/responses/Unauthorized'
7143 '403':
7144 $ref: '#/components/responses/Forbidden'
7145 '404':
7146 $ref: '#/components/responses/NotFound'
7147 '405':
7148 $ref: '#/components/responses/MethodNotAllowed'
7149 '406':
7150 $ref: '#/components/responses/NotAcceptable'
7151 '409':
7152 $ref: '#/components/responses/Conflict'
7153 '422':
7154 $ref: '#/components/responses/UnprocessableEntity'
7155 '500':
7156 $ref: '#/components/responses/InternalServerError'
7157 '503':
7158 $ref: '#/components/responses/ServiceUnavailable'
7159 '5XX':
7160 $ref: '#/components/responses/UnexpectedError'
7161 default:
7162 $ref: '#/components/responses/UnexpectedError'
7163 '/admin/v1/projects':
7164 get:
7165 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7166 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7167 - "Admin"
7168 summary: Query information about multiple Projects
7169 description: Query information about multiple Projects
7170 operationId: getProjects
7171 responses:
7172 '200':
7173 description: OK
7174 content:
7175 application/json:
7176 schema:
7177 $ref: '#/components/schemas/ArrayOfProjectInfo'
7178 application/yaml:
7179 schema:
7180 $ref: '#/components/schemas/ArrayOfProjectInfo'
7181 '400':
7182 $ref: '#/components/responses/BadRequest'
7183 '401':
7184 $ref: '#/components/responses/Unauthorized'
7185 '403':
7186 $ref: '#/components/responses/Forbidden'
7187 '404':
7188 $ref: '#/components/responses/NotFound'
7189 '405':
7190 $ref: '#/components/responses/MethodNotAllowed'
7191 '406':
7192 $ref: '#/components/responses/NotAcceptable'
7193 '409':
7194 $ref: '#/components/responses/Conflict'
7195 '422':
7196 $ref: '#/components/responses/UnprocessableEntity'
7197 '500':
7198 $ref: '#/components/responses/InternalServerError'
7199 '503':
7200 $ref: '#/components/responses/ServiceUnavailable'
7201 '5XX':
7202 $ref: '#/components/responses/UnexpectedError'
7203 default:
7204 $ref: '#/components/responses/UnexpectedError'
7205 post:
7206 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7207 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7208 - "Admin"
7209 summary: Create a new Project
7210 description: Create a new Project
7211 operationId: createProject
7212 requestBody:
7213 $ref: '#/components/requestBodies/CreateProjectRequest'
7214 responses:
7215 '201':
7216 description: Created
7217 headers:
7218 Location:
7219 schema:
7220 type: string
7221 format: uri
7222 content:
7223 application/json:
7224 schema:
7225 $ref: '#/components/schemas/ObjectId'
7226 application/yaml:
7227 schema:
7228 $ref: '#/components/schemas/ObjectId'
7229 '400':
7230 $ref: '#/components/responses/BadRequest'
7231 '401':
7232 $ref: '#/components/responses/Unauthorized'
7233 '403':
7234 $ref: '#/components/responses/Forbidden'
7235 '404':
7236 $ref: '#/components/responses/NotFound'
7237 '405':
7238 $ref: '#/components/responses/MethodNotAllowed'
7239 '406':
7240 $ref: '#/components/responses/NotAcceptable'
7241 '409':
7242 $ref: '#/components/responses/Conflict'
7243 '422':
7244 $ref: '#/components/responses/UnprocessableEntity'
7245 '500':
7246 $ref: '#/components/responses/InternalServerError'
7247 '503':
7248 $ref: '#/components/responses/ServiceUnavailable'
7249 '5XX':
7250 $ref: '#/components/responses/UnexpectedError'
7251 default:
7252 $ref: '#/components/responses/UnexpectedError'
7253 '/admin/v1/projects/{projectId}':
7254 parameters:
7255 - name: projectId
7256 in: path
7257 required: true
7258 description: Project ID/Name
7259 schema:
7260 type: string
7261 get:
7262 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7263 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7264 - "Admin"
7265 summary: Query information about an individual Project
7266 description: Query information about an individual Project
7267 operationId: getProject
7268 responses:
7269 '200':
7270 description: OK
7271 content:
7272 application/json:
7273 schema:
7274 $ref: '#/components/schemas/ProjectInfo'
7275 application/yaml:
7276 schema:
7277 $ref: '#/components/schemas/ProjectInfo'
7278 '400':
7279 $ref: '#/components/responses/BadRequest'
7280 '401':
7281 $ref: '#/components/responses/Unauthorized'
7282 '403':
7283 $ref: '#/components/responses/Forbidden'
7284 '404':
7285 $ref: '#/components/responses/NotFound'
7286 '405':
7287 $ref: '#/components/responses/MethodNotAllowed'
7288 '406':
7289 $ref: '#/components/responses/NotAcceptable'
7290 '409':
7291 $ref: '#/components/responses/Conflict'
7292 '422':
7293 $ref: '#/components/responses/UnprocessableEntity'
7294 '500':
7295 $ref: '#/components/responses/InternalServerError'
7296 '503':
7297 $ref: '#/components/responses/ServiceUnavailable'
7298 '5XX':
7299 $ref: '#/components/responses/UnexpectedError'
7300 default:
7301 $ref: '#/components/responses/UnexpectedError'
7302 patch:
7303 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7304 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7305 - "Admin"
7306 summary: Modify a Project
7307 description: Modify a Project
7308 operationId: editProject
7309 requestBody:
7310 $ref: '#/components/requestBodies/EditProjectRequest'
7311 responses:
7312 '204':
7313 description: No Content
7314 '400':
7315 $ref: '#/components/responses/BadRequest'
7316 '401':
7317 $ref: '#/components/responses/Unauthorized'
7318 '403':
7319 $ref: '#/components/responses/Forbidden'
7320 '404':
7321 $ref: '#/components/responses/NotFound'
7322 '405':
7323 $ref: '#/components/responses/MethodNotAllowed'
7324 '406':
7325 $ref: '#/components/responses/NotAcceptable'
7326 '409':
7327 $ref: '#/components/responses/Conflict'
7328 '422':
7329 $ref: '#/components/responses/UnprocessableEntity'
7330 '500':
7331 $ref: '#/components/responses/InternalServerError'
7332 '503':
7333 $ref: '#/components/responses/ServiceUnavailable'
7334 '5XX':
7335 $ref: '#/components/responses/UnexpectedError'
7336 default:
7337 $ref: '#/components/responses/UnexpectedError'
7338 delete:
7339 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7340 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7341 - "Admin"
7342 summary: Delete a Project
7343 description: Delete a Project
7344 operationId: deleteProject
7345 responses:
7346 '204':
7347 description: No Content
7348 '400':
7349 $ref: '#/components/responses/BadRequest'
7350 '401':
7351 $ref: '#/components/responses/Unauthorized'
7352 '403':
7353 $ref: '#/components/responses/Forbidden'
7354 '404':
7355 $ref: '#/components/responses/NotFound'
7356 '405':
7357 $ref: '#/components/responses/MethodNotAllowed'
7358 '406':
7359 $ref: '#/components/responses/NotAcceptable'
7360 '409':
7361 $ref: '#/components/responses/Conflict'
7362 '422':
7363 $ref: '#/components/responses/UnprocessableEntity'
7364 '500':
7365 $ref: '#/components/responses/InternalServerError'
7366 '503':
7367 $ref: '#/components/responses/ServiceUnavailable'
7368 '5XX':
7369 $ref: '#/components/responses/UnexpectedError'
7370 default:
7371 $ref: '#/components/responses/UnexpectedError'
7372 '/admin/v1/roles':
7373 get:
7374 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7375 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7376 - "Admin"
7377 summary: Query information about multiple Roles
7378 description: Query information about multiple Roles
7379 operationId: getRoles
7380 responses:
7381 '200':
7382 description: OK
7383 content:
7384 application/json:
7385 schema:
7386 $ref: '#/components/schemas/ArrayOfRoleInfo'
7387 application/yaml:
7388 schema:
7389 $ref: '#/components/schemas/ArrayOfRoleInfo'
7390 '400':
7391 $ref: '#/components/responses/BadRequest'
7392 '401':
7393 $ref: '#/components/responses/Unauthorized'
7394 '403':
7395 $ref: '#/components/responses/Forbidden'
7396 '404':
7397 $ref: '#/components/responses/NotFound'
7398 '405':
7399 $ref: '#/components/responses/MethodNotAllowed'
7400 '406':
7401 $ref: '#/components/responses/NotAcceptable'
7402 '409':
7403 $ref: '#/components/responses/Conflict'
7404 '422':
7405 $ref: '#/components/responses/UnprocessableEntity'
7406 '500':
7407 $ref: '#/components/responses/InternalServerError'
7408 '503':
7409 $ref: '#/components/responses/ServiceUnavailable'
7410 '5XX':
7411 $ref: '#/components/responses/UnexpectedError'
7412 default:
7413 $ref: '#/components/responses/UnexpectedError'
7414 post:
7415 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7416 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7417 - "Admin"
7418 summary: Create a new Role
7419 description: Create a new Role
7420 operationId: createRole
7421 requestBody:
7422 $ref: '#/components/requestBodies/CreateRoleRequest'
7423 responses:
7424 '201':
7425 description: Created
7426 headers:
7427 Location:
7428 schema:
7429 type: string
7430 format: uri
7431 content:
7432 application/json:
7433 schema:
7434 $ref: '#/components/schemas/ObjectId'
7435 application/yaml:
7436 schema:
7437 $ref: '#/components/schemas/ObjectId'
7438 '400':
7439 $ref: '#/components/responses/BadRequest'
7440 '401':
7441 $ref: '#/components/responses/Unauthorized'
7442 '403':
7443 $ref: '#/components/responses/Forbidden'
7444 '404':
7445 $ref: '#/components/responses/NotFound'
7446 '405':
7447 $ref: '#/components/responses/MethodNotAllowed'
7448 '406':
7449 $ref: '#/components/responses/NotAcceptable'
7450 '409':
7451 $ref: '#/components/responses/Conflict'
7452 '422':
7453 $ref: '#/components/responses/UnprocessableEntity'
7454 '500':
7455 $ref: '#/components/responses/InternalServerError'
7456 '503':
7457 $ref: '#/components/responses/ServiceUnavailable'
7458 '5XX':
7459 $ref: '#/components/responses/UnexpectedError'
7460 default:
7461 $ref: '#/components/responses/UnexpectedError'
7462 '/admin/v1/roles/{roleId}':
7463 parameters:
7464 - name: roleId
7465 in: path
7466 required: true
7467 description: Role ID/Name
7468 schema:
7469 type: string
7470 get:
7471 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7472 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7473 - "Admin"
7474 summary: Query information about an individual Role
7475 description: Query information about an individual Role
7476 operationId: getRole
7477 responses:
7478 '200':
7479 description: OK
7480 content:
7481 application/json:
7482 schema:
7483 $ref: '#/components/schemas/RoleInfo'
7484 application/yaml:
7485 schema:
7486 $ref: '#/components/schemas/RoleInfo'
7487 '400':
7488 $ref: '#/components/responses/BadRequest'
7489 '401':
7490 $ref: '#/components/responses/Unauthorized'
7491 '403':
7492 $ref: '#/components/responses/Forbidden'
7493 '404':
7494 $ref: '#/components/responses/NotFound'
7495 '405':
7496 $ref: '#/components/responses/MethodNotAllowed'
7497 '406':
7498 $ref: '#/components/responses/NotAcceptable'
7499 '409':
7500 $ref: '#/components/responses/Conflict'
7501 '422':
7502 $ref: '#/components/responses/UnprocessableEntity'
7503 '500':
7504 $ref: '#/components/responses/InternalServerError'
7505 '503':
7506 $ref: '#/components/responses/ServiceUnavailable'
7507 '5XX':
7508 $ref: '#/components/responses/UnexpectedError'
7509 default:
7510 $ref: '#/components/responses/UnexpectedError'
7511 patch:
7512 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7513 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7514 - "Admin"
7515 summary: Modify a Role
7516 description: Modify a Role
7517 operationId: editRole
7518 requestBody:
7519 $ref: '#/components/requestBodies/EditRoleRequest'
7520 responses:
7521 '204':
7522 description: No Content
7523 '400':
7524 $ref: '#/components/responses/BadRequest'
7525 '401':
7526 $ref: '#/components/responses/Unauthorized'
7527 '403':
7528 $ref: '#/components/responses/Forbidden'
7529 '404':
7530 $ref: '#/components/responses/NotFound'
7531 '405':
7532 $ref: '#/components/responses/MethodNotAllowed'
7533 '406':
7534 $ref: '#/components/responses/NotAcceptable'
7535 '409':
7536 $ref: '#/components/responses/Conflict'
7537 '422':
7538 $ref: '#/components/responses/UnprocessableEntity'
7539 '500':
7540 $ref: '#/components/responses/InternalServerError'
7541 '503':
7542 $ref: '#/components/responses/ServiceUnavailable'
7543 '5XX':
7544 $ref: '#/components/responses/UnexpectedError'
7545 default:
7546 $ref: '#/components/responses/UnexpectedError'
7547 delete:
7548 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7549 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7550 - "Admin"
7551 summary: Delete a Role
7552 description: Delete a Role
7553 operationId: deleteRole
7554 responses:
7555 '204':
7556 description: No Content
7557 '400':
7558 $ref: '#/components/responses/BadRequest'
7559 '401':
7560 $ref: '#/components/responses/Unauthorized'
7561 '403':
7562 $ref: '#/components/responses/Forbidden'
7563 '404':
7564 $ref: '#/components/responses/NotFound'
7565 '405':
7566 $ref: '#/components/responses/MethodNotAllowed'
7567 '406':
7568 $ref: '#/components/responses/NotAcceptable'
7569 '409':
7570 $ref: '#/components/responses/Conflict'
7571 '422':
7572 $ref: '#/components/responses/UnprocessableEntity'
7573 '500':
7574 $ref: '#/components/responses/InternalServerError'
7575 '503':
7576 $ref: '#/components/responses/ServiceUnavailable'
7577 '5XX':
7578 $ref: '#/components/responses/UnexpectedError'
7579 default:
7580 $ref: '#/components/responses/UnexpectedError'
7581 '/admin/v1/vims':
7582 get:
7583 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7584 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7585 - "Admin"
7586 summary: Query information about multiple VIMs
7587 description: Query information about multiple VIMs
7588 operationId: getVIMs
7589 responses:
7590 '200':
7591 description: OK
7592 content:
7593 application/json:
7594 schema:
7595 $ref: '#/components/schemas/ArrayOfVimInfo'
7596 application/yaml:
7597 schema:
7598 $ref: '#/components/schemas/ArrayOfVimInfo'
7599 '400':
7600 $ref: '#/components/responses/BadRequest'
7601 '401':
7602 $ref: '#/components/responses/Unauthorized'
7603 '403':
7604 $ref: '#/components/responses/Forbidden'
7605 '404':
7606 $ref: '#/components/responses/NotFound'
7607 '405':
7608 $ref: '#/components/responses/MethodNotAllowed'
7609 '406':
7610 $ref: '#/components/responses/NotAcceptable'
7611 '409':
7612 $ref: '#/components/responses/Conflict'
7613 '422':
7614 $ref: '#/components/responses/UnprocessableEntity'
7615 '500':
7616 $ref: '#/components/responses/InternalServerError'
7617 '503':
7618 $ref: '#/components/responses/ServiceUnavailable'
7619 '5XX':
7620 $ref: '#/components/responses/UnexpectedError'
7621 default:
7622 $ref: '#/components/responses/UnexpectedError'
7623 post:
7624 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7625 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7626 - "Admin"
7627 summary: Create a new VIM
7628 description: Create a new VIM
7629 operationId: createVIM
7630 requestBody:
7631 $ref: '#/components/requestBodies/CreateVimRequest'
7632 responses:
7633 '202':
7634 description: Accepted
7635 content:
7636 application/json:
7637 schema:
7638 $ref: '#/components/schemas/ObjectId_plus_OpId'
7639 application/yaml:
7640 schema:
7641 $ref: '#/components/schemas/ObjectId_plus_OpId'
7642 '400':
7643 $ref: '#/components/responses/BadRequest'
7644 '401':
7645 $ref: '#/components/responses/Unauthorized'
7646 '403':
7647 $ref: '#/components/responses/Forbidden'
7648 '404':
7649 $ref: '#/components/responses/NotFound'
7650 '405':
7651 $ref: '#/components/responses/MethodNotAllowed'
7652 '406':
7653 $ref: '#/components/responses/NotAcceptable'
7654 '409':
7655 $ref: '#/components/responses/Conflict'
7656 '422':
7657 $ref: '#/components/responses/UnprocessableEntity'
7658 '500':
7659 $ref: '#/components/responses/InternalServerError'
7660 '503':
7661 $ref: '#/components/responses/ServiceUnavailable'
7662 '5XX':
7663 $ref: '#/components/responses/UnexpectedError'
7664 default:
7665 $ref: '#/components/responses/UnexpectedError'
7666 '/admin/v1/vims/{vimId}':
7667 parameters:
7668 - name: vimId
7669 in: path
7670 required: true
7671 description: VIM ID
7672 schema:
7673 type: string
7674 format: uuid
7675 get:
7676 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7677 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7678 - "Admin"
7679 summary: Query information about an individual VIM
7680 description: Query information about an individual VIM
7681 operationId: getVIM
7682 responses:
7683 '200':
7684 description: OK
7685 content:
7686 application/json:
7687 schema:
7688 $ref: '#/components/schemas/VimInfo'
7689 application/yaml:
7690 schema:
7691 $ref: '#/components/schemas/VimInfo'
7692 '400':
7693 $ref: '#/components/responses/BadRequest'
7694 '401':
7695 $ref: '#/components/responses/Unauthorized'
7696 '403':
7697 $ref: '#/components/responses/Forbidden'
7698 '404':
7699 $ref: '#/components/responses/NotFound'
7700 '405':
7701 $ref: '#/components/responses/MethodNotAllowed'
7702 '406':
7703 $ref: '#/components/responses/NotAcceptable'
7704 '409':
7705 $ref: '#/components/responses/Conflict'
7706 '422':
7707 $ref: '#/components/responses/UnprocessableEntity'
7708 '500':
7709 $ref: '#/components/responses/InternalServerError'
7710 '503':
7711 $ref: '#/components/responses/ServiceUnavailable'
7712 '5XX':
7713 $ref: '#/components/responses/UnexpectedError'
7714 default:
7715 $ref: '#/components/responses/UnexpectedError'
7716 patch:
7717 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7718 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7719 - "Admin"
7720 summary: Modify a VIM
7721 description: Modify a VIM
7722 operationId: editVIM
7723 requestBody:
7724 $ref: '#/components/requestBodies/EditVimRequest'
7725 responses:
7726 '202':
7727 description: Accepted
7728 content:
7729 application/json:
7730 schema:
7731 $ref: '#/components/schemas/OpId'
7732 application/yaml:
7733 schema:
7734 $ref: '#/components/schemas/OpId'
7735 '400':
7736 $ref: '#/components/responses/BadRequest'
7737 '401':
7738 $ref: '#/components/responses/Unauthorized'
7739 '403':
7740 $ref: '#/components/responses/Forbidden'
7741 '404':
7742 $ref: '#/components/responses/NotFound'
7743 '405':
7744 $ref: '#/components/responses/MethodNotAllowed'
7745 '406':
7746 $ref: '#/components/responses/NotAcceptable'
7747 '409':
7748 $ref: '#/components/responses/Conflict'
7749 '422':
7750 $ref: '#/components/responses/UnprocessableEntity'
7751 '500':
7752 $ref: '#/components/responses/InternalServerError'
7753 '503':
7754 $ref: '#/components/responses/ServiceUnavailable'
7755 '5XX':
7756 $ref: '#/components/responses/UnexpectedError'
7757 default:
7758 $ref: '#/components/responses/UnexpectedError'
7759 delete:
7760 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7761 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7762 - "Admin"
7763 summary: Delete a VIM
7764 description: Delete a VIM
7765 operationId: deleteVIM
7766 responses:
7767 '202':
7768 description: Accepted
7769 '400':
7770 $ref: '#/components/responses/BadRequest'
7771 '401':
7772 $ref: '#/components/responses/Unauthorized'
7773 '403':
7774 $ref: '#/components/responses/Forbidden'
7775 '404':
7776 $ref: '#/components/responses/NotFound'
7777 '405':
7778 $ref: '#/components/responses/MethodNotAllowed'
7779 '406':
7780 $ref: '#/components/responses/NotAcceptable'
7781 '409':
7782 $ref: '#/components/responses/Conflict'
7783 '422':
7784 $ref: '#/components/responses/UnprocessableEntity'
7785 '500':
7786 $ref: '#/components/responses/InternalServerError'
7787 '503':
7788 $ref: '#/components/responses/ServiceUnavailable'
7789 '5XX':
7790 $ref: '#/components/responses/UnexpectedError'
7791 default:
7792 $ref: '#/components/responses/UnexpectedError'
7793 '/admin/v1/vim_accounts':
7794 get:
7795 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7796 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7797 - "Admin"
7798 summary: Query information about multiple VIM Accounts
7799 description: Query information about multiple VIM Accounts
7800 operationId: getVimAccounts
7801 responses:
7802 '200':
7803 description: OK
7804 content:
7805 application/json:
7806 schema:
7807 $ref: '#/components/schemas/ArrayOfVimInfo'
7808 application/yaml:
7809 schema:
7810 $ref: '#/components/schemas/ArrayOfVimInfo'
7811 '400':
7812 $ref: '#/components/responses/BadRequest'
7813 '401':
7814 $ref: '#/components/responses/Unauthorized'
7815 '403':
7816 $ref: '#/components/responses/Forbidden'
7817 '404':
7818 $ref: '#/components/responses/NotFound'
7819 '405':
7820 $ref: '#/components/responses/MethodNotAllowed'
7821 '406':
7822 $ref: '#/components/responses/NotAcceptable'
7823 '409':
7824 $ref: '#/components/responses/Conflict'
7825 '422':
7826 $ref: '#/components/responses/UnprocessableEntity'
7827 '500':
7828 $ref: '#/components/responses/InternalServerError'
7829 '503':
7830 $ref: '#/components/responses/ServiceUnavailable'
7831 '5XX':
7832 $ref: '#/components/responses/UnexpectedError'
7833 default:
7834 $ref: '#/components/responses/UnexpectedError'
7835 post:
7836 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7837 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7838 - "Admin"
7839 summary: Create a new VIM Account
7840 description: Create a new VIM Account
7841 operationId: createVimAccount
7842 requestBody:
7843 $ref: '#/components/requestBodies/CreateVimRequest'
7844 responses:
7845 '202':
7846 description: Accepted
7847 content:
7848 application/json:
7849 schema:
7850 $ref: '#/components/schemas/ObjectId_plus_OpId'
7851 application/yaml:
7852 schema:
7853 $ref: '#/components/schemas/ObjectId_plus_OpId'
7854 '400':
7855 $ref: '#/components/responses/BadRequest'
7856 '401':
7857 $ref: '#/components/responses/Unauthorized'
7858 '403':
7859 $ref: '#/components/responses/Forbidden'
7860 '404':
7861 $ref: '#/components/responses/NotFound'
7862 '405':
7863 $ref: '#/components/responses/MethodNotAllowed'
7864 '406':
7865 $ref: '#/components/responses/NotAcceptable'
7866 '409':
7867 $ref: '#/components/responses/Conflict'
7868 '422':
7869 $ref: '#/components/responses/UnprocessableEntity'
7870 '500':
7871 $ref: '#/components/responses/InternalServerError'
7872 '503':
7873 $ref: '#/components/responses/ServiceUnavailable'
7874 '5XX':
7875 $ref: '#/components/responses/UnexpectedError'
7876 default:
7877 $ref: '#/components/responses/UnexpectedError'
7878 '/admin/v1/vim_accounts/{vimAccountId}':
7879 parameters:
7880 - name: vimAccountId
7881 in: path
7882 required: true
7883 description: VIM Account ID
7884 schema:
7885 type: string
7886 format: uuid
7887 get:
7888 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7889 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7890 - "Admin"
7891 summary: Query information about an individual VIM Account
7892 description: Query information about an individual VIM Account
7893 operationId: getVimAccount
7894 responses:
7895 '200':
7896 description: OK
7897 content:
7898 application/json:
7899 schema:
7900 $ref: '#/components/schemas/VimInfo'
7901 application/yaml:
7902 schema:
7903 $ref: '#/components/schemas/VimInfo'
7904 '400':
7905 $ref: '#/components/responses/BadRequest'
7906 '401':
7907 $ref: '#/components/responses/Unauthorized'
7908 '403':
7909 $ref: '#/components/responses/Forbidden'
7910 '404':
7911 $ref: '#/components/responses/NotFound'
7912 '405':
7913 $ref: '#/components/responses/MethodNotAllowed'
7914 '406':
7915 $ref: '#/components/responses/NotAcceptable'
7916 '409':
7917 $ref: '#/components/responses/Conflict'
7918 '422':
7919 $ref: '#/components/responses/UnprocessableEntity'
7920 '500':
7921 $ref: '#/components/responses/InternalServerError'
7922 '503':
7923 $ref: '#/components/responses/ServiceUnavailable'
7924 '5XX':
7925 $ref: '#/components/responses/UnexpectedError'
7926 default:
7927 $ref: '#/components/responses/UnexpectedError'
7928 patch:
7929 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7930 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7931 - "Admin"
7932 summary: Modify a VIM Account
7933 description: Modify a VIM Account
7934 operationId: editVimAccount
7935 requestBody:
7936 $ref: '#/components/requestBodies/EditVimRequest'
7937 responses:
7938 '202':
7939 description: Accepted
7940 content:
7941 application/json:
7942 schema:
7943 $ref: '#/components/schemas/OpId'
7944 application/yaml:
7945 schema:
7946 $ref: '#/components/schemas/OpId'
7947 '400':
7948 $ref: '#/components/responses/BadRequest'
7949 '401':
7950 $ref: '#/components/responses/Unauthorized'
7951 '403':
7952 $ref: '#/components/responses/Forbidden'
7953 '404':
7954 $ref: '#/components/responses/NotFound'
7955 '405':
7956 $ref: '#/components/responses/MethodNotAllowed'
7957 '406':
7958 $ref: '#/components/responses/NotAcceptable'
7959 '409':
7960 $ref: '#/components/responses/Conflict'
7961 '422':
7962 $ref: '#/components/responses/UnprocessableEntity'
7963 '500':
7964 $ref: '#/components/responses/InternalServerError'
7965 '503':
7966 $ref: '#/components/responses/ServiceUnavailable'
7967 '5XX':
7968 $ref: '#/components/responses/UnexpectedError'
7969 default:
7970 $ref: '#/components/responses/UnexpectedError'
7971 delete:
7972 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]7973 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]7974 - "Admin"
7975 summary: Delete a VIM Account
7976 description: Delete a VIM Account
7977 operationId: deleteVimAccount
7978 responses:
7979 '202':
7980 description: Accepted
7981 '400':
7982 $ref: '#/components/responses/BadRequest'
7983 '401':
7984 $ref: '#/components/responses/Unauthorized'
7985 '403':
7986 $ref: '#/components/responses/Forbidden'
7987 '404':
7988 $ref: '#/components/responses/NotFound'
7989 '405':
7990 $ref: '#/components/responses/MethodNotAllowed'
7991 '406':
7992 $ref: '#/components/responses/NotAcceptable'
7993 '409':
7994 $ref: '#/components/responses/Conflict'
7995 '422':
7996 $ref: '#/components/responses/UnprocessableEntity'
7997 '500':
7998 $ref: '#/components/responses/InternalServerError'
7999 '503':
8000 $ref: '#/components/responses/ServiceUnavailable'
8001 '5XX':
8002 $ref: '#/components/responses/UnexpectedError'
8003 default:
8004 $ref: '#/components/responses/UnexpectedError'
8005 '/admin/v1/wim_accounts':
8006 get:
8007 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8008 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8009 - "Admin"
8010 summary: Query information about multiple WIM Accounts
8011 description: Query information about multiple WIM Accounts
8012 operationId: getWimAccounts
8013 responses:
8014 '200':
8015 description: OK
8016 content:
8017 application/json:
8018 schema:
8019 $ref: '#/components/schemas/ArrayOfWimInfo'
8020 application/yaml:
8021 schema:
8022 $ref: '#/components/schemas/ArrayOfWimInfo'
8023 '400':
8024 $ref: '#/components/responses/BadRequest'
8025 '401':
8026 $ref: '#/components/responses/Unauthorized'
8027 '403':
8028 $ref: '#/components/responses/Forbidden'
8029 '404':
8030 $ref: '#/components/responses/NotFound'
8031 '405':
8032 $ref: '#/components/responses/MethodNotAllowed'
8033 '406':
8034 $ref: '#/components/responses/NotAcceptable'
8035 '409':
8036 $ref: '#/components/responses/Conflict'
8037 '422':
8038 $ref: '#/components/responses/UnprocessableEntity'
8039 '500':
8040 $ref: '#/components/responses/InternalServerError'
8041 '503':
8042 $ref: '#/components/responses/ServiceUnavailable'
8043 '5XX':
8044 $ref: '#/components/responses/UnexpectedError'
8045 default:
8046 $ref: '#/components/responses/UnexpectedError'
8047 post:
8048 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8049 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8050 - "Admin"
8051 summary: Create a new WIM Account
8052 description: Create a new WIM Account
8053 operationId: createWimAccount
8054 requestBody:
8055 $ref: '#/components/requestBodies/CreateWimRequest'
8056 responses:
8057 '202':
8058 description: Accepted
8059 content:
8060 application/json:
8061 schema:
8062 $ref: '#/components/schemas/ObjectId_plus_OpId'
8063 application/yaml:
8064 schema:
8065 $ref: '#/components/schemas/ObjectId_plus_OpId'
8066 '400':
8067 $ref: '#/components/responses/BadRequest'
8068 '401':
8069 $ref: '#/components/responses/Unauthorized'
8070 '403':
8071 $ref: '#/components/responses/Forbidden'
8072 '404':
8073 $ref: '#/components/responses/NotFound'
8074 '405':
8075 $ref: '#/components/responses/MethodNotAllowed'
8076 '406':
8077 $ref: '#/components/responses/NotAcceptable'
8078 '409':
8079 $ref: '#/components/responses/Conflict'
8080 '422':
8081 $ref: '#/components/responses/UnprocessableEntity'
8082 '500':
8083 $ref: '#/components/responses/InternalServerError'
8084 '503':
8085 $ref: '#/components/responses/ServiceUnavailable'
8086 '5XX':
8087 $ref: '#/components/responses/UnexpectedError'
8088 default:
8089 $ref: '#/components/responses/UnexpectedError'
8090 '/admin/v1/wim_accounts/{wimAccountId}':
8091 parameters:
8092 - name: wimAccountId
8093 in: path
8094 required: true
8095 description: WIM Account ID
8096 schema:
8097 type: string
8098 format: uuid
8099 get:
8100 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8101 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8102 - "Admin"
8103 summary: Query information about an individual WIM Account
8104 description: Query information about an individual WIM Account
8105 operationId: getWimAccount
8106 responses:
8107 '200':
8108 description: OK
8109 content:
8110 application/json:
8111 schema:
8112 $ref: '#/components/schemas/WimInfo'
8113 application/yaml:
8114 schema:
8115 $ref: '#/components/schemas/WimInfo'
8116 '400':
8117 $ref: '#/components/responses/BadRequest'
8118 '401':
8119 $ref: '#/components/responses/Unauthorized'
8120 '403':
8121 $ref: '#/components/responses/Forbidden'
8122 '404':
8123 $ref: '#/components/responses/NotFound'
8124 '405':
8125 $ref: '#/components/responses/MethodNotAllowed'
8126 '406':
8127 $ref: '#/components/responses/NotAcceptable'
8128 '409':
8129 $ref: '#/components/responses/Conflict'
8130 '422':
8131 $ref: '#/components/responses/UnprocessableEntity'
8132 '500':
8133 $ref: '#/components/responses/InternalServerError'
8134 '503':
8135 $ref: '#/components/responses/ServiceUnavailable'
8136 '5XX':
8137 $ref: '#/components/responses/UnexpectedError'
8138 default:
8139 $ref: '#/components/responses/UnexpectedError'
8140 patch:
8141 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8142 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8143 - "Admin"
8144 summary: Modify a WIM Account
8145 description: Modify a WIM Account
8146 operationId: editWimAccount
8147 requestBody:
8148 $ref: '#/components/requestBodies/EditWimRequest'
8149 responses:
8150 '202':
8151 description: Accepted
8152 content:
8153 application/json:
8154 schema:
8155 $ref: '#/components/schemas/OpId'
8156 application/yaml:
8157 schema:
8158 $ref: '#/components/schemas/OpId'
8159 '400':
8160 $ref: '#/components/responses/BadRequest'
8161 '401':
8162 $ref: '#/components/responses/Unauthorized'
8163 '403':
8164 $ref: '#/components/responses/Forbidden'
8165 '404':
8166 $ref: '#/components/responses/NotFound'
8167 '405':
8168 $ref: '#/components/responses/MethodNotAllowed'
8169 '406':
8170 $ref: '#/components/responses/NotAcceptable'
8171 '409':
8172 $ref: '#/components/responses/Conflict'
8173 '422':
8174 $ref: '#/components/responses/UnprocessableEntity'
8175 '500':
8176 $ref: '#/components/responses/InternalServerError'
8177 '503':
8178 $ref: '#/components/responses/ServiceUnavailable'
8179 '5XX':
8180 $ref: '#/components/responses/UnexpectedError'
8181 default:
8182 $ref: '#/components/responses/UnexpectedError'
8183 delete:
8184 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8185 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8186 - "Admin"
8187 summary: Delete a WIM Account
8188 description: Delete a WIM Account
8189 operationId: deleteWimAccount
8190 responses:
8191 '202':
8192 description: Accepted
8193 '400':
8194 $ref: '#/components/responses/BadRequest'
8195 '401':
8196 $ref: '#/components/responses/Unauthorized'
8197 '403':
8198 $ref: '#/components/responses/Forbidden'
8199 '404':
8200 $ref: '#/components/responses/NotFound'
8201 '405':
8202 $ref: '#/components/responses/MethodNotAllowed'
8203 '406':
8204 $ref: '#/components/responses/NotAcceptable'
8205 '409':
8206 $ref: '#/components/responses/Conflict'
8207 '422':
8208 $ref: '#/components/responses/UnprocessableEntity'
8209 '500':
8210 $ref: '#/components/responses/InternalServerError'
8211 '503':
8212 $ref: '#/components/responses/ServiceUnavailable'
8213 '5XX':
8214 $ref: '#/components/responses/UnexpectedError'
8215 default:
8216 $ref: '#/components/responses/UnexpectedError'
8217 '/admin/v1/sdns':
8218 get:
8219 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8220 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8221 - "Admin"
8222 summary: Query information about multiple SDNs
8223 description: Query information about multiple SDNs
8224 operationId: getSDNs
8225 responses:
8226 '200':
8227 description: OK
8228 content:
8229 application/json:
8230 schema:
8231 $ref: '#/components/schemas/ArrayOfSdnInfo'
8232 application/yaml:
8233 schema:
8234 $ref: '#/components/schemas/ArrayOfSdnInfo'
8235 '400':
8236 $ref: '#/components/responses/BadRequest'
8237 '401':
8238 $ref: '#/components/responses/Unauthorized'
8239 '403':
8240 $ref: '#/components/responses/Forbidden'
8241 '404':
8242 $ref: '#/components/responses/NotFound'
8243 '405':
8244 $ref: '#/components/responses/MethodNotAllowed'
8245 '406':
8246 $ref: '#/components/responses/NotAcceptable'
8247 '409':
8248 $ref: '#/components/responses/Conflict'
8249 '422':
8250 $ref: '#/components/responses/UnprocessableEntity'
8251 '500':
8252 $ref: '#/components/responses/InternalServerError'
8253 '503':
8254 $ref: '#/components/responses/ServiceUnavailable'
8255 '5XX':
8256 $ref: '#/components/responses/UnexpectedError'
8257 default:
8258 $ref: '#/components/responses/UnexpectedError'
8259 post:
8260 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8261 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8262 - "Admin"
8263 summary: Create a new SDN
8264 description: Create a new SDN
8265 operationId: createSDN
8266 requestBody:
8267 $ref: '#/components/requestBodies/CreateSdnRequest'
8268 responses:
8269 '202':
8270 description: Accepted
8271 content:
8272 application/json:
8273 schema:
8274 $ref: '#/components/schemas/ObjectId_plus_OpId'
8275 application/yaml:
8276 schema:
8277 $ref: '#/components/schemas/ObjectId_plus_OpId'
8278 '400':
8279 $ref: '#/components/responses/BadRequest'
8280 '401':
8281 $ref: '#/components/responses/Unauthorized'
8282 '403':
8283 $ref: '#/components/responses/Forbidden'
8284 '404':
8285 $ref: '#/components/responses/NotFound'
8286 '405':
8287 $ref: '#/components/responses/MethodNotAllowed'
8288 '406':
8289 $ref: '#/components/responses/NotAcceptable'
8290 '409':
8291 $ref: '#/components/responses/Conflict'
8292 '422':
8293 $ref: '#/components/responses/UnprocessableEntity'
8294 '500':
8295 $ref: '#/components/responses/InternalServerError'
8296 '503':
8297 $ref: '#/components/responses/ServiceUnavailable'
8298 '5XX':
8299 $ref: '#/components/responses/UnexpectedError'
8300 default:
8301 $ref: '#/components/responses/UnexpectedError'
8302 '/admin/v1/sdns/{sdnId}':
8303 parameters:
8304 - name: sdnId
8305 in: path
8306 required: true
8307 description: SDN ID
8308 schema:
8309 type: string
8310 format: uuid
8311 get:
8312 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8313 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8314 - "Admin"
8315 summary: Query information about an individual SDN
8316 description: Query information about an individual SDN
8317 operationId: getSDN
8318 responses:
8319 '200':
8320 description: OK
8321 content:
8322 application/json:
8323 schema:
8324 $ref: '#/components/schemas/SdnInfo'
8325 application/yaml:
8326 schema:
8327 $ref: '#/components/schemas/SdnInfo'
8328 '400':
8329 $ref: '#/components/responses/BadRequest'
8330 '401':
8331 $ref: '#/components/responses/Unauthorized'
8332 '403':
8333 $ref: '#/components/responses/Forbidden'
8334 '404':
8335 $ref: '#/components/responses/NotFound'
8336 '405':
8337 $ref: '#/components/responses/MethodNotAllowed'
8338 '406':
8339 $ref: '#/components/responses/NotAcceptable'
8340 '409':
8341 $ref: '#/components/responses/Conflict'
8342 '422':
8343 $ref: '#/components/responses/UnprocessableEntity'
8344 '500':
8345 $ref: '#/components/responses/InternalServerError'
8346 '503':
8347 $ref: '#/components/responses/ServiceUnavailable'
8348 '5XX':
8349 $ref: '#/components/responses/UnexpectedError'
8350 default:
8351 $ref: '#/components/responses/UnexpectedError'
8352 patch:
8353 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8354 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8355 - "Admin"
8356 summary: Modify a SDN
8357 description: Modify a SDN
8358 operationId: editSDN
8359 requestBody:
8360 $ref: '#/components/requestBodies/EditSdnRequest'
8361 responses:
8362 '202':
8363 description: Accepted
8364 content:
8365 application/json:
8366 schema:
8367 $ref: '#/components/schemas/OpId'
8368 application/yaml:
8369 schema:
8370 $ref: '#/components/schemas/OpId'
8371 '400':
8372 $ref: '#/components/responses/BadRequest'
8373 '401':
8374 $ref: '#/components/responses/Unauthorized'
8375 '403':
8376 $ref: '#/components/responses/Forbidden'
8377 '404':
8378 $ref: '#/components/responses/NotFound'
8379 '405':
8380 $ref: '#/components/responses/MethodNotAllowed'
8381 '406':
8382 $ref: '#/components/responses/NotAcceptable'
8383 '409':
8384 $ref: '#/components/responses/Conflict'
8385 '422':
8386 $ref: '#/components/responses/UnprocessableEntity'
8387 '500':
8388 $ref: '#/components/responses/InternalServerError'
8389 '503':
8390 $ref: '#/components/responses/ServiceUnavailable'
8391 '5XX':
8392 $ref: '#/components/responses/UnexpectedError'
8393 default:
8394 $ref: '#/components/responses/UnexpectedError'
8395 delete:
8396 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8397 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8398 - "Admin"
8399 summary: Delete a SDN
8400 description: Delete a SDN
8401 operationId: deleteSDN
8402 responses:
8403 '202':
8404 description: Accepted
8405 '400':
8406 $ref: '#/components/responses/BadRequest'
8407 '401':
8408 $ref: '#/components/responses/Unauthorized'
8409 '403':
8410 $ref: '#/components/responses/Forbidden'
8411 '404':
8412 $ref: '#/components/responses/NotFound'
8413 '405':
8414 $ref: '#/components/responses/MethodNotAllowed'
8415 '406':
8416 $ref: '#/components/responses/NotAcceptable'
8417 '409':
8418 $ref: '#/components/responses/Conflict'
8419 '422':
8420 $ref: '#/components/responses/UnprocessableEntity'
8421 '500':
8422 $ref: '#/components/responses/InternalServerError'
8423 '503':
8424 $ref: '#/components/responses/ServiceUnavailable'
8425 '5XX':
8426 $ref: '#/components/responses/UnexpectedError'
8427 default:
8428 $ref: '#/components/responses/UnexpectedError'
8429 '/admin/v1/k8sclusters':
8430 get:
8431 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8432 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8433 - "Admin"
8434 summary: Query information about multiple K8s Clusters
8435 description: Query information about multiple K8s Clusters
8436 operationId: getK8sClusters
8437 responses:
8438 '200':
8439 description: OK
8440 content:
8441 application/json:
8442 schema:
8443 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
8444 application/yaml:
8445 schema:
8446 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
8447 '400':
8448 $ref: '#/components/responses/BadRequest'
8449 '401':
8450 $ref: '#/components/responses/Unauthorized'
8451 '403':
8452 $ref: '#/components/responses/Forbidden'
8453 '404':
8454 $ref: '#/components/responses/NotFound'
8455 '405':
8456 $ref: '#/components/responses/MethodNotAllowed'
8457 '406':
8458 $ref: '#/components/responses/NotAcceptable'
8459 '409':
8460 $ref: '#/components/responses/Conflict'
8461 '422':
8462 $ref: '#/components/responses/UnprocessableEntity'
8463 '500':
8464 $ref: '#/components/responses/InternalServerError'
8465 '503':
8466 $ref: '#/components/responses/ServiceUnavailable'
8467 '5XX':
8468 $ref: '#/components/responses/UnexpectedError'
8469 default:
8470 $ref: '#/components/responses/UnexpectedError'
8471 post:
8472 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8473 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8474 - "Admin"
8475 summary: Create a new K8s Cluster
8476 description: Create a new K8s Cluster
8477 operationId: createK8sCluster
8478 requestBody:
8479 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
8480 responses:
8481 '202':
8482 description: Accepted
8483 content:
8484 application/json:
8485 schema:
8486 $ref: '#/components/schemas/ObjectId_plus_OpId'
8487 application/yaml:
8488 schema:
8489 $ref: '#/components/schemas/ObjectId_plus_OpId'
8490 '400':
8491 $ref: '#/components/responses/BadRequest'
8492 '401':
8493 $ref: '#/components/responses/Unauthorized'
8494 '403':
8495 $ref: '#/components/responses/Forbidden'
8496 '404':
8497 $ref: '#/components/responses/NotFound'
8498 '405':
8499 $ref: '#/components/responses/MethodNotAllowed'
8500 '406':
8501 $ref: '#/components/responses/NotAcceptable'
8502 '409':
8503 $ref: '#/components/responses/Conflict'
8504 '422':
8505 $ref: '#/components/responses/UnprocessableEntity'
8506 '500':
8507 $ref: '#/components/responses/InternalServerError'
8508 '503':
8509 $ref: '#/components/responses/ServiceUnavailable'
8510 '5XX':
8511 $ref: '#/components/responses/UnexpectedError'
8512 default:
8513 $ref: '#/components/responses/UnexpectedError'
8514 '/admin/v1/k8sclusters/{k8sClusterId}':
8515 parameters:
8516 - name: k8sClusterId
8517 in: path
8518 required: true
8519 description: K8s Cluster ID
8520 schema:
8521 type: string
8522 format: uuid
8523 get:
8524 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8525 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8526 - "Admin"
8527 summary: Query information about an individual K8s Cluster
8528 description: Query information about an individual K8s Cluster
8529 operationId: getK8sCluster
8530 responses:
8531 '200':
8532 description: OK
8533 content:
8534 application/json:
8535 schema:
8536 $ref: '#/components/schemas/K8sClusterInfo'
8537 application/yaml:
8538 schema:
8539 $ref: '#/components/schemas/K8sClusterInfo'
8540 '400':
8541 $ref: '#/components/responses/BadRequest'
8542 '401':
8543 $ref: '#/components/responses/Unauthorized'
8544 '403':
8545 $ref: '#/components/responses/Forbidden'
8546 '404':
8547 $ref: '#/components/responses/NotFound'
8548 '405':
8549 $ref: '#/components/responses/MethodNotAllowed'
8550 '406':
8551 $ref: '#/components/responses/NotAcceptable'
8552 '409':
8553 $ref: '#/components/responses/Conflict'
8554 '422':
8555 $ref: '#/components/responses/UnprocessableEntity'
8556 '500':
8557 $ref: '#/components/responses/InternalServerError'
8558 '503':
8559 $ref: '#/components/responses/ServiceUnavailable'
8560 '5XX':
8561 $ref: '#/components/responses/UnexpectedError'
8562 default:
8563 $ref: '#/components/responses/UnexpectedError'
8564 patch:
8565 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8566 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8567 - "Admin"
8568 summary: Modify a K8s Cluster
8569 description: Modify a K8s Cluster
8570 operationId: editK8sCluster
8571 requestBody:
8572 $ref: '#/components/requestBodies/EditK8sClusterRequest'
8573 responses:
8574 '202':
8575 description: Accepted
8576 content:
8577 application/json:
8578 schema:
8579 $ref: '#/components/schemas/OpId'
8580 application/yaml:
8581 schema:
8582 $ref: '#/components/schemas/OpId'
8583 '400':
8584 $ref: '#/components/responses/BadRequest'
8585 '401':
8586 $ref: '#/components/responses/Unauthorized'
8587 '403':
8588 $ref: '#/components/responses/Forbidden'
8589 '404':
8590 $ref: '#/components/responses/NotFound'
8591 '405':
8592 $ref: '#/components/responses/MethodNotAllowed'
8593 '406':
8594 $ref: '#/components/responses/NotAcceptable'
8595 '409':
8596 $ref: '#/components/responses/Conflict'
8597 '422':
8598 $ref: '#/components/responses/UnprocessableEntity'
8599 '500':
8600 $ref: '#/components/responses/InternalServerError'
8601 '503':
8602 $ref: '#/components/responses/ServiceUnavailable'
8603 '5XX':
8604 $ref: '#/components/responses/UnexpectedError'
8605 default:
8606 $ref: '#/components/responses/UnexpectedError'
8607 delete:
8608 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8609 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8610 - "Admin"
8611 summary: Delete a K8s Cluster
8612 description: Delete a K8s Cluster
8613 operationId: deleteK8sCluster
8614 responses:
8615 '202':
8616 description: Accepted
8617 '400':
8618 $ref: '#/components/responses/BadRequest'
8619 '401':
8620 $ref: '#/components/responses/Unauthorized'
8621 '403':
8622 $ref: '#/components/responses/Forbidden'
8623 '404':
8624 $ref: '#/components/responses/NotFound'
8625 '405':
8626 $ref: '#/components/responses/MethodNotAllowed'
8627 '406':
8628 $ref: '#/components/responses/NotAcceptable'
8629 '409':
8630 $ref: '#/components/responses/Conflict'
8631 '422':
8632 $ref: '#/components/responses/UnprocessableEntity'
8633 '500':
8634 $ref: '#/components/responses/InternalServerError'
8635 '503':
8636 $ref: '#/components/responses/ServiceUnavailable'
8637 '5XX':
8638 $ref: '#/components/responses/UnexpectedError'
8639 default:
8640 $ref: '#/components/responses/UnexpectedError'
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]8641 '/admin/v1/vca':
8642 get:
8643 tags:
8644 - "Infrastructure"
8645 - "Admin"
8646 summary: Query information about multiple VCAs
8647 description: Query information about multiple VCAs
8648 operationId: getVcas
8649 responses:
8650 '200':
8651 description: OK
8652 content:
8653 application/json:
8654 schema:
8655 $ref: '#/components/schemas/ArrayOfVcaInfo'
8656 application/yaml:
8657 schema:
8658 $ref: '#/components/schemas/ArrayOfVcaInfo'
8659 '400':
8660 $ref: '#/components/responses/BadRequest'
8661 '401':
8662 $ref: '#/components/responses/Unauthorized'
8663 '403':
8664 $ref: '#/components/responses/Forbidden'
8665 '404':
8666 $ref: '#/components/responses/NotFound'
8667 '405':
8668 $ref: '#/components/responses/MethodNotAllowed'
8669 '406':
8670 $ref: '#/components/responses/NotAcceptable'
8671 '409':
8672 $ref: '#/components/responses/Conflict'
8673 '422':
8674 $ref: '#/components/responses/UnprocessableEntity'
8675 '500':
8676 $ref: '#/components/responses/InternalServerError'
8677 '503':
8678 $ref: '#/components/responses/ServiceUnavailable'
8679 '5XX':
8680 $ref: '#/components/responses/UnexpectedError'
8681 default:
8682 $ref: '#/components/responses/UnexpectedError'
8683 post:
8684 tags:
8685 - "Infrastructure"
8686 - "Admin"
8687 summary: Create a new VCA
8688 description: Create a new VCA
8689 operationId: createVca
8690 requestBody:
8691 $ref: '#/components/requestBodies/CreateVcaRequest'
8692 responses:
8693 '202':
8694 description: Accepted
8695 content:
8696 application/json:
8697 schema:
8698 $ref: '#/components/schemas/ObjectId_plus_OpId'
8699 application/yaml:
8700 schema:
8701 $ref: '#/components/schemas/ObjectId_plus_OpId'
8702 '400':
8703 $ref: '#/components/responses/BadRequest'
8704 '401':
8705 $ref: '#/components/responses/Unauthorized'
8706 '403':
8707 $ref: '#/components/responses/Forbidden'
8708 '404':
8709 $ref: '#/components/responses/NotFound'
8710 '405':
8711 $ref: '#/components/responses/MethodNotAllowed'
8712 '406':
8713 $ref: '#/components/responses/NotAcceptable'
8714 '409':
8715 $ref: '#/components/responses/Conflict'
8716 '422':
8717 $ref: '#/components/responses/UnprocessableEntity'
8718 '500':
8719 $ref: '#/components/responses/InternalServerError'
8720 '503':
8721 $ref: '#/components/responses/ServiceUnavailable'
8722 '5XX':
8723 $ref: '#/components/responses/UnexpectedError'
8724 default:
8725 $ref: '#/components/responses/UnexpectedError'
8726 '/admin/v1/vca/{vcaId}':
8727 parameters:
8728 - name: vcaId
8729 in: path
8730 required: true
8731 description: VCA ID
8732 schema:
8733 type: string
8734 format: uuid
8735 get:
8736 tags:
8737 - "Infrastructure"
8738 - "Admin"
8739 summary: Query information about an individual VCA
8740 description: Query information about an individual VCA
8741 operationId: getVca
8742 responses:
8743 '200':
8744 description: OK
8745 content:
8746 application/json:
8747 schema:
8748 $ref: '#/components/schemas/VcaInfo'
8749 application/yaml:
8750 schema:
8751 $ref: '#/components/schemas/VcaInfo'
8752 '400':
8753 $ref: '#/components/responses/BadRequest'
8754 '401':
8755 $ref: '#/components/responses/Unauthorized'
8756 '403':
8757 $ref: '#/components/responses/Forbidden'
8758 '404':
8759 $ref: '#/components/responses/NotFound'
8760 '405':
8761 $ref: '#/components/responses/MethodNotAllowed'
8762 '406':
8763 $ref: '#/components/responses/NotAcceptable'
8764 '409':
8765 $ref: '#/components/responses/Conflict'
8766 '422':
8767 $ref: '#/components/responses/UnprocessableEntity'
8768 '500':
8769 $ref: '#/components/responses/InternalServerError'
8770 '503':
8771 $ref: '#/components/responses/ServiceUnavailable'
8772 '5XX':
8773 $ref: '#/components/responses/UnexpectedError'
8774 default:
8775 $ref: '#/components/responses/UnexpectedError'
8776 patch:
8777 tags:
8778 - "Infrastructure"
8779 - "Admin"
8780 summary: Modify a VCA
8781 description: Modify a VCA
8782 operationId: editVca
8783 requestBody:
8784 $ref: '#/components/requestBodies/EditVcaRequest'
8785 responses:
8786 '202':
8787 description: Accepted
8788 content:
8789 application/json:
8790 schema:
8791 $ref: '#/components/schemas/OpId'
8792 application/yaml:
8793 schema:
8794 $ref: '#/components/schemas/OpId'
8795 '400':
8796 $ref: '#/components/responses/BadRequest'
8797 '401':
8798 $ref: '#/components/responses/Unauthorized'
8799 '403':
8800 $ref: '#/components/responses/Forbidden'
8801 '404':
8802 $ref: '#/components/responses/NotFound'
8803 '405':
8804 $ref: '#/components/responses/MethodNotAllowed'
8805 '406':
8806 $ref: '#/components/responses/NotAcceptable'
8807 '409':
8808 $ref: '#/components/responses/Conflict'
8809 '422':
8810 $ref: '#/components/responses/UnprocessableEntity'
8811 '500':
8812 $ref: '#/components/responses/InternalServerError'
8813 '503':
8814 $ref: '#/components/responses/ServiceUnavailable'
8815 '5XX':
8816 $ref: '#/components/responses/UnexpectedError'
8817 default:
8818 $ref: '#/components/responses/UnexpectedError'
8819 delete:
8820 tags:
8821 - "Infrastructure"
8822 - "Admin"
8823 summary: Delete a VCA
8824 description: Delete a VCA
8825 operationId: deleteVca
8826 responses:
8827 '202':
8828 description: Accepted
8829 '400':
8830 $ref: '#/components/responses/BadRequest'
8831 '401':
8832 $ref: '#/components/responses/Unauthorized'
8833 '403':
8834 $ref: '#/components/responses/Forbidden'
8835 '404':
8836 $ref: '#/components/responses/NotFound'
8837 '405':
8838 $ref: '#/components/responses/MethodNotAllowed'
8839 '406':
8840 $ref: '#/components/responses/NotAcceptable'
8841 '409':
8842 $ref: '#/components/responses/Conflict'
8843 '422':
8844 $ref: '#/components/responses/UnprocessableEntity'
8845 '500':
8846 $ref: '#/components/responses/InternalServerError'
8847 '503':
8848 $ref: '#/components/responses/ServiceUnavailable'
8849 '5XX':
8850 $ref: '#/components/responses/UnexpectedError'
8851 default:
8852 $ref: '#/components/responses/UnexpectedError'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8853 '/admin/v1/k8srepos':
8854 get:
8855 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8856 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8857 - "Admin"
8858 summary: Query information about multiple K8s Repos
8859 description: Query information about multiple K8s Repos
8860 operationId: getK8sRepos
8861 responses:
8862 '200':
8863 description: OK
8864 content:
8865 application/json:
8866 schema:
8867 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
8868 application/yaml:
8869 schema:
8870 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
8871 '400':
8872 $ref: '#/components/responses/BadRequest'
8873 '401':
8874 $ref: '#/components/responses/Unauthorized'
8875 '403':
8876 $ref: '#/components/responses/Forbidden'
8877 '404':
8878 $ref: '#/components/responses/NotFound'
8879 '405':
8880 $ref: '#/components/responses/MethodNotAllowed'
8881 '406':
8882 $ref: '#/components/responses/NotAcceptable'
8883 '409':
8884 $ref: '#/components/responses/Conflict'
8885 '422':
8886 $ref: '#/components/responses/UnprocessableEntity'
8887 '500':
8888 $ref: '#/components/responses/InternalServerError'
8889 '503':
8890 $ref: '#/components/responses/ServiceUnavailable'
8891 '5XX':
8892 $ref: '#/components/responses/UnexpectedError'
8893 default:
8894 $ref: '#/components/responses/UnexpectedError'
8895 post:
8896 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8897 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8898 - "Admin"
8899 summary: Create a new K8s Repo
8900 description: Create a new K8s Repo
8901 operationId: createK8sRepo
8902 requestBody:
8903 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
8904 responses:
8905 '202':
8906 description: Accepted
8907 content:
8908 application/json:
8909 schema:
8910 $ref: '#/components/schemas/ObjectId_plus_OpId'
8911 application/yaml:
8912 schema:
8913 $ref: '#/components/schemas/ObjectId_plus_OpId'
8914 '400':
8915 $ref: '#/components/responses/BadRequest'
8916 '401':
8917 $ref: '#/components/responses/Unauthorized'
8918 '403':
8919 $ref: '#/components/responses/Forbidden'
8920 '404':
8921 $ref: '#/components/responses/NotFound'
8922 '405':
8923 $ref: '#/components/responses/MethodNotAllowed'
8924 '406':
8925 $ref: '#/components/responses/NotAcceptable'
8926 '409':
8927 $ref: '#/components/responses/Conflict'
8928 '422':
8929 $ref: '#/components/responses/UnprocessableEntity'
8930 '500':
8931 $ref: '#/components/responses/InternalServerError'
8932 '503':
8933 $ref: '#/components/responses/ServiceUnavailable'
8934 '5XX':
8935 $ref: '#/components/responses/UnexpectedError'
8936 default:
8937 $ref: '#/components/responses/UnexpectedError'
8938 '/admin/v1/k8srepos/{k8sRepoId}':
8939 parameters:
8940 - name: k8sRepoId
8941 in: path
8942 required: true
8943 description: K8s Repo ID
8944 schema:
8945 type: string
8946 format: uuid
8947 get:
8948 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8949 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8950 - "Admin"
8951 summary: Query information about an individual K8s Repo
8952 description: Query information about an individual K8s Repo
8953 operationId: getK8sRepo
8954 responses:
8955 '200':
8956 description: OK
8957 content:
8958 application/json:
8959 schema:
8960 $ref: '#/components/schemas/K8sRepoInfo'
8961 application/yaml:
8962 schema:
8963 $ref: '#/components/schemas/K8sRepoInfo'
8964 '400':
8965 $ref: '#/components/responses/BadRequest'
8966 '401':
8967 $ref: '#/components/responses/Unauthorized'
8968 '403':
8969 $ref: '#/components/responses/Forbidden'
8970 '404':
8971 $ref: '#/components/responses/NotFound'
8972 '405':
8973 $ref: '#/components/responses/MethodNotAllowed'
8974 '406':
8975 $ref: '#/components/responses/NotAcceptable'
8976 '409':
8977 $ref: '#/components/responses/Conflict'
8978 '422':
8979 $ref: '#/components/responses/UnprocessableEntity'
8980 '500':
8981 $ref: '#/components/responses/InternalServerError'
8982 '503':
8983 $ref: '#/components/responses/ServiceUnavailable'
8984 '5XX':
8985 $ref: '#/components/responses/UnexpectedError'
8986 default:
8987 $ref: '#/components/responses/UnexpectedError'
8988 delete:
8989 tags:
garciadeblas77849982020-02-28 15:41:43 +0100[diff] [blame]8990 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]8991 - "Admin"
8992 summary: Delete a K8s Repo
8993 description: Delete a K8s Repo
8994 operationId: deleteK8sRepo
8995 responses:
8996 '202':
8997 description: Accepted
8998 '400':
8999 $ref: '#/components/responses/BadRequest'
9000 '401':
9001 $ref: '#/components/responses/Unauthorized'
9002 '403':
9003 $ref: '#/components/responses/Forbidden'
9004 '404':
9005 $ref: '#/components/responses/NotFound'
9006 '405':
9007 $ref: '#/components/responses/MethodNotAllowed'
9008 '406':
9009 $ref: '#/components/responses/NotAcceptable'
9010 '409':
9011 $ref: '#/components/responses/Conflict'
9012 '422':
9013 $ref: '#/components/responses/UnprocessableEntity'
9014 '500':
9015 $ref: '#/components/responses/InternalServerError'
9016 '503':
9017 $ref: '#/components/responses/ServiceUnavailable'
9018 '5XX':
9019 $ref: '#/components/responses/UnexpectedError'
9020 default:
9021 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9022# END Admin
9023
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9024externalDocs:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9025 description: Find out more about OSM
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]9026 url: 'https://osm.etsi.org/docs/user-guide/'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9027
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9028components:
9029 responses:
9030 BadRequest:
9031 description: Bad request. The server cannot process the request due to a client error.
9032 content:
9033 application/json:
9034 schema:
9035 $ref: '#/components/schemas/ProblemDetails'
9036 Unauthorized:
9037 description: Authorization information is missing or invalid.
9038 content:
9039 application/json:
9040 schema:
9041 $ref: '#/components/schemas/ProblemDetails'
9042 Forbidden:
9043 description: Not enough permissions to do this operation.
9044 content:
9045 application/json:
9046 schema:
9047 $ref: '#/components/schemas/ProblemDetails'
9048 NotFound:
9049 description: The specified resource was not found.
9050 content:
9051 application/json:
9052 schema:
9053 $ref: '#/components/schemas/ProblemDetails'
9054 MethodNotAllowed:
9055 description: This method is not supported for the requested resource.
9056 content:
9057 application/json:
9058 schema:
9059 $ref: '#/components/schemas/ProblemDetails'
9060 NotAcceptable:
9061 description: The requested resource content cannot match the Accept headers sent in the request.
9062 content:
9063 application/json:
9064 schema:
9065 $ref: '#/components/schemas/ProblemDetails'
9066 Conflict:
9067 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
9068 content:
9069 application/json:
9070 schema:
9071 $ref: '#/components/schemas/ProblemDetails'
9072 UnprocessableEntity:
9073 description: The request was well-formed but was unable to be followed due to semantic errors.
9074 content:
9075 application/json:
9076 schema:
9077 $ref: '#/components/schemas/ProblemDetails'
9078 InternalServerError:
9079 description: Internal server error.
9080 content:
9081 application/json:
9082 schema:
9083 $ref: '#/components/schemas/ProblemDetails'
9084 ServiceUnavailable:
9085 description: Service temporarily unavailable.
9086 content:
9087 application/json:
9088 schema:
9089 $ref: '#/components/schemas/ProblemDetails'
9090 UnexpectedError:
9091 description: Unexpected error.
9092 content:
9093 application/json:
9094 schema:
9095 $ref: '#/components/schemas/ProblemDetails'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9096 VnfDescriptor:
9097 description: VNF Descriptor (plaintext)
9098 content:
9099 text/plain:
9100 schema:
9101 $ref: '#/components/schemas/VnfDescriptor'
9102 VnfPackage:
9103 description: VNF Package (compressed)
9104 content:
9105 application/zip:
9106 schema:
9107 $ref: '#/components/schemas/VnfPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9108 NsDescriptor:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9109 description: NS Descriptor (plaintext)
9110 content:
9111 text/plain:
9112 schema:
9113 $ref: '#/components/schemas/NsDescriptor'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9114 NsPackage:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9115 description: NS Package (compressed)
9116 content:
9117 application/zip:
9118 schema:
9119 $ref: '#/components/schemas/NsPackage'
9120 NetSliceTemplate:
9121 description: NetSlice Template (plaintext)
9122 content:
9123 text/plain:
9124 schema:
9125 $ref: '#/components/schemas/NetSliceTemplate'
9126 NetSlicePackage:
9127 description: NetSlice Package (compressed)
9128 content:
9129 application/zip:
9130 schema:
9131 $ref: '#/components/schemas/NetSlicePackage'
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]9132 NslcmSubscriptionResponse:
9133 description: NslcmSubscriptionResponse
9134 content:
9135 application/json:
9136 schema:
9137 $ref: '#/components/schemas/NslcmSubscriptionResponse'
9138 application/yaml:
9139 schema:
9140 $ref: '#/components/schemas/NslcmSubscriptionResponse'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9141 # END RESPONSES
9142
9143 schemas:
9144 ObjectId:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9145 type: object
9146 properties:
9147 id:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9148 type: string
9149 format: uuid
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]9150 ObjectIdList:
9151 type: object
9152 properties:
9153 ns_ids:
9154 type: array
9155 items:
9156 type: string
9157 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9158 KeyValuePairs:
9159 # A free list of key:value pairs
9160 type: object
9161 additionalProperties: true
9162 NsDescriptor:
9163 type: string
9164 format: yaml|json
9165 NsPackage:
9166 type: string
9167 format: binary
9168 CreateNsdInfoRequest:
9169 # A free list of key:value pairs
9170 type: object
9171 additionalProperties: true
9172 NsdInfoModifications:
9173 description: |
9174 NS Descriptor Information
9175 Only generic fields (id, name, description) are described
9176 For a full specification of the NS Descriptor see:
9177 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
9178 type: object
9179 properties:
9180 id:
9181 description: NSD Identifier
9182 type: string
9183 name:
9184 description: NSD Name
9185 type: string
9186 description:
9187 description: NSD Description
9188 type: string
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]9189 AlarmInfoModifications:
9190 description: |
9191 Alarm Information
9192 type: object
9193 properties:
9194 id:
9195 description: UUID
9196 type: string
9197 is_enable:
9198 description: To enable/disable the alarm.
9199 type: string
9200 threshold:
9201 description: Threshold value of the Alarm
9202 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9203 NsdInfo:
9204 description: |
9205 NS Descriptor Information
9206 Only generic fields (_id, id, name, description) are described
9207 For a full specification of the NS Descriptor see:
9208 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
9209 type: object
9210 properties:
9211 _id:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9212 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9213 Identifier of the onboarded individual NS descriptor
9214 resource. This identifier is allocated by the NFVO.
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9215 type: string
9216 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9217 id:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9218 description: |
9219 This identifier, which is allocated by the NSD
9220 designer, identifies the NSD in a globally unique
9221 way. It is copied from the NSD content and shall be
9222 present after the NSD content is on-boarded.
9223 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9224 name:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9225 description: |
9226 Name of the onboarded NSD. This information is
9227 copied from the NSD content and shall be present
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9228 after the NSD content is on-boarded.
9229 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9230 description:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9231 description: |
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9232 Description of the onboarded NSD.
9233 This information is copied from the NSD content.
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9234 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9235 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9236 - _id
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9237 - id
9238 ArrayOfNsdInfo:
9239 type: array
9240 items:
9241 $ref: '#/components/schemas/NsdInfo'
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]9242 ProblemDetails:
9243 type: object
9244 properties:
9245 type:
9246 type: string
9247 format: uri
9248 title:
9249 type: string
9250 status:
9251 type: integer
9252 detail:
9253 type: string
9254 instance:
9255 type: string
9256 format: uri
9257 additionalProperties: true
9258 required:
9259 - status
9260 - detail
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]9261 CreateNsConfigTemplateInfoRequest:
9262 type: object
9263 properties:
9264 name:
9265 description: Ns Config Template name
9266 type: string
9267 nsdId:
9268 description: |
9269 ID of NS descriptor to which
9270 template is associated
9271 type: string
9272 config:
9273 description: Instantiation parameters
9274 type: object
9275 additionalProperties: false
9276 required:
9277 - name
9278 - nsdId
9279 - config
9280 additionalProperties: false
9281 NsConfigTemplateInfo:
9282 description: |
9283 Ns Config template information includes NSD ID, name
9284 and instantiation parameters of vld, vnf, additionParamForVnf,
9285 additionalParamsForNs.
9286 type: object
9287 properties:
9288 _id:
9289 description: |
9290 Identifier of the inboarded Ns config template resource.
9291 type: string
9292 format: uuid
9293 name:
9294 description: |
9295 Name of the onboarded Ns config template. This information
9296 is given by the user and it is unique.
9297 type: string
9298 nsdId:
9299 description: |
9300 Identifier of the NS descriptor, which is associated
9301 with Ns config template
9302 type: string
9303 config:
9304 description: |
9305 It includes instantiation parameters such as
9306 vld, vnf, additionalParamforVnf.
9307 type: object
9308 ArrayOfNsConfigTemplateInfo:
9309 type: array
9310 items:
9311 $ref: '#/components/schemas/NsConfigTemplateInfo'
9312 NsConfigTemplateInfoModifications:
9313 description: |
9314 Ns Config Template information
9315 It includes name of the template and instantiation parameters.
9316 Ns descriptor id cannot be edited.
9317 type: object
9318 properties:
9319 name:
9320 description: |
9321 Name of the template
9322 type: string
9323 config:
9324 description: |
9325 Instantiation parameters such as vld, vnf, additionalParamsForVnf
9326 can be edit.
9327 type: object
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9328 VnfDescriptor:
9329 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9330 format: yaml|json
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9331 VnfPackage:
9332 type: string
9333 format: binary
9334 CreateVnfPkgInfoRequest:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9335 # A free list of key:value pairs
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9336 type: object
9337 additionalProperties: true
9338 VnfPkgInfoModifications:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9339 description: |
9340 VNF Package Information
9341 Only generic fields (id, name, description) are described
9342 For a full specification of the VNF Descriptor see:
9343 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9344 type: object
9345 properties:
9346 id:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9347 description: VNF Package Identifier
9348 type: string
9349 name:
9350 description: VNF Package Name
9351 type: string
9352 description:
9353 description: VNF Package description
9354 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9355 VnfPkgInfo:
9356 description: |
9357 VNF Package Information
9358 Only generic fields (_id, id, name, description) are described
9359 For a full specification of the VNF Descriptor see:
9360 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
9361 type: object
9362 properties:
9363 _id:
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9364 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9365 Identifier of the VNF package. This identifier is allocated by the NFVO.
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9366 type: string
9367 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9368 id:
9369 description: VNF Package Identifier
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9370 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9371 name:
9372 description: VNF Package Name
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9373 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9374 description:
9375 description: VNF Package description
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9376 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9377 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9378 - _id
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9379 - id
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]9380 ArrayOfVnfPkgInfo:
9381 type: array
9382 items:
9383 $ref: '#/components/schemas/VnfPkgInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9384 # CreateNsRequest:
9385 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9386 NsInstance:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9387 description: |
9388 NS Instance Information
9389 Only generic fields (_id, id, name, description) are described
9390 For a full specification of the NS Instance see:
9391 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9392 type: object
9393 properties:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9394 _id:
9395 description: Identifier of the NS instance.
9396 type: string
9397 format: uuid
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9398 id:
9399 description: Identifier of the NS instance.
9400 type: string
9401 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9402 name:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9403 description: Human readable name of the NS instance.
9404 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9405 description:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9406 description: Human readable description of the NS instance.
9407 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9408 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9409 - _id
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9410 - id
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9411 - name
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9412 InstantiateNsRequest:
9413 type: object
9414 properties:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9415 nsName:
9416 description: |
9417 Human-readable name of the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9418 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9419 nsdId:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9420 description: |
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9421 Identifier of the NSD that defines the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9422 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9423 format: uuid
9424 vimAccountId:
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9425 description: |
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9426 Identifier of the VIM Account where the NS instance shall be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9427 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9428 format: uuid
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]9429 nsConfigTemplateId:
9430 description: |
9431 Identifier of the Ns config template which is selected
9432 while instantiation
9433 type: string
9434 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9435 lcmOperationType:
9436 type: string
9437 nsInstanceId:
9438 type: string
9439 format: uuid
9440 netsliceInstanceId:
9441 type: string
9442 format: uuid
9443 nsDescription:
9444 type: string
9445 nullable: true
9446 wimAccountId:
9447 oneOf:
9448 - type: string
9449 - type: boolean
9450 nullable: true
9451 additionalParamsForNs:
9452 type: object
9453 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9454 additionalParamsForVnf: &additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9455 type: array
9456 items:
9457 type: object
9458 properties:
9459 member-vnf-index:
9460 type: string
9461 additionalParams:
9462 type: object
9463 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9464 k8s-namespace:
9465 type: string
9466 description: |
9467 use this namespace for all the KDU deployed in this VNF
9468 (if any). By default it is used the id of the project
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9469 additionalParamsForVdu:
9470 type: array
9471 items:
9472 type: object
9473 properties:
9474 vdu_id:
9475 type: string
9476 additionalParams:
9477 type: object
9478 additionalProperties: true
9479 required:
9480 - vdu_id
9481 - additionalParams
9482 additionalProperties: false
9483 additionalParamsForKdu:
9484 type: array
9485 items:
9486 type: object
9487 properties:
9488 kdu_name:
9489 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9490 k8s-namespace:
9491 type: string
9492 description: use this namespace for this KDU
9493 kdu_model:
9494 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9495 additionalParams:
9496 type: object
9497 additionalProperties: true
9498 required:
9499 - kdu_name
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9500 minProperties: 2
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9501 additionalProperties: false
9502 required:
9503 - member-vnf-index
9504 minProperties: 2
9505 additionalProperties: false
9506 ssh_keys:
9507 type: array
9508 items:
9509 type: string
9510 nsr_id:
9511 type: string
9512 format: uuid
9513 vduImage:
9514 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9515 placement-engine:
9516 type: string
9517 description: |
9518 To compute automatically the target VIM for each VNF based on
9519 constrains, e.g. latency. Currently only 'PLA' is supported
9520 placement-constraints:
9521 type: object
9522 additionalProperties: true
9523 k8s-namespace:
9524 type: string
9525 timeout_ns_deploy:
9526 type: integer
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9527 vnf:
9528 type: array
9529 items:
9530 type: object
9531 properties:
9532 member-vnf-index:
9533 type: string
9534 vimAccountId:
9535 type: string
9536 format: uuid
9537 vdu:
9538 type: array
9539 items:
9540 type: object
9541 properties:
9542 id:
9543 type: string
9544 volume:
9545 type: array
9546 items:
9547 type: object
9548 properties:
9549 name:
9550 type: string
9551 vim-volume-id:
9552 type: string
9553 required:
9554 - name
9555 - vim-volume-id
9556 additionalProperties: false
9557 minItems: 1
9558 interface:
9559 type: array
9560 items:
9561 type: object
9562 properties:
9563 name:
9564 type: string
9565 ip-address:
9566 type: string
9567 format: ipv4
9568 mac-address:
9569 type: string
9570 format: mac_address
9571 floating-ip-required:
9572 type: boolean
9573 required:
9574 - name
9575 additionalProperties: false
9576 minItems: 1
9577 required:
9578 - id
9579 additionalProperties: false
9580 minItems: 1
9581 internal-vld:
9582 type: array
9583 items:
9584 type: object
9585 properties:
9586 name:
9587 type: string
9588 vim-network-name:
9589 type: string
9590 vim-network-id:
9591 type: string
9592 ip-profile:
9593 type: object
9594 properties:
9595 ip-version:
9596 type: string
9597 enum:
9598 - ipv4
9599 - ipv6
9600 subnet-address:
9601 type: string
9602 format: ip_prefix
9603 nullable: true
9604 gateway-address:
9605 type: string
9606 format: ipv4
9607 nullable: true
9608 dns-server:
9609 type: array
9610 items:
9611 type: object
9612 properties:
9613 address:
9614 type: string
9615 format: ipv4
9616 required:
9617 - address
9618 additionalProperties: false
9619 minItems: 1
9620 nullable: true
9621 dhcp-params:
9622 type: object
9623 properties:
9624 enabled:
9625 type: boolean
9626 count:
9627 type: integer
9628 minimum: 1
9629 start-address:
9630 type: string
9631 format: ipv4
9632 additionalProperties: false
9633 nullable: true
9634 additionalProperties: false
9635 provider-network:
9636 type: object
9637 properties:
9638 physical-network:
9639 type: string
9640 segmentation-id:
9641 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9642 network-type:
9643 type: string
9644 sdn-ports:
9645 description: |
9646 connect additional ports to the created underlay SDN connectivity.
9647 Normally for external connectivy.
9648 type: array
9649 items:
9650 type: object
9651 properties:
9652 switch_id:
9653 type: string
9654 switch_port:
9655 type: string
9656 mac_address:
9657 type: string
9658 format: mac_address
9659 vlan:
9660 type: integer
9661 additionalProperties: true
9662 required:
9663 - switch_id
9664 - switch_port
9665 minItems: 1
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9666 additionalProperties: false
9667 internal-connection-point:
9668 type: array
9669 items:
9670 type: object
9671 properties:
9672 id-ref:
9673 type: string
9674 ip-address:
9675 type: string
9676 format: ipv4
9677 required:
9678 - id-ref
9679 minProperties: 2
9680 additionalProperties: False
9681 minItems: 1
9682 required:
9683 - name
9684 minProperties: 2
9685 additionalProperties: false
9686 minItems: 1
9687 required:
9688 - member-vnf-index
9689 minProperties: 2
9690 additionalProperties: false
9691 minItems: 1
9692 vld:
9693 type: array
9694 items:
9695 type: object
9696 properties:
9697 name:
9698 type: string
9699 vim-network-name:
9700 oneOf:
9701 - type: string
9702 - type: object
9703 vim-network-id:
9704 oneOf:
9705 - type: string
9706 - type: object
9707 ns-net:
9708 type: object
9709 additionalProperties: true
9710 wimAccountId:
9711 oneOf:
9712 - type: string
9713 - type: boolean
9714 nullable: true
9715 ip-profile:
9716 type: object
9717 additionalProperties: true
9718 provider-network:
9719 type: object
9720 properties:
9721 physical-network:
9722 type: string
9723 segmentation-id:
9724 type: string
9725 additionalProperties: false
9726 vnfd-connection-point-ref:
9727 type: array
9728 items:
9729 type: object
9730 properties:
9731 member-vnf-index-ref:
9732 type: string
9733 vnfd-connection-point-ref:
9734 type: string
9735 ip-address:
9736 type: string
9737 format: ipv4
9738 required:
9739 - member-vnf-index-ref
9740 - vnfd-connection-point-ref
9741 minProperties: 3
9742 additionalProperties: false
9743 minItems: 1
9744 required:
9745 - name
9746 additionalProperties: false
9747 minItems: 1
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9748 required:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9749 - nsName
9750 - nsdId
9751 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]9752 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9753 ScaleNsRequest:
9754 type: object
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9755 properties:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9756 scaleType:
9757 type: string
9758 enum:
9759 - SCALE_VNF
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9760 timeout_ns_scale:
9761 description: timeout for the scale operation
9762 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9763 scaleVnfData:
9764 type: object
9765 properties:
9766 scaleVnfType:
9767 type: string
9768 enum:
9769 - SCALE_IN
9770 - SCALE_OUT
9771 scaleByStepData:
9772 type: object
9773 properties:
9774 scaling-group-descriptor:
9775 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9776 scaling-policy:
9777 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9778 member-vnf-index:
9779 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9780 required:
9781 - scaling-group-descriptor
9782 - member-vnf-index
9783 additionalProperties: false
9784 required:
9785 - scaleVnfType
9786 - scaleByStepData
9787 additionalProperties: false
9788 required:
9789 - scaleType
9790 - scaleVnfData
9791 additionalProperties: false
garciadeblasb5a065f2022-02-11 00:27:47 +0100[diff] [blame]9792 HealNsRequest:
9793 description: >
9794 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
9795 instance by healing one or more of the VNF that are part of this NS.
9796 type: object
9797 properties:
9798 timeout_ns_heal:
9799 description: timeout for the heal operation in seconds
9800 type: integer
9801 healVnfData:
9802 description: >
9803 List of VNF to be healed, together with the information needed to heal each.
9804 type: array
9805 items:
9806 $ref: "#/components/schemas/HealVnfData"
9807 required:
9808 - healVnfData
9809 HealVnfData:
9810 description: >
9811 This type represents the information to heal a VNF that is part of an NS.
9812 type: object
9813 required:
9814 - vnfInstanceId
9815 properties:
9816 vnfInstanceId:
9817 description: >
9818 Identifies the VNF instance, part of the NS, requiring a
9819 healing action.
9820 type: string
9821 format: uuid
9822 cause:
9823 description: >
9824 Indicates the reason why a healing procedure is required.
9825 type: string
9826 additionalParams:
9827 description: >
9828 Additional parameters passed by the NFVO as input to
9829 the healing process, specific to the VNF being healed.
9830 type: object
9831 properties:
9832 run-day1:
9833 description: >
9834 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
9835 type: boolean
9836 default: false
9837 vdu:
9838 description: >
9839 List of VDU to be healed, together with the information needed to heal each.
9840 type: array
9841 items:
9842 $ref: "#/components/schemas/HealVduData"
9843 HealVduData:
9844 description: >
9845 This type represents the information to heal a VDU that is part of a VNF.
9846 type: object
9847 required:
9848 - vdu-id
9849 properties:
9850 vdu-id:
9851 description: >
9852 Identifies the VDU id, part of the VNF, requiring a healing action.
9853 type: string
9854 format: uuid
9855 count-index:
9856 description: >
9857 Indicates the VDU number when the VDU is part of a scale-group.
9858 type: integer
9859 minimum: 0
9860 run-day1:
9861 description: >
9862 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
9863 type: boolean
9864 default: false
elumalai4b120f12022-04-28 16:44:35 +0530[diff] [blame]9865 NSinstanceMigrateRequest:
9866 description: >
9867 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
9868 instance by migrating one or more of the VDUs that are part of this NS.
9869 type: object
9870 properties:
9871 vnfInstanceId:
9872 type: string
9873 migrateToHost:
9874 type: string
9875 vdu:
9876 type: object
9877 properties:
9878 vduId:
9879 type: string
9880 vduCountIndex:
9881 type: integer
9882 required:
9883 - vduId
9884 required:
9885 - vnfInstanceId
9886 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9887 TerminateNsRequest:
9888 type: object
9889 properties:
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9890 timeout_ns_terminate:
9891 description: timeout for terminate operation
9892 type: integer
9893 autoremove:
9894 description: remove network service if termination end without error
9895 type: boolean
9896 skip_terminate_primitives:
9897 description: Do not execute network service termination primitives
9898 type: boolean
9899 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]9900 ArrayOfNsInstance:
9901 type: array
9902 items:
9903 $ref: '#/components/schemas/NsInstance'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9904 NSinstanceActionRequest:
9905 type: object
9906 properties:
9907 primitive:
9908 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9909 description: |
9910 name of the primitive in the 'config-descriptor'. If the target is
9911 a kdu it can be also 'status', 'rollback' or 'upgrade'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9912 primitive_params:
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9913 description: parameters of this primitive
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9914 $ref: '#/components/schemas/KeyValuePairs'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9915 member_vnf_index:
9916 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9917 description: provide if the target action is for a vnf, vdu or kdu
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9918 vdu_id:
9919 type: string
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9920 description: provide if the target action is for a vdu
9921 kdu_name:
9922 type: string
9923 description: provide if the target action is for a kdu
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9924 vdu_count_index:
9925 type: integer
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]9926 timeout_ns_action:
9927 description: timeout for the day 1/2 operation
9928 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]9929 required:
9930 - primitive
9931 - primitive_params
9932 additionalProperties: false
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]9933 UpdateNsRequest:
9934 description: >
9935 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
9936 instance by updating one or more of the VNFs that are part of this NS.
9937 type: object
9938 properties:
9939 updateType:
9940 type: string
9941 enum:
9942 - CHANGE_VNFPKG
9943 - REMOVE_VNF
9944 - MODIFY_VNF_INFORMATION
k4.rahul66c884c2022-06-21 06:38:49 +0000[diff] [blame]9945 - OPERATE_VNF
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9946 - VERTICAL_SCALE
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]9947 changeVnfPackageData:
9948 type: object
9949 properties:
9950 vnfInstanceId:
9951 type: string
9952 vnfdId:
9953 type: string
9954 required:
9955 - vnfInstanceId
9956 - vnfdId
9957 removeVnfInstanceId:
9958 type: string
9959 modifyVnfInfoData:
9960 type: object
9961 properties:
9962 vnfInstanceId:
9963 type: string
9964 vnfdId:
9965 type: string
9966 required:
9967 - vnfInstanceId
9968 - vnfdId
k4.rahul66c884c2022-06-21 06:38:49 +0000[diff] [blame]9969 operateVnfData:
9970 type: object
9971 properties:
9972 vnfInstanceId:
9973 type: string
9974 changeStateTo:
9975 type: string
9976 additionalParam:
9977 type: object
9978 properties:
9979 run-day1:
9980 type: boolean
9981 vdu_id:
9982 type: string
9983 count-index:
9984 type: number
9985 required:
9986 - vdu_id
9987 - count-index
9988 required:
9989 - vnfInstanceId
9990 - changeStateTo
9991 additionalProperties: false
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9992 verticalScaleVnf:
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]9993 type: object
9994 properties:
9995 vnfInstanceId:
9996 type: string
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]9997 vnfdId:
9998 type: string
9999 vduId:
10000 type: string
10001 countIndex:
10002 type: number
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]10003 required:
10004 - vnfInstanceId
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]10005 - vnfdId
10006 - vduId
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]10007 required:
rahulkumarr7b6daf52024-06-20 05:23:01 +0000[diff] [blame]10008 - updateType
govindarajul36a93312022-06-21 13:36:22 +0530[diff] [blame]10009 additionalProperties: false
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]10010 MultiNsTerminateRequest:
10011 type: object
10012 properties:
10013 ns_ids:
10014 description: List of Ns instance Ids to be deleted
10015 type: array
10016 items:
10017 type: string
10018 format: uuid
10019 autoremove:
10020 description: remove network service if termination end without error
10021 type: boolean
10022 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10023 # CreateNSinstanceContentRequest:
10024 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10025 CreateNSinstanceContentResponse:
10026 type: object
10027 properties:
10028 id:
10029 type: string
10030 format: uuid
10031 nslcmop_id:
10032 type: string
10033 format: uuid
10034 NsLcmOpOcc:
10035 type: object
10036 properties:
10037 _id:
10038 type: string
10039 format: uuid
10040 id:
10041 type: string
10042 format: uuid
10043 lcmOperationType:
10044 type: string
10045 nsInstanceId:
10046 type: string
10047 format: uuid
10048 isAutomaticInvocation:
10049 type: boolean
10050 isCancelPending:
10051 type: boolean
10052 startTime:
10053 type: number
10054 format: float
10055 statusEnteredTime:
10056 type: number
10057 format: float
10058 operationParams:
10059 type: object
10060 properties:
10061 nsName:
10062 type: string
10063 nsdId:
10064 type: string
10065 format: uuid
10066 vimAccountId:
10067 type: string
10068 format: uuid
10069 nsInstanceId:
10070 type: string
10071 format: uuid
10072 lcmOperationType:
10073 type: string
10074 operationState:
10075 type: string
10076 detailed-status:
10077 type: string
10078 links:
10079 type: object
10080 properties:
10081 self:
10082 type: string
10083 format: path # uri?
10084 nsInstance:
10085 type: string
10086 format: path # uri?
10087 ArrayOfNsLcmOpOcc:
10088 type: array
10089 items:
10090 $ref: '#/components/schemas/NsLcmOpOcc'
10091 VnfInstanceInfo:
10092 description: |
10093 VNF Instance Information
10094 Only generic fields (_id, id) are described
10095 For a full specification of the VNF Instance see:
10096 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
10097 type: object
10098 properties:
10099 _id:
10100 type: string
10101 format: uuid
10102 id:
10103 type: string
10104 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10105 ArrayOfVnfInstanceInfo:
10106 type: array
10107 items:
10108 $ref: '#/components/schemas/VnfInstanceInfo'
10109 NstInfo:
10110 description: |
10111 NetSlice Template Information
10112 Only generic fields (_id, id, name) are described
10113 For a full specification of the NetSlice Template see:
10114 http://osm-download.etsi.org/ftp/osm-doc/nst.html
10115 type: object
10116 properties:
10117 _id:
10118 description: NetSlice Template Identifier
10119 type: string
10120 format: uuid
10121 id:
10122 description: Human readable NetSlice Template Identifier
10123 type: string
10124 name:
10125 description: Human readable name of the NetSlice Template
10126 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10127 ArrayOfNstInfo:
10128 type: array
10129 items:
10130 $ref: '#/components/schemas/NstInfo'
10131 CreateNstInfoRequest:
10132 # A free list of key:value pairs
10133 type: object
10134 additionalProperties: true
10135 NetSliceTemplate:
10136 type: string
10137 format: yaml|json
10138 NetSlicePackage:
10139 type: string
10140 format: binary
10141 NstInfoModifications:
10142 description: |
10143 NetSlice Template Information
10144 Only generic fields (id, name) are described
10145 For a full specification of the NetSlice Template see:
10146 http://osm-download.etsi.org/ftp/osm-doc/nst.html
10147 type: object
10148 properties:
10149 id:
10150 description: NST Identifier
10151 type: string
10152 name:
10153 description: NST Name
10154 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10155 NetSliceInstance:
10156 description: |
10157 NetSlice Instance Information
10158 Only generic fields (_id, id, name, description) are described
10159 For a full specification of the NetSlice Instance see:
10160 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
10161 type: object
10162 properties:
10163 _id:
10164 description: Identifier of the NetSlice instance.
10165 type: string
10166 format: uuid
10167 id:
10168 description: Identifier of the NetSlice instance.
10169 type: string
10170 format: uuid
10171 name:
10172 description: Human readable name of the NetSlice instance.
10173 type: string
10174 description:
10175 description: Human readable description of the NetSlice instance.
10176 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10177 required:
10178 - _id
10179 - id
10180 - name
10181 ArrayOfNetSliceInstance:
10182 type: array
10183 items:
10184 $ref: '#/components/schemas/NetSliceInstance'
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]10185 Alarm:
10186 description: |
10187 Alarm Information
10188 type: object
10189 properties:
10190 _id:
10191 description: Identifier of the Alarm.
10192 type: string
10193 format: uuid
10194 id:
10195 description: Identifier of the Alarm.
10196 type: string
10197 format: uuid
10198 metric:
10199 description: Alarm metric.
10200 type: string
10201 threshold:
10202 description: Threshold value of the Alarm.
10203 type: number
10204 format: float
10205 operation:
10206 description: Operation to be applied.
10207 type: string
10208 action:
10209 description: Action to be taken.
10210 type: string
10211 status:
10212 description: Current status of the alarm.
10213 type: string
10214 required:
10215 - _id
10216 - id
10217 - metric
10218 - threshold
10219 - operation
10220 ArrayOfAlarm:
10221 type: array
10222 items:
10223 $ref: '#/components/schemas/Alarm'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10224 # CreateNsiRequest:
10225 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10226 InstantiateNsiRequest:
10227 type: object
10228 properties:
10229 nsiName:
10230 description: |
10231 Human-readable name of the NetSlice instance to be created.
10232 type: string
10233 nstId:
10234 description: |
10235 Identifier of the NST that defines the NetSlice instance to be created.
10236 type: string
10237 format: uuid
10238 vimAccountId:
10239 description: |
10240 Identifier of the VIM Account where the NetSlice instance shall be created.
10241 type: string
10242 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10243 lcmOperationType:
10244 type: string
10245 netsliceInstanceId:
10246 type: string
10247 format: uuid
10248 nsiDescription:
10249 type: string
10250 nullable: true
10251 ssh_keys:
10252 type: string
10253 nsi_id:
10254 type: string
10255 format: uuid
10256 additionalParamsForNsi:
10257 type: object
10258 additionalProperties: true
10259 netslice-subnet:
10260 type: array
10261 items:
10262 type: object
10263 properties:
10264 id:
10265 type: string
10266 nsName:
10267 type: string
10268 nsdId:
10269 type: string
10270 format: uuid
10271 vimAccountId:
10272 type: string
10273 format: uuid
10274 lcmOperationType:
10275 type: string
10276 nsInstanceId:
10277 type: string
10278 format: uuid
10279 netsliceInstanceId:
10280 type: string
10281 format: uuid
10282 nsDescription:
10283 type: string
10284 nullable: true
10285 wimAccountId:
10286 oneOf:
10287 - type: string
10288 - type: boolean
10289 nullable: true
10290 additionalParamsForNs:
10291 type: object
10292 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +0000[diff] [blame]10293 additionalParamsForVnf: *additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10294 ssh_keys:
10295 type: array
10296 items:
10297 type: string
10298 nsr_id:
10299 type: string
10300 format: uuid
10301 vduImage:
10302 type: string
10303 vnf:
10304 type: array
10305 items:
10306 type: object
10307 properties:
10308 member-vnf-index:
10309 type: string
10310 vimAccountId:
10311 type: string
10312 format: uuid
10313 vdu:
10314 type: array
10315 items:
10316 type: object
10317 properties:
10318 id:
10319 type: string
10320 volume:
10321 type: array
10322 items:
10323 type: object
10324 properties:
10325 name:
10326 type: string
10327 vim-volume-id:
10328 type: string
10329 required:
10330 - name
10331 - vim-volume-id
10332 additionalProperties: false
10333 minItems: 1
10334 interface:
10335 type: array
10336 items:
10337 type: object
10338 properties:
10339 name:
10340 type: string
10341 ip-address:
10342 type: string
10343 format: ipv4
10344 mac-address:
10345 type: string
10346 format: mac_address
10347 floating-ip-required:
10348 type: boolean
10349 required:
10350 - name
10351 additionalProperties: false
10352 minItems: 1
10353 required:
10354 - id
10355 additionalProperties: false
10356 minItems: 1
10357 internal-vld:
10358 type: array
10359 items:
10360 type: object
10361 properties:
10362 name:
10363 type: string
10364 vim-network-name:
10365 type: string
10366 vim-network-id:
10367 type: string
10368 ip-profile:
10369 type: object
10370 properties:
10371 ip-version:
10372 type: string
10373 enum:
10374 - ipv4
10375 - ipv6
10376 subnet-address:
10377 type: string
10378 format: ip_prefix
10379 nullable: true
10380 gateway-address:
10381 type: string
10382 format: ipv4
10383 nullable: true
10384 dns-server:
10385 type: array
10386 items:
10387 type: object
10388 properties:
10389 address:
10390 type: string
10391 format: ipv4
10392 required:
10393 - address
10394 additionalProperties: false
10395 minItems: 1
10396 nullable: true
10397 dhcp-params:
10398 type: object
10399 properties:
10400 enabled:
10401 type: boolean
10402 count:
10403 type: integer
10404 minimum: 1
10405 start-address:
10406 type: string
10407 format: ipv4
10408 additionalProperties: false
10409 nullable: true
10410 additionalProperties: false
10411 provider-network:
10412 type: object
10413 properties:
10414 physical-network:
10415 type: string
10416 segmentation-id:
10417 type: string
10418 additionalProperties: false
10419 internal-connection-point:
10420 type: array
10421 items:
10422 type: object
10423 properties:
10424 id-ref:
10425 type: string
10426 ip-address:
10427 type: string
10428 format: ipv4
10429 required:
10430 - id-ref
10431 minProperties: 2
10432 additionalProperties: False
10433 minItems: 1
10434 required:
10435 - name
10436 minProperties: 2
10437 additionalProperties: false
10438 minItems: 1
10439 required:
10440 - member-vnf-index
10441 minProperties: 2
10442 additionalProperties: false
10443 minItems: 1
10444 vld:
10445 type: array
10446 items:
10447 type: object
10448 properties:
10449 name:
10450 type: string
10451 vim-network-name:
10452 oneOf:
10453 - type: string
10454 - type: object
10455 vim-network-id:
10456 oneOf:
10457 - type: string
10458 - type: object
10459 ns-net:
10460 type: object
10461 additionalProperties: true
10462 wimAccountId:
10463 oneOf:
10464 - type: string
10465 - type: boolean
10466 nullable: true
10467 ip-profile:
10468 type: object
10469 additionalProperties: true
10470 provider-network:
10471 type: object
10472 properties:
10473 physical-network:
10474 type: string
10475 segmentation-id:
10476 type: string
10477 additionalProperties: false
10478 vnfd-connection-point-ref:
10479 type: array
10480 items:
10481 type: object
10482 properties:
10483 member-vnf-index-ref:
10484 type: string
10485 vnfd-connection-point-ref:
10486 type: string
10487 ip-address:
10488 type: string
10489 format: ipv4
10490 required:
10491 - member-vnf-index-ref
10492 - vnfd-connection-point-ref
10493 minProperties: 3
10494 additionalProperties: false
10495 minItems: 1
10496 required:
10497 - name
10498 additionalProperties: false
10499 minItems: 1
10500 additionalProperties: false
10501 minItems: 1
10502 netslice-vld:
10503 type: array
10504 items:
10505 type: object
10506 properties:
10507 name:
10508 type: string
10509 vim-network-name:
10510 oneOf:
10511 - type: string
10512 - type: object
10513 vim-network-id:
10514 oneOf:
10515 - type: string
10516 - type: object
10517 ip-profile:
10518 type: object
10519 additionalProperties: true
10520 required:
10521 - name
10522 additionalProperties: false
10523 minItems: 1
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10524 required:
10525 - nsiName
10526 - nstId
10527 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10528 additionalProperties: false
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10529 TerminateNsiRequest:
10530 type: object
10531 properties:
10532 terminationTime:
10533 description: |
10534 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
10535 automatically at this timestamp. Cardinality "0" indicates the NSI termination
10536 takes place immediately.
10537 type: string
10538 format: date-time
10539 NsiActionRequest:
10540 type: object
10541 properties:
10542 primitive:
10543 type: string
10544 primitive_params:
10545 $ref: '#/components/schemas/KeyValuePairs'
10546 lcmOperationType:
10547 type: string
10548 netsliceInstanceId:
10549 type: string
10550 format: uuid
10551 required:
10552 - primitive
10553 - primitive_params
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10554 # CreateNsiContentRequest:
10555 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]10556 CreateNsiContentResponse:
10557 type: object
10558 properties:
10559 id:
10560 type: string
10561 format: uuid
10562 nsilcmop_id:
10563 type: string
10564 format: uuid
10565 NsiLcmOpOcc:
10566 type: object
10567 properties:
10568 _id:
10569 type: string
10570 format: uuid
10571 id:
10572 type: string
10573 format: uuid
10574 lcmOperationType:
10575 type: string
10576 netsliceInstanceId:
10577 type: string
10578 format: uuid
10579 isAutomaticInvocation:
10580 type: boolean
10581 isCancelPending:
10582 type: boolean
10583 startTime:
10584 type: number
10585 format: float
10586 statusEnteredTime:
10587 type: number
10588 format: float
10589 operationParams:
10590 type: object
10591 properties:
10592 nsiName:
10593 type: string
10594 nstId:
10595 type: string
10596 format: uuid
10597 vimAccountId:
10598 type: string
10599 format: uuid
10600 netsliceInstanceId:
10601 type: string
10602 format: uuid
10603 lcmOperationType:
10604 type: string
10605 nslcmops_ids:
10606 type: array
10607 items:
10608 type: string
10609 format: uuid
10610 operationState:
10611 type: string
10612 detailed-status:
10613 type: string
10614 links:
10615 type: object
10616 properties:
10617 self:
10618 type: string
10619 format: path # uri?
10620 netsliceInstanceId:
10621 type: string
10622 format: path # uri?
10623 ArrayOfNsiLcmOpOcc:
10624 type: array
10625 items:
10626 $ref: '#/components/schemas/NsiLcmOpOcc'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10627 TokenInfo:
10628 type: object
10629 properties:
10630 _id:
10631 type: string
10632 id:
10633 type: string
10634 admin:
10635 type: boolean
selvi.j9058fd92023-04-18 14:58:14 +0000[diff] [blame]10636 admin_show:
10637 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10638 project_id:
10639 type: string
10640 format: uuid
10641 user_id:
10642 type: string
10643 format: uuid
10644 project_name:
10645 type: string
10646 username:
10647 type: string
10648 issued_at:
10649 type: number
10650 format: float
selvi.j9058fd92023-04-18 14:58:14 +0000[diff] [blame]10651 user_show:
10652 type: boolean
10653 last_login:
10654 type: number
10655 format: float
10656 login_count:
10657 type: number
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10658 expires:
10659 type: number
10660 format: float
10661 remote_host:
10662 type: string
10663 format: ipv4
10664 remote_port:
10665 type: integer
10666 roles:
10667 type: array
10668 items:
10669 type: object
10670 properties:
10671 id:
10672 type: string
10673 format: uuid
10674 name:
10675 type: string
selvi.ja6f638b2022-03-23 12:27:35 +0000[diff] [blame]10676 PasswordExpiryInfo:
10677 type: object
10678 properties:
10679 id:
10680 type: string
10681 message:
10682 type: string
10683 user_id:
10684 type: string
10685 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10686 ArrayOfTokenInfo:
10687 type: array
10688 items:
10689 $ref: '#/components/schemas/TokenInfo'
10690 CreateTokenRequest:
10691 type: object
10692 properties:
10693 username:
10694 type: string
10695 password:
10696 type: string
10697 project_id:
10698 type: string
10699 required:
10700 - username
10701 - password
10702 UserInfo:
10703 type: object
10704 properties:
10705 _id:
10706 type: string
10707 format: uuid
10708 username:
10709 type: string
10710 password:
10711 type: string
10712 project_role_mappings:
10713 type: array
10714 items:
10715 type: object
10716 properties:
10717 project:
10718 type: string
10719 format: uuid
10720 role:
10721 type: string
10722 format: uuid
10723 project_name:
10724 type: string
10725 role_name:
10726 type: string
10727 projects:
10728 type: array
10729 items:
10730 type: string
10731 ArrayOfUserInfo:
10732 type: array
10733 items:
10734 $ref: '#/components/schemas/UserInfo'
10735 ProjectRoleMappings:
10736 type: array
10737 items:
10738 type: object
10739 properties:
10740 project:
10741 type: string
10742 role:
10743 type: string
10744 required:
10745 - project
10746 - role
10747 additionalProperties: false
10748 ProjectRoleMappingsOpt:
10749 type: array
10750 items:
10751 type: object
10752 properties:
10753 project:
10754 type: string
10755 role:
10756 type: string
10757 required:
10758 - project
10759 additionalProperties: false
10760 CreateUserRequest:
10761 type: object
10762 properties:
10763 username:
10764 type: string
10765 password:
10766 type: string
10767 projects:
10768 type: array
10769 items:
10770 type: string
10771 project_role_mappings:
10772 $ref: '#/components/schemas/ProjectRoleMappings'
10773 required:
10774 - username
10775 - password
10776 additionalProperties: false
10777 ShortNameList:
10778 type: array
10779 items:
10780 type: string
10781 ArrayEditionSchema:
10782 type: object
10783 additionalProperties: true
10784 minProperties: 1
10785 description: |
10786 Array edition keys must start with '$'
10787 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
10788 EditUserRequest:
10789 type: object
10790 properties:
10791 username:
10792 type: string
10793 password:
10794 type: string
selvi.j9058fd92023-04-18 14:58:14 +0000[diff] [blame]10795 old_password:
10796 type: string
10797 system_admin_id:
10798 type: string
10799 format: uuid
10800 unlock:
10801 type: boolean
10802 renew:
10803 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10804 projects:
10805 oneOf:
10806 - $ref: '#/components/schemas/ShortNameList'
10807 - $ref: '#/components/schemas/ArrayEditionSchema'
10808 project_role_mappings:
10809 $ref: '#/components/schemas/ProjectRoleMappings'
10810 add_project_role_mappings:
10811 $ref: '#/components/schemas/ProjectRoleMappings'
10812 remove_project_role_mappings:
10813 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
10814 QuotasInfo:
10815 type: object
10816 properties:
10817 vnfds:
10818 type: integer
10819 minimum: 0
10820 nullable: false
10821 nsds:
10822 type: integer
10823 minimum: 0
10824 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10825 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10826 type: integer
10827 minimum: 0
10828 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10829 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10830 type: integer
10831 minimum: 0
10832 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10833 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10834 type: integer
10835 minimum: 0
10836 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10837 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10838 type: integer
10839 minimum: 0
10840 nullable: false
10841 vim_accounts:
10842 type: integer
10843 minimum: 0
10844 nullable: false
10845 wim_accounts:
10846 type: integer
10847 minimum: 0
10848 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10849 sdn_controllers:
10850 type: integer
10851 minimum: 0
10852 nullable: false
10853 k8sclusters:
10854 type: integer
10855 minimum: 0
10856 nullable: false
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10857 vca:
10858 type: integer
10859 minimum: 0
10860 nullable: false
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10861 k8srepos:
10862 type: integer
10863 minimum: 0
10864 nullable: false
10865 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10866 type: integer
10867 minimum: 0
10868 nullable: false
10869 additionalProperties: false
10870 EditQuotasInfo:
10871 type: object
10872 properties:
10873 vnfds:
10874 type: integer
10875 minimum: 0
10876 nullable: true
10877 nsds:
10878 type: integer
10879 minimum: 0
10880 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10881 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10882 type: integer
10883 minimum: 0
10884 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10885 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10886 type: integer
10887 minimum: 0
10888 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10889 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10890 type: integer
10891 minimum: 0
10892 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10893 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10894 type: integer
10895 minimum: 0
10896 nullable: true
10897 vim_accounts:
10898 type: integer
10899 minimum: 0
10900 nullable: true
10901 wim_accounts:
10902 type: integer
10903 minimum: 0
10904 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10905 sdn_controllers:
10906 type: integer
10907 minimum: 0
10908 nullable: true
10909 k8sclusters:
10910 type: integer
10911 minimum: 0
10912 nullable: true
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]10913 vca:
10914 type: integer
10915 minimum: 0
10916 nullable: true
tierno8bf88062020-06-02 11:45:11 +0000[diff] [blame]10917 k8srepos:
10918 type: integer
10919 minimum: 0
10920 nullable: true
10921 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]10922 type: integer
10923 minimum: 0
10924 nullable: true
10925 additionalProperties: false
10926 ProjectInfo:
10927 type: object
10928 properties:
10929 _id:
10930 type: string
10931 format: uuid
10932 name:
10933 type: string
10934 quotas:
10935 $ref: '#/components/schemas/QuotasInfo'
10936 ArrayOfProjectInfo:
10937 type: array
10938 items:
10939 $ref: '#/components/schemas/ProjectInfo'
10940 CreateProjectRequest:
10941 type: object
10942 properties:
10943 name:
10944 type: string
10945 admin:
10946 type: boolean
10947 quotas:
10948 $ref: '#/components/schemas/QuotasInfo'
10949 required:
10950 - name
10951 additionalProperties: false
10952 EditProjectRequest:
10953 type: object
10954 properties:
10955 name:
10956 type: string
10957 admin:
10958 type: boolean
10959 quotas:
10960 $ref: '#/components/schemas/EditQuotasInfo'
10961 additionalProperties: false
10962 PermissionsInfo:
10963 type: object
10964 additionalProperties:
10965 type: boolean
10966 nullable: false
10967 description: |
10968 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
10969 Permission values are either true or false
10970 EditPermissionsInfo:
10971 type: object
10972 additionalProperties:
10973 type: boolean
10974 nullable: true
10975 description: |
10976 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
10977 Permission values are either true, false, or null
10978 RoleInfo:
10979 type: object
10980 properties:
10981 _id:
10982 type: string
10983 format: uuid
10984 name:
10985 type: string
10986 permissions:
10987 $ref: '#/components/schemas/PermissionsInfo'
10988 ArrayOfRoleInfo:
10989 type: array
10990 items:
10991 $ref: '#/components/schemas/RoleInfo'
10992 CreateRoleRequest:
10993 type: object
10994 properties:
10995 name:
10996 type: string
10997 permissions:
10998 $ref: '#/components/schemas/PermissionsInfo'
10999 required:
11000 - name
11001 additionalProperties: false
11002 EditRoleRequest:
11003 type: object
11004 properties:
11005 name:
11006 type: string
11007 permissions:
11008 $ref: '#/components/schemas/EditPermissionsInfo'
11009 additionalProperties: false
11010 VimType:
11011 type: string
11012 enum:
11013 - openvim
11014 - openstack
11015 - vmware
11016 - opennebula
11017 - aws
11018 - azure
11019 - fos
11020 VimInfo:
11021 type: object
11022 properties:
11023 _id:
11024 type: string
11025 format: uuid
11026 schema_version:
11027 type: string
11028 format: X.Y[.Z]
11029 schema_type:
11030 type: string
11031 name:
11032 type: string
11033 description:
11034 type: string
11035 vim:
11036 type: string
11037 datacenter:
11038 type: string
11039 vim_type:
11040 $ref: '#/components/schemas/VimType'
11041 vim_url:
11042 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11043 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11044 vim_tenant_name:
11045 type: string
11046 vim_user:
11047 type: string
11048 vim_password:
11049 type: string
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]11050 vca:
11051 type: string
11052 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11053 config:
11054 type: object
11055 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +0000[diff] [blame]11056 resources:
11057 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11058 ArrayOfVimInfo:
11059 type: array
11060 items:
11061 $ref: '#/components/schemas/VimInfo'
11062 CreateVimRequest:
11063 type: object
11064 properties:
11065 schema_version:
11066 type: string
11067 format: X.Y[.Z]
11068 schema_type:
11069 type: string
11070 name:
11071 type: string
11072 description:
11073 type: string
11074 vim:
11075 type: string
11076 datacenter:
11077 type: string
11078 vim_type:
11079 $ref: '#/components/schemas/VimType'
11080 vim_url:
11081 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11082 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11083 vim_tenant_name:
11084 type: string
11085 vim_user:
11086 type: string
11087 vim_password:
11088 type: string
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]11089 vca:
11090 type: string
11091 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11092 config:
11093 type: object
11094 additionalProperties: true
garciadeblas6229f2f2022-11-24 15:03:56 +0100[diff] [blame]11095 prometheus-config:
11096 type: object
11097 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +0000[diff] [blame]11098 resources:
11099 type: object
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]11100 creds:
11101 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11102 required:
11103 - name
11104 - vim_url
11105 - vim_type
11106 - vim_user
11107 - vim_password
11108 - vim_tenant_name
11109 additionalProperties: false
11110 EditVimRequest:
11111 type: object
11112 properties:
11113 name:
11114 type: string
11115 description:
11116 type: string
11117 vim:
11118 type: string
11119 datacenter:
11120 type: string
11121 vim_type:
11122 $ref: '#/components/schemas/VimType'
11123 vim_url:
11124 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11125 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11126 vim_tenant_name:
11127 type: string
11128 vim_user:
11129 type: string
11130 vim_password:
11131 type: string
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]11132 vca:
11133 type: string
11134 format: uuid
garciadeblas6229f2f2022-11-24 15:03:56 +0100[diff] [blame]11135 prometheus-config:
11136 type: object
11137 additionalProperties: true
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11138 config:
11139 type: object
11140 additionalProperties: true
11141 additionalProperties: false
11142 ObjectId_plus_OpId:
11143 type: object
11144 properties:
11145 id:
11146 type: string
11147 format: uuid
11148 op_id:
11149 type: string
11150 format: uuid
11151 OpId:
11152 type: object
11153 properties:
11154 op_id:
11155 type: string
11156 format: uuid
11157 WimType:
11158 type: string
11159 enum:
11160 - onos
11161 - odl
11162 - tapi
11163 - dynpac
11164 - fake
11165 WimInfo:
11166 type: object
11167 properties:
11168 _id:
11169 type: string
11170 format: uuid
11171 schema_version:
11172 type: string
11173 format: X.Y[.Z]
11174 schema_type:
11175 type: string
11176 name:
11177 type: string
11178 description:
11179 type: string
11180 wim:
11181 type: string
11182 wim_type:
11183 $ref: '#/components/schemas/WimType'
11184 wim_url:
11185 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11186 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11187 user:
11188 type: string
11189 password:
11190 type: string
11191 config:
11192 type: object
11193 additionalProperties: true
11194 ArrayOfWimInfo:
11195 type: array
11196 items:
11197 $ref: '#/components/schemas/WimInfo'
11198 CreateWimRequest:
11199 type: object
11200 properties:
11201 schema_version:
11202 type: string
11203 format: X.Y[.Z]
11204 schema_type:
11205 type: string
11206 name:
11207 type: string
11208 description:
11209 type: string
11210 wim:
11211 type: string
11212 wim_type:
11213 $ref: '#/components/schemas/WimType'
11214 wim_url:
11215 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11216 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11217 user:
11218 type: string
11219 password:
11220 type: string
11221 config:
11222 type: object
11223 additionalProperties: true
11224 required:
11225 - name
11226 - wim_url
11227 - wim_type
11228 additionalProperties: false
11229 EditWimRequest:
11230 type: object
11231 properties:
11232 name:
11233 type: string
11234 description:
11235 type: string
11236 wim:
11237 type: string
11238 wim_type:
11239 type: string
11240 wim_url:
11241 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11242 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11243 user:
11244 type: string
11245 password:
11246 type: string
11247 config:
11248 type: object
11249 additionalProperties: true
11250 additionalProperties: false
11251 SdnBasicProperties:
11252 type: object
11253 properties:
11254 name:
11255 type: string
11256 description:
11257 type: string
11258 dpid:
11259 type: string
11260 format: mac_address
11261 ip:
11262 type: string
11263 format: ipv4
11264 port:
11265 type: integer
11266 type:
11267 type: string
11268 enum:
11269 - floodlight
11270 - opendaylight
11271 - onos
11272 version:
11273 type: string
11274 user:
11275 type: string
11276 password:
11277 type: string
11278 SdnExtraProperties:
11279 type: object
11280 properties:
11281 _id:
11282 type: string
11283 format: uuid
11284 schema_version:
11285 type: string
11286 format: X.Y[.Z]
11287 SdnInfo:
11288 allOf:
11289 - $ref: '#/components/schemas/SdnExtraProperties'
11290 - $ref: '#/components/schemas/SdnBasicProperties'
11291 ArrayOfSdnInfo:
11292 type: array
11293 items:
11294 $ref: '#/components/schemas/SdnInfo'
11295 CreateSdnRequest:
11296 allOf:
11297 - $ref: '#/components/schemas/SdnBasicProperties'
11298 required:
11299 - name
11300 - type
11301 - ip
11302 - port
11303 - dpid
11304 additionalProperties: false
11305 EditSdnRequest:
11306 allOf:
11307 - $ref: '#/components/schemas/SdnBasicProperties'
11308 additionalProperties: false
11309 NsPmJobReportInfo:
11310 type: object
11311 properties:
11312 entries:
11313 type: array
11314 items:
11315 type: object
11316 properties:
11317 objectInstanceId:
11318 type: string
11319 format: uuid
11320 performanceMetric:
11321 type: string
11322 performanceValue:
11323 type: object
11324 properties:
11325 performanceValue:
11326 type: object
11327 properties:
11328 performanceValue:
11329 type: number
11330 vnfMemberIndex:
11331 type: string
11332 vduName:
11333 type: string
11334 timestamp:
11335 type: number
11336 PduInterfaces:
11337 type: array
11338 items:
11339 type: object
11340 properties:
11341 name:
11342 type: string
11343 mgmt:
11344 type: boolean
11345 type:
11346 type: string
11347 enum:
11348 - overlay
11349 - underlay
11350 ip-address:
11351 type: string
11352 format: ipv4
11353 mac-address:
11354 type: string
11355 format: mac_address
11356 vim-network-name:
11357 type: string
11358 vim-network-id:
11359 type: string
11360 required:
11361 - name
11362 - mgmt
11363 - ip-address
11364 additionalProperties: false
11365 PduInfo:
11366 type: object
11367 properties:
11368 _id:
11369 type: string
11370 format: uuid
11371 name:
11372 type: string
11373 type:
11374 type: string
11375 description:
11376 type: string
11377 shared:
11378 type: boolean
11379 vims:
11380 type: array
11381 items:
11382 type: string
11383 vim_accounts:
11384 type: array
11385 items:
11386 type: string
11387 interfaces:
11388 $ref: '#/components/schemas/PduInterfaces'
11389 ArrayOfPduInfo:
11390 type: array
11391 items:
11392 $ref: '#/components/schemas/PduInfo'
11393 CreatePduRequest:
11394 type: object
11395 properties:
11396 name:
11397 type: string
11398 type:
11399 type: string
11400 description:
11401 type: string
11402 shared:
11403 type: boolean
11404 vims:
11405 type: array
11406 items:
11407 type: string
11408 vim_accounts:
11409 type: array
11410 items:
11411 type: string
11412 interfaces:
11413 $ref: '#/components/schemas/PduInterfaces'
11414 required:
11415 - name
11416 - type
11417 - interfaces
11418 additionalProperties: false
11419 EditPduRequest:
11420 type: object
11421 properties:
11422 name:
11423 type: string
11424 type:
11425 type: string
11426 description:
11427 type: string
11428 shared:
11429 type: boolean
11430 vims:
11431 type: array
11432 items:
11433 type: string
11434 vim_accounts:
11435 type: array
11436 items:
11437 type: string
11438 interfaces:
11439 $ref: '#/components/schemas/PduInterfaces'
11440 additionalProperties: false
11441 K8sClusterNetList:
11442 type: array
11443 items:
11444 type: object
Gabriel Cubab77d0df2022-03-22 14:43:11 -0500[diff] [blame]11445 additionalProperties: false
11446 K8sClusterDeploymentMethods:
11447 type: object
11448 properties:
Gabriel Cubab77d0df2022-03-22 14:43:11 -0500[diff] [blame]11449 juju-bundle:
11450 type: boolean
11451 helm-chart-v3:
11452 type: boolean
11453 additionalProperties: false
11454 minProperties: 3
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11455 K8sClusterInfo:
11456 type: object
11457 properties:
11458 _id:
11459 type: string
11460 format: uuid
11461 schema_version:
11462 type: string
11463 format: X.Y[.Z]
11464 schema_type:
11465 type: string
11466 name:
11467 type: string
11468 description:
11469 type: string
11470 credentials:
11471 type: object
11472 additionalProperties: true
11473 vim_account:
11474 type: string
11475 format: uuid
11476 k8s_version:
11477 type: string
11478 nets:
11479 $ref: '#/components/schemas/K8sClusterNetList'
Gabriel Cubab77d0df2022-03-22 14:43:11 -0500[diff] [blame]11480 deployment_methods:
11481 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11482 namespace:
11483 type: string
11484 cni:
11485 type: array
11486 items:
11487 type: string
11488 ArrayOfK8sClusterInfo:
11489 type: array
11490 items:
11491 $ref: '#/components/schemas/K8sClusterInfo'
11492 CreateK8sClusterRequest:
11493 type: object
11494 properties:
11495 schema_version:
11496 type: string
11497 format: X.Y[.Z]
11498 schema_type:
11499 type: string
11500 name:
11501 type: string
11502 description:
11503 type: string
11504 credentials:
11505 type: object
11506 additionalProperties: true
11507 vim_account:
11508 type: string
11509 format: uuid
11510 k8s_version:
11511 type: string
11512 nets:
11513 $ref: '#/components/schemas/K8sClusterNetList'
11514 namespace:
11515 type: string
11516 cni:
11517 type: array
11518 items:
11519 type: string
11520 required:
11521 - name
11522 - credentials
11523 - vim_account
11524 - k8s_version
11525 - nets
11526 additionalProperties: false
11527 EditK8sClusterRequest:
11528 type: object
11529 properties:
11530 name:
11531 type: string
11532 description:
11533 type: string
11534 credentials:
11535 type: object
11536 additionalProperties: true
11537 vim_account:
11538 type: string
11539 format: uuid
11540 k8s_version:
11541 type: string
11542 nets:
11543 $ref: '#/components/schemas/K8sClusterNetList'
11544 namespace:
11545 type: string
11546 cni:
11547 type: array
11548 items:
11549 type: string
11550 additionalProperties: false
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]11551 VcaInfo:
11552 type: object
11553 properties:
11554 _id:
11555 type: string
11556 format: uuid
11557 schema_version:
11558 type: string
11559 format: X.Y[.Z]
11560 schema_type:
11561 type: string
11562 name:
11563 type: string
11564 description:
11565 type: string
11566 endpoints:
11567 type: string
11568 user:
11569 type: string
11570 secret:
11571 type: string
11572 cacert:
11573 type: string
11574 lxd-cloud:
11575 type: string
11576 lxd-credentials:
11577 type: string
11578 k8s-cloud:
11579 type: string
11580 k8s-credentials:
11581 type: string
11582 model-config:
11583 type: object
11584 additionalProperties: true
11585 ArrayOfVcaInfo:
11586 type: array
11587 items:
11588 $ref: '#/components/schemas/VcaInfo'
11589 CreateVcaRequest:
11590 type: object
11591 properties:
11592 schema_version:
11593 type: string
11594 format: X.Y[.Z]
11595 schema_type:
11596 type: string
11597 name:
11598 type: string
11599 description:
11600 type: string
11601 endpoints:
11602 type: string
11603 user:
11604 type: string
11605 secret:
11606 type: string
11607 cacert:
11608 type: string
11609 lxd-cloud:
11610 type: string
11611 lxd-credentials:
11612 type: string
11613 k8s-cloud:
11614 type: string
11615 k8s-credentials:
11616 type: string
11617 model-config:
11618 type: object
11619 additionalProperties: true
11620 required:
11621 - name
11622 - endpoints
11623 - user
11624 - secret
11625 - cacert
11626 - lxd-cloud
11627 - lxd-credentials
11628 - k8s-cloud
11629 - k8s-credentials
11630 additionalProperties: false
11631 EditVcaRequest:
11632 type: object
11633 properties:
11634 name:
11635 type: string
11636 description:
11637 type: string
11638 endpoints:
11639 type: string
11640 user:
11641 type: string
11642 secret:
11643 type: string
11644 cacert:
11645 type: string
11646 lxd-cloud:
11647 type: string
11648 lxd-credentials:
11649 type: string
11650 k8s-cloud:
11651 type: string
11652 k8s-credentials:
11653 type: string
11654 model-config:
11655 type: object
11656 additionalProperties: true
11657 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11658 K8sRepoType:
11659 type: string
11660 enum:
11661 - chart
11662 - bundle
11663 K8sRepoInfo:
11664 type: object
11665 properties:
11666 _id:
11667 type: string
11668 format: uuid
11669 name:
11670 type: string
11671 description:
11672 type: string
11673 type:
11674 $ref: '#/components/schemas/K8sRepoType'
11675 url:
11676 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11677 format: uri
garciadeblas8bb3cce2022-02-11 00:41:18 +0100[diff] [blame]11678 username:
11679 type: string
11680 description: repository username
11681 password:
11682 type: string
11683 description: repository password
11684 ca-file:
11685 type: string
11686 description: verify certificates of HTTPS-enabled servers using this CA bundle
11687 cert-file:
11688 type: string
11689 description: identify HTTPS client using this SSL certificate file
11690 skip-tls-verify:
11691 type: boolean
11692 description: skip tls certificate checks for the repository
11693 key-file:
11694 type: string
11695 description: identify HTTPS client using this SSL key file
garciadeblas0881dcf2023-10-20 12:00:08 +0200[diff] [blame]11696 oci:
11697 type: boolean
11698 default: false
11699 description: >
11700 Flag to indicate whether or not it is an OCI-enabled repo (default: false)
11701 required:
11702 - name
11703 - type
11704 - url
11705 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11706 ArrayOfK8sRepoInfo:
11707 type: array
11708 items:
11709 $ref: '#/components/schemas/K8sRepoInfo'
11710 CreateK8sRepoRequest:
11711 type: object
11712 properties:
11713 name:
11714 type: string
11715 description:
11716 type: string
11717 type:
11718 $ref: '#/components/schemas/K8sRepoType'
11719 url:
11720 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +0100[diff] [blame]11721 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]11722 required:
11723 - name
11724 - type
11725 - url
11726 additionalProperties: false
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]11727 NslcmSubscriptionResponse:
11728 type: object
11729 properties:
11730 id:
11731 type: string
11732 format: uuid
11733 filter:
11734 type: object
11735 CallbackUri:
11736 type: string
11737 format: uri
11738 _links:
11739 type: object
11740 NslcmSubscriptionInfo:
11741 type: object
11742 properties:
11743 _id:
11744 type: string
11745 format: uuid
11746 _admin:
11747 type: object
11748 schema_version:
11749 type: string
11750 format: 'X.Y[.Z]'
11751 CallbackUri:
11752 type: string
11753 format: uri
11754 filter:
11755 type: object
11756 authentication:
11757 $ref: '#/components/schemas/Authenticationschema'
11758 ArrayOfNslcmSubscriptionInfo:
11759 type: array
11760 items:
11761 $ref: '#/components/schemas/NslcmSubscriptionInfo'
11762 NsInstanceSubscriptionFilter:
11763 description: |
11764 used to identify the network service
11765 type: object
11766 oneOf:
11767 - $ref: '#/components/schemas/nsdIds'
11768 - $ref: '#/components/schemas/vnfdIds'
11769 - $ref: '#/components/schemas/pnfdIds'
11770 - $ref: '#/components/schemas/nsInstanceIds'
11771 - $ref: '#/components/schemas/nsInstanceNames'
11772 nsdIds:
11773 type: array
11774 items:
11775 type: string
11776 vnfdIds:
11777 type: array
11778 items:
11779 type: string
11780 pnfdIds:
11781 type: array
11782 items:
11783 type: string
11784 nsInstanceIds:
11785 type: array
11786 items:
11787 type: string
11788 nsInstanceNames:
11789 type: array
11790 items:
11791 type: string
11792 Nslcmsubschema:
11793 type: object
11794 properties:
11795 nsInstanceSubscriptionFilter:
11796 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
11797 notificationTypes:
11798 description: |
11799 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
11800 type: array
11801 items:
11802 type: string
11803 enum:
11804 - NsIdentifierCreationNotification
11805 - NsIdentifierDeletionNotification
11806 - NsLcmOperationOccurrenceNotification
11807 - NsChangeNotification
11808 operationTypes:
11809 type: array
11810 items:
11811 type: string
11812 enum:
11813 - INSTANTIATE
11814 - SCALE
11815 - TERMINATE
11816 - UPDATE
11817 - HEAL
11818 operationStates:
11819 type: array
11820 items:
11821 type: string
11822 enum:
11823 - PROCESSING
11824 - COMPLETED
11825 - PARTIALLY_COMPLETED
11826 - FAILED
11827 - FAILED_TEMP
11828 - ROLLING_BACK
11829 - ROLLED_BACK
11830 nsComponentTypes:
11831 type: array
11832 items:
11833 type: string
11834 enum:
11835 - VNF
11836 - NS
11837 - PNF
11838 lcmOpNameImpactingNsComponent:
11839 type: array
11840 items:
11841 type: string
11842 enum:
11843 - VNF_INSTANTIATE
11844 - VNF_SCALE
11845 - VNF_SCALE_TO_LEVEL
11846 - VNF_CHANGE_FLAVOUR
11847 - VNF_TERMINATE
11848 - VNF_HEAL
11849 - VNF_OPERATE
11850 - VNF_CHANGE_EXT_CONN
11851 - VNF_MODIFY_INFO
11852 - NS_INSTANTIATE
11853 - NS_SCALE
11854 - NS_UPDATE
11855 - NS_TERMINATE
11856 - NS_HEAL
11857 lcmOpOccStatusImpactingNsComponent:
11858 type: array
11859 items:
11860 type: string
11861 enum:
11862 - START
11863 - COMPLETED
11864 - PARTIALLY_COMPLETED
11865 - FAILED
11866 - ROLLED_BACK
11867 Authenticationschema:
11868 type: object
11869 properties:
11870 authType:
11871 type: string
11872 enum:
11873 - basic
11874 paramsBasic:
11875 type: object
11876 properties:
11877 userName:
11878 type: string
11879 password:
11880 type: string
11881 NslcmSubscriptionRequest:
11882 type: object
11883 properties:
11884 filter:
11885 $ref: '#/components/schemas/Nslcmsubschema'
11886 CallbackUri:
11887 type: string
11888 format: uri
11889 authentication:
11890 $ref: '#/components/schemas/Authenticationschema'
11891 required:
11892 - CallbackUri
Gabriel Cuba2c8be082023-11-14 16:52:01 -0500[diff] [blame]11893 CancelNSLCMOpOccRequest:
11894 type: object
11895 properties:
11896 cancelMode:
11897 type: string
11898 enum:
11899 - GRACEFUL
11900 - FORCEFUL
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]11901 operationHistory:
11902 type: array
11903 items:
11904 type: object
11905 properties:
11906 operationType:
11907 type: string
11908 gitOperationInfo:
11909 type: string
11910 op_id:
11911 type: integer
11912 result:
11913 type: string
11914 workflowState:
11915 type: string
11916 resourceState:
11917 type: string
11918 operationState:
11919 type: string
11920 creationDate:
11921 type: string
11922 endDate:
11923 type: string
11924 operationParams:
11925 type: object
11926 ArrayOfClusterInfo:
11927 type: array
11928 items:
11929 $ref: '#/components/schemas/ClusterInfo'
11930 ClusterInfo:
11931 type: object
11932 properties:
11933 _id:
11934 type: integer
11935 name:
11936 type: string
11937 vim_account:
11938 type: string
11939 location:
11940 type: string
11941 k8s_version:
11942 type: string
11943 node_size:
11944 type: string
11945 node_count:
11946 type: integer
11947 description:
11948 type: string
11949 region_name:
11950 type: string
11951 resource_group:
11952 type: string
11953 infra_controller_profiles:
11954 type: array
11955 items:
11956 type: integer
11957 infra_config_profiles:
11958 type: array
11959 items:
11960 type: integer
11961 resource_profiles:
11962 type: array
11963 items:
11964 type: integer
11965 app_profiles:
11966 type: array
11967 items:
11968 type: integer
11969 credentials:
11970 type: object
11971 git_name:
11972 type: string
11973 age_privkey:
11974 type: string
11975 age_pubkey:
11976 type: string
11977 operationHistory:
11978 $ref: '#/components/schemas/operationHistory'
11979 current_operation:
11980 type: integer
11981 state:
11982 type: string
11983 operatingState:
11984 type: string
11985 resourceState:
11986 type: string
11987 created:
11988 type: boolean
11989 bootstrap:
11990 type: boolean
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]11991 CreateClusterInfo:
11992 type: object
11993 properties:
11994 name:
11995 type: string
11996 vim_account:
11997 type: string
11998 location:
11999 type: string
12000 k8s_version:
12001 type: string
12002 node_size:
12003 type: string
12004 node_count:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12005 type: integer
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12006 description:
12007 type: string
12008 region_name:
12009 type: string
12010 resource_group:
12011 type: string
12012 infra_controller_profiles:
12013 type: array
12014 items:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12015 type: integer
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12016 infra_config_profiles:
12017 type: array
12018 items:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12019 type: integer
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12020 resource_profiles:
12021 type: array
12022 items:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12023 type: integer
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12024 app_profiles:
12025 type: array
12026 items:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12027 type: integer
shahithyacb252bb2024-11-18 07:44:02 +0000[diff] [blame]12028 RegisterClusterInfo:
12029 type: object
12030 properties:
12031 name:
12032 type: string
12033 credentials:
12034 type: string
12035 format: yaml|json
12036 vim_account:
12037 type: string
12038 description:
12039 type: string
12040 bootstrap:
12041 type: boolean
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12042 ClusterCreds:
12043 type: string
12044 format: yaml|json
shahithya3d9a1c42024-11-18 07:59:53 +0000[diff] [blame]12045 ClusterEditRequest:
12046 type: object
12047 properties:
12048 name:
12049 type: string
12050 description:
12051 type: string
12052 UpdateClusterRequest:
12053 type: object
12054 properties:
12055 k8s_version:
12056 type: string
12057 node_count:
12058 type: integer
12059 node_size:
12060 type: string
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12061 ScaleNodeInfo:
12062 type: object
12063 properties:
12064 node_count:
12065 type: integer
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12066 CreateProfileInfo:
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12067 type: object
12068 properties:
12069 name:
12070 type: string
12071 description:
12072 type: string
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12073 ArrayOfProfileInfo:
12074 type: array
12075 items:
12076 $ref: '#/components/schemas/ProfileInfo'
12077 ProfileInfo:
12078 type: object
12079 properties:
12080 _id:
12081 type: integer
12082 name:
12083 type: string
12084 description:
12085 type: string
12086 default:
12087 type: string
12088 git_name:
12089 type: string
12090 state:
12091 type: string
12092 operatingState:
12093 type: string
12094 resourceState:
12095 type: string
12096 current_operation:
12097 type: integer
12098 operationHistory:
12099 $ref: '#/components/schemas/operationHistory'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12100 UpgradeClusterInfo:
12101 type: object
12102 properties:
12103 k8s_version:
12104 type: string
12105 AttachDetachProfile:
12106 type: object
12107 properties:
12108 add_profile:
12109 type: array
12110 items:
12111 type: object
12112 properties:
12113 _id:
12114 type: string
12115 remove_profile:
12116 type: array
12117 items:
12118 type: object
12119 properties:
12120 _id:
12121 type: string
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12122 OkaPackageList:
12123 type: object
12124 properties:
12125 _id:
12126 type: integer
12127 name:
12128 type: string
12129 description:
12130 type: string
12131 git_name:
12132 type: string
12133 state:
12134 type: string
12135 operatingState:
12136 type: string
12137 resourceState:
12138 type: string
12139 current_operation:
12140 type: integer
12141 operationHistory:
12142 $ref: '#/components/schemas/operationHistory'
12143 ArrayOfOkaPackage:
12144 type: array
12145 items:
12146 $ref: '#/components/schemas/OkaPackageList'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12147 OkaPackage:
12148 type: object
12149 properties:
12150 name:
12151 type: string
12152 description:
12153 type: string
12154 package:
12155 type: string
12156 format: binary
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12157 Ksu:
12158 type: object
12159 properties:
12160 name:
12161 type: string
12162 description:
12163 type: string
12164 profile:
12165 type: object
12166 properties:
12167 id:
12168 type: string
12169 profile_type:
12170 type: string
12171 oka:
12172 type: array
12173 items:
12174 type: object
12175 properties:
12176 _id:
12177 type: string
12178 sw_catalog_path:
12179 type: string
12180 transformation:
12181 type: object
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12182 ArrayOfKsu:
12183 type: object
12184 properties:
12185 ksus:
12186 type: array
12187 items:
12188 $ref: '#/components/schemas/Ksu'
12189 KsuList:
12190 type: object
12191 properties:
12192 _id:
12193 type: integer
12194 name:
12195 type: string
12196 description:
12197 type: string
12198 profile:
12199 type: object
12200 properties:
12201 id:
12202 type: string
12203 profile_type:
12204 type: string
12205 oka:
12206 type: array
12207 items:
12208 type: object
12209 properties:
12210 _id:
12211 type: string
12212 sw_catalog_path:
12213 type: string
12214 transformation:
12215 type: object
12216 git_name:
12217 type: string
12218 state:
12219 type: string
12220 operatingState:
12221 type: string
12222 resourceState:
12223 type: string
12224 current_operation:
12225 type: integer
12226 operationHistory:
12227 $ref: '#/components/schemas/operationHistory'
12228 ArrayOfKsuList:
12229 type: array
12230 items:
12231 $ref: '#/components/schemas/KsuList'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12232 DeleteMultipleKsu:
12233 type: object
12234 properties:
12235 ksus:
12236 type: array
12237 items:
12238 type: object
12239 properties:
12240 _id:
12241 type: string
12242 CloneKsu:
12243 type: object
12244 properties:
12245 name:
12246 type: string
12247 profile:
12248 type: object
12249 properties:
12250 _id:
12251 type: string
12252 profile_type:
12253 type: string
12254 MoveKsu:
12255 type: object
12256 properties:
12257 profile:
12258 type: object
12259 properties:
12260 _id:
12261 type: string
12262 profile_type:
12263 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12264 # END SCHEMAS
12265
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]12266 requestBodies:
12267 CreateNsdInfoRequest:
12268 content:
12269 application/json:
12270 schema:
12271 $ref: '#/components/schemas/CreateNsdInfoRequest'
12272 application/yaml:
12273 schema:
12274 $ref: '#/components/schemas/CreateNsdInfoRequest'
12275 NsdInfoModifications:
12276 content:
12277 application/json:
12278 schema:
12279 $ref: '#/components/schemas/NsdInfoModifications'
12280 application/yaml:
12281 schema:
12282 $ref: '#/components/schemas/NsdInfoModifications'
Atul Agarwal4cd9e952021-05-20 09:24:26 +0000[diff] [blame]12283 AlarmInfoModifications:
12284 content:
12285 application/json:
12286 schema:
12287 $ref: '#/components/schemas/AlarmInfoModifications'
12288 application/yaml:
12289 schema:
12290 $ref: '#/components/schemas/AlarmInfoModifications'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12291 NsDescriptor:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]12292 content:
12293 text/plain:
12294 schema:
12295 $ref: '#/components/schemas/NsDescriptor'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12296 NsPackage:
12297 content:
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]12298 application/zip:
12299 schema:
12300 $ref: '#/components/schemas/NsPackage'
kayal2001ae8f00a2024-06-24 18:04:47 +0530[diff] [blame]12301 CreateNsConfigTemplateInfoRequest:
12302 content:
12303 application/json:
12304 schema:
12305 $ref: '#/components/schemas/CreateNsdInfoRequest'
12306 application/yaml:
12307 schema:
12308 $ref: '#/components/schemas/CreateNsdInfoRequest'
12309 NsConfigTemplateInfoModifications:
12310 content:
12311 application/json:
12312 schema:
12313 $ref: '#/components/schemas/NsdInfoModifications'
12314 application/yaml:
12315 schema:
12316 $ref: '#/components/schemas/NsdInfoModifications'
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]12317 CreateVnfPkgInfoRequest:
12318 content:
12319 application/json:
12320 schema:
12321 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
12322 application/yaml:
12323 schema:
12324 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
12325 VnfPkgInfoModifications:
12326 content:
12327 application/json:
12328 schema:
12329 $ref: '#/components/schemas/VnfPkgInfoModifications'
12330 application/yaml:
12331 schema:
12332 $ref: '#/components/schemas/VnfPkgInfoModifications'
12333 VnfPackage:
12334 content:
12335 application/zip:
12336 schema:
12337 $ref: '#/components/schemas/VnfPackage'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12338 VnfDescriptor:
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]12339 content:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12340 text/plain:
garciadeblas63fe88c2018-02-28 19:32:41 +0100[diff] [blame]12341 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12342 $ref: '#/components/schemas/VnfDescriptor'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12343 # CreateNsRequest:
12344 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]12345 InstantiateNsRequest:
12346 content:
12347 application/json:
12348 schema:
12349 $ref: '#/components/schemas/InstantiateNsRequest'
12350 application/yaml:
12351 schema:
12352 $ref: '#/components/schemas/InstantiateNsRequest'
garciadeblasb5a065f2022-02-11 00:27:47 +0100[diff] [blame]12353 HealNsRequest:
12354 content:
12355 application/json:
12356 schema:
12357 $ref: '#/components/schemas/HealNsRequest'
12358 application/yaml:
12359 schema:
12360 $ref: '#/components/schemas/HealNsRequest'
elumalai4b120f12022-04-28 16:44:35 +0530[diff] [blame]12361 NSinstanceMigrateRequest:
12362 content:
12363 application/json:
12364 schema:
12365 $ref: '#/components/schemas/NSinstanceMigrateRequest'
12366 application/yaml:
12367 schema:
12368 $ref: '#/components/schemas/NSinstanceMigrateRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]12369 ScaleNsRequest:
12370 content:
12371 application/json:
12372 schema:
12373 $ref: '#/components/schemas/ScaleNsRequest'
12374 application/yaml:
12375 schema:
12376 $ref: '#/components/schemas/ScaleNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +0100[diff] [blame]12377 TerminateNsRequest:
12378 content:
12379 application/json:
12380 schema:
12381 $ref: '#/components/schemas/TerminateNsRequest'
12382 application/yaml:
12383 schema:
12384 $ref: '#/components/schemas/TerminateNsRequest'
elumalaif2eb5e72022-03-21 19:44:39 +0530[diff] [blame]12385 UpdateNsRequest:
12386 content:
12387 application/json:
12388 schema:
12389 $ref: '#/components/schemas/UpdateNsRequest'
12390 application/yaml:
12391 schema:
12392 $ref: '#/components/schemas/UpdateNsRequest'
adurtiafd75092024-05-31 14:52:18 +0530[diff] [blame]12393 MultiNsTerminateRequest:
12394 content:
12395 application/json:
12396 schema:
12397 $ref: '#/components/schemas/MultiNsTerminateRequest'
12398 application/yaml:
12399 schema:
12400 $ref: '#/components/schemas/MultiNsTerminateRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12401 # CreateNSinstanceContentRequest:
12402 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12403 CreateNstInfoRequest:
12404 content:
12405 application/json:
12406 schema:
12407 $ref: '#/components/schemas/CreateNstInfoRequest'
12408 application/yaml:
12409 schema:
12410 $ref: '#/components/schemas/CreateNstInfoRequest'
12411 NetSliceTemplate:
12412 content:
12413 text/plain:
12414 schema:
12415 $ref: '#/components/schemas/NetSliceTemplate'
12416 NetSlicePackage:
12417 content:
12418 application/zip:
12419 schema:
12420 $ref: '#/components/schemas/NetSlicePackage'
12421 NstInfoModifications:
12422 content:
12423 application/json:
12424 schema:
12425 $ref: '#/components/schemas/NstInfoModifications'
12426 application/yaml:
12427 schema:
12428 $ref: '#/components/schemas/NstInfoModifications'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12429 # CreateNsiRequest:
12430 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12431 InstantiateNsiRequest:
12432 content:
12433 application/json:
12434 schema:
12435 $ref: '#/components/schemas/InstantiateNsiRequest'
12436 application/yaml:
12437 schema:
12438 $ref: '#/components/schemas/InstantiateNsiRequest'
12439 TerminateNsiRequest:
12440 content:
12441 application/json:
12442 schema:
12443 $ref: '#/components/schemas/TerminateNsiRequest'
12444 application/yaml:
12445 schema:
12446 $ref: '#/components/schemas/TerminateNsiRequest'
12447 NsiActionRequest:
12448 content:
12449 application/json:
12450 schema:
12451 $ref: '#/components/schemas/NsiActionRequest'
12452 application/yaml:
12453 schema:
12454 $ref: '#/components/schemas/NsiActionRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12455 # CreateNsiContentRequest:
12456 # Substituted by InstantiateNsiRequest
12457 CreateTokenRequest:
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12458 content:
12459 application/json:
12460 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12461 $ref: '#/components/schemas/CreateTokenRequest'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12462 application/yaml:
12463 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12464 $ref: '#/components/schemas/CreateTokenRequest'
12465 CreateUserRequest:
12466 content:
12467 application/json:
12468 schema:
12469 $ref: '#/components/schemas/CreateUserRequest'
12470 application/yaml:
12471 schema:
12472 $ref: '#/components/schemas/CreateUserRequest'
12473 EditUserRequest:
12474 content:
12475 application/json:
12476 schema:
12477 $ref: '#/components/schemas/EditUserRequest'
12478 application/yaml:
12479 schema:
12480 $ref: '#/components/schemas/EditUserRequest'
12481 CreateProjectRequest:
12482 content:
12483 application/json:
12484 schema:
12485 $ref: '#/components/schemas/CreateProjectRequest'
12486 application/yaml:
12487 schema:
12488 $ref: '#/components/schemas/CreateProjectRequest'
12489 EditProjectRequest:
12490 content:
12491 application/json:
12492 schema:
12493 $ref: '#/components/schemas/EditProjectRequest'
12494 application/yaml:
12495 schema:
12496 $ref: '#/components/schemas/EditProjectRequest'
12497 CreateRoleRequest:
12498 content:
12499 application/json:
12500 schema:
12501 $ref: '#/components/schemas/CreateRoleRequest'
12502 application/yaml:
12503 schema:
12504 $ref: '#/components/schemas/CreateRoleRequest'
12505 EditRoleRequest:
12506 content:
12507 application/json:
12508 schema:
12509 $ref: '#/components/schemas/EditRoleRequest'
12510 application/yaml:
12511 schema:
12512 $ref: '#/components/schemas/EditRoleRequest'
12513 CreateVimRequest:
12514 content:
12515 application/json:
12516 schema:
12517 $ref: '#/components/schemas/CreateVimRequest'
12518 application/yaml:
12519 schema:
12520 $ref: '#/components/schemas/CreateVimRequest'
12521 EditVimRequest:
12522 content:
12523 application/json:
12524 schema:
12525 $ref: '#/components/schemas/EditVimRequest'
12526 application/yaml:
12527 schema:
12528 $ref: '#/components/schemas/EditVimRequest'
12529 CreateWimRequest:
12530 content:
12531 application/json:
12532 schema:
12533 $ref: '#/components/schemas/CreateWimRequest'
12534 application/yaml:
12535 schema:
12536 $ref: '#/components/schemas/CreateWimRequest'
12537 EditWimRequest:
12538 content:
12539 application/json:
12540 schema:
12541 $ref: '#/components/schemas/EditWimRequest'
12542 application/yaml:
12543 schema:
12544 $ref: '#/components/schemas/EditWimRequest'
12545 CreateSdnRequest:
12546 content:
12547 application/json:
12548 schema:
12549 $ref: '#/components/schemas/CreateSdnRequest'
12550 application/yaml:
12551 schema:
12552 $ref: '#/components/schemas/CreateSdnRequest'
12553 EditSdnRequest:
12554 content:
12555 application/json:
12556 schema:
12557 $ref: '#/components/schemas/EditSdnRequest'
12558 application/yaml:
12559 schema:
12560 $ref: '#/components/schemas/EditSdnRequest'
12561 CreatePduRequest:
12562 content:
12563 application/json:
12564 schema:
12565 $ref: '#/components/schemas/CreatePduRequest'
12566 application/yaml:
12567 schema:
12568 $ref: '#/components/schemas/CreatePduRequest'
12569 EditPduRequest:
12570 content:
12571 application/json:
12572 schema:
12573 $ref: '#/components/schemas/EditPduRequest'
12574 application/yaml:
12575 schema:
12576 $ref: '#/components/schemas/EditPduRequest'
12577 CreateK8sClusterRequest:
12578 content:
12579 application/json:
12580 schema:
12581 $ref: '#/components/schemas/CreateK8sClusterRequest'
12582 application/yaml:
12583 schema:
12584 $ref: '#/components/schemas/CreateK8sClusterRequest'
12585 EditK8sClusterRequest:
12586 content:
12587 application/json:
12588 schema:
12589 $ref: '#/components/schemas/EditK8sClusterRequest'
12590 application/yaml:
12591 schema:
12592 $ref: '#/components/schemas/EditK8sClusterRequest'
David Garciaaf38fce2021-05-04 12:48:04 +0200[diff] [blame]12593 CreateVcaRequest:
12594 content:
12595 application/json:
12596 schema:
12597 $ref: '#/components/schemas/CreateVcaRequest'
12598 application/yaml:
12599 schema:
12600 $ref: '#/components/schemas/CreateVcaRequest'
12601 EditVcaRequest:
12602 content:
12603 application/json:
12604 schema:
12605 $ref: '#/components/schemas/EditVcaRequest'
12606 application/yaml:
12607 schema:
12608 $ref: '#/components/schemas/EditVcaRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +0200[diff] [blame]12609 CreateK8sRepoRequest:
12610 content:
12611 application/json:
12612 schema:
12613 $ref: '#/components/schemas/CreateK8sRepoRequest'
12614 application/yaml:
12615 schema:
12616 $ref: '#/components/schemas/CreateK8sRepoRequest'
preethika.p31b3a802020-07-28 09:14:01 +0000[diff] [blame]12617 NslcmSubscriptionRequest:
12618 content:
12619 application/json:
12620 schema:
12621 $ref: '#/components/schemas/NslcmSubscriptionRequest'
12622 application/yaml:
12623 schema:
12624 $ref: '#/components/schemas/NslcmSubscriptionRequest'
Gabriel Cuba2c8be082023-11-14 16:52:01 -0500[diff] [blame]12625 CancelNSLCMOpOccRequest:
12626 content:
12627 application/json:
12628 schema:
12629 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
12630 application/yaml:
12631 schema:
12632 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12633 CreateClusterInfo:
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12634 content:
12635 application/json:
12636 schema:
12637 $ref: '#/components/schemas/CreateClusterInfo'
12638 application/yaml:
12639 schema:
12640 $ref: '#/components/schemas/CreateClusterInfo'
shahithyacb252bb2024-11-18 07:44:02 +0000[diff] [blame]12641 RegisterClusterInfo:
12642 content:
12643 application/json:
12644 schema:
12645 $ref: '#/components/schemas/RegisterClusterInfo'
12646 application/yaml:
12647 schema:
12648 $ref: '#/components/schemas/RegisterClusterInfo'
shahithya3d9a1c42024-11-18 07:59:53 +0000[diff] [blame]12649 ClusterEditRequest:
12650 content:
12651 application/json:
12652 schema:
12653 $ref: '#/components/schemas/ClusterEditRequest'
12654 application/yaml:
12655 schema:
12656 $ref: '#/components/schemas/ClusterEditRequest'
12657 UpdateClusterRequest:
12658 content:
12659 application/json:
12660 schema:
12661 $ref: '#/components/schemas/UpdateClusterRequest'
12662 application/yaml:
12663 schema:
12664 $ref: '#/components/schemas/UpdateClusterRequest'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12665 ScaleNode:
12666 content:
12667 application/json:
12668 schema:
12669 $ref: '#/components/schemas/ScaleNodeInfo'
12670 application/yaml:
12671 schema:
12672 $ref: '#/components/schemas/ScaleNodeInfo'
12673 UpgradeCluster:
12674 content:
12675 application/json:
12676 schema:
12677 $ref: '#/components/schemas/UpgradeClusterInfo'
12678 application/yaml:
12679 schema:
12680 $ref: '#/components/schemas/UpgradeClusterInfo'
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12681 CreateProfileInfo:
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12682 content:
12683 application/json:
12684 schema:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12685 $ref: '#/components/schemas/CreateProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12686 application/yaml:
12687 schema:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12688 $ref: '#/components/schemas/CreateProfileInfo'
12689 PatchProfileInfo:
12690 content:
12691 application/json:
12692 schema:
12693 $ref: '#/components/schemas/CreateProfileInfo'
12694 application/yaml:
12695 schema:
12696 $ref: '#/components/schemas/CreateProfileInfo'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12697 AttachDetachProfile:
12698 content:
12699 application/json:
12700 schema:
12701 $ref: '#/components/schemas/AttachDetachProfile'
12702 application/yaml:
12703 schema:
12704 $ref: '#/components/schemas/AttachDetachProfile'
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12705 ArrayOfKsu:
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12706 content:
12707 application/json:
12708 schema:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12709 $ref: '#/components/schemas/ArrayOfKsu'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12710 application/yaml:
12711 schema:
shahithya46b9eb02024-10-29 09:14:49 +0000[diff] [blame]12712 $ref: '#/components/schemas/ArrayOfKsu'
yshahfe8c59f2024-07-05 14:00:08 +0000[diff] [blame]12713 Ksu:
12714 content:
12715 application/json:
12716 schema:
12717 $ref: '#/components/schemas/Ksu'
12718 application/yaml:
12719 schema:
12720 $ref: '#/components/schemas/Ksu'
12721 DeleteMultipleKsu:
12722 content:
12723 application/json:
12724 schema:
12725 $ref: '#/components/schemas/DeleteMultipleKsu'
12726 application/yaml:
12727 schema:
12728 $ref: '#/components/schemas/DeleteMultipleKsu'
12729 CloneKsu:
12730 content:
12731 application/json:
12732 schema:
12733 $ref: '#/components/schemas/CloneKsu'
12734 application/yaml:
12735 schema:
12736 $ref: '#/components/schemas/CloneKsu'
12737 MoveKsu:
12738 content:
12739 application/json:
12740 schema:
12741 $ref: '#/components/schemas/MoveKsu'
12742 application/yaml:
12743 schema:
12744 $ref: '#/components/schemas/MoveKsu'
delacruzramfb52ade2019-10-07 16:46:59 +0200[diff] [blame]12745 # END REQUEST BODIES
12746
garciadeblas60e2ee92018-02-27 19:09:51 +0100[diff] [blame]12747 securitySchemes:
12748 bearerAuth:
12749 type: http
12750 scheme: bearer