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