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