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