blob: 6c1b96601cb0076bd0c9f353175c811d7f48ee61 [file] [log] [blame]
garciadeblas60e2ee92018-02-27 19:09:51 +01001openapi: 3.0.0
delacruzramfb52ade2019-10-07 16:46:59 +02002
garciadeblas60e2ee92018-02-27 19:09:51 +01003servers:
4 - description: OSM NB API
garciadeblas00c2eb92020-02-28 15:24:27 +01005 url: 'https://osm.etsi.org/nbapi/v1.0.0'
delacruzramfb52ade2019-10-07 16:46:59 +02006
garciadeblas60e2ee92018-02-27 19:09:51 +01007info:
8 description: |
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
Felipe Vicens69385fc2019-10-09 10:58:57 +020010 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 +010013 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 +020020
garciadeblas60e2ee92018-02-27 19:09:51 +010021tags:
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 +020028 - 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 +010032 - 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 +020035 description: Management operations of PDUs
garciadeblas77849982020-02-28 15:41:43 +010036 - 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 +020044 - name: 'Admin'
45 description: Management operations of Administration items
delacruzramfb52ade2019-10-07 16:46:59 +020046
47security:
48 - bearerAuth: []
49
garciadeblas60e2ee92018-02-27 19:09:51 +010050paths:
delacruzramfb52ade2019-10-07 16:46:59 +020051
52# BEGIN NS Packages
garciadeblas12fcc4b2018-03-02 16:12:02 +010053 '/nsd/v1/ns_descriptors':
garciadeblas60e2ee92018-02-27 19:09:51 +010054 get:
55 tags:
56 - "NS packages"
57 summary: Query information about multiple NS descriptor resources
58 description: Query information about multiple NS descriptor resources
59 operationId: getNSDs
garciadeblas60e2ee92018-02-27 19:09:51 +010060 responses:
61 '200':
62 description: OK
63 content:
64 application/json:
65 schema:
66 $ref: '#/components/schemas/ArrayOfNsdInfo'
67 application/yaml:
68 schema:
69 $ref: '#/components/schemas/ArrayOfNsdInfo'
70 '400':
71 $ref: '#/components/responses/BadRequest'
72 '401':
73 $ref: '#/components/responses/Unauthorized'
74 '403':
75 $ref: '#/components/responses/Forbidden'
76 '404':
77 $ref: '#/components/responses/NotFound'
78 '405':
79 $ref: '#/components/responses/MethodNotAllowed'
80 '406':
81 $ref: '#/components/responses/NotAcceptable'
82 '409':
83 $ref: '#/components/responses/Conflict'
84 '422':
85 $ref: '#/components/responses/UnprocessableEntity'
86 '500':
87 $ref: '#/components/responses/InternalServerError'
88 '503':
89 $ref: '#/components/responses/ServiceUnavailable'
90 '5XX':
91 $ref: '#/components/responses/UnexpectedError'
92 default:
93 $ref: '#/components/responses/UnexpectedError'
94 post:
95 tags:
96 - "NS packages"
97 summary: Create a new NS descriptor resource
98 description: Create a new NS descriptor resource
99 operationId: addNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100100 requestBody:
101 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
102 responses:
103 '201':
104 description: Created
garciadeblas63fe88c2018-02-28 19:32:41 +0100105 headers:
106 Location:
107 schema:
108 type: string
109 format: uri
garciadeblas60e2ee92018-02-27 19:09:51 +0100110 content:
111 application/json:
112 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200113 $ref: '#/components/schemas/ObjectId'
garciadeblas60e2ee92018-02-27 19:09:51 +0100114 application/yaml:
115 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200116 $ref: '#/components/schemas/ObjectId'
garciadeblas60e2ee92018-02-27 19:09:51 +0100117 '400':
118 $ref: '#/components/responses/BadRequest'
119 '401':
120 $ref: '#/components/responses/Unauthorized'
121 '403':
122 $ref: '#/components/responses/Forbidden'
123 '404':
124 $ref: '#/components/responses/NotFound'
125 '405':
126 $ref: '#/components/responses/MethodNotAllowed'
127 '406':
128 $ref: '#/components/responses/NotAcceptable'
129 '409':
130 $ref: '#/components/responses/Conflict'
131 '422':
132 $ref: '#/components/responses/UnprocessableEntity'
133 '500':
134 $ref: '#/components/responses/InternalServerError'
135 '503':
136 $ref: '#/components/responses/ServiceUnavailable'
137 '5XX':
138 $ref: '#/components/responses/UnexpectedError'
139 default:
140 $ref: '#/components/responses/UnexpectedError'
141 '/nsd/v1/ns_descriptors/{nsdInfoId}':
delacruzramfb52ade2019-10-07 16:46:59 +0200142 parameters:
143 - name: nsdInfoId
144 in: path
145 required: true
146 description: NSD Info ID
147 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200148 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +0100149 get:
150 tags:
151 - "NS packages"
152 summary: Read information about an individual NS descriptor resource
153 description: Read information about an individual NS descriptor resource
154 operationId: getNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100155 responses:
156 '200':
157 description: OK
158 content:
159 application/json:
160 schema:
161 $ref: '#/components/schemas/NsdInfo'
162 application/yaml:
163 schema:
164 $ref: '#/components/schemas/NsdInfo'
165 '400':
166 $ref: '#/components/responses/BadRequest'
167 '401':
168 $ref: '#/components/responses/Unauthorized'
169 '403':
170 $ref: '#/components/responses/Forbidden'
171 '404':
172 $ref: '#/components/responses/NotFound'
173 '405':
174 $ref: '#/components/responses/MethodNotAllowed'
175 '406':
176 $ref: '#/components/responses/NotAcceptable'
177 '409':
178 $ref: '#/components/responses/Conflict'
179 '422':
180 $ref: '#/components/responses/UnprocessableEntity'
181 '500':
182 $ref: '#/components/responses/InternalServerError'
183 '503':
184 $ref: '#/components/responses/ServiceUnavailable'
185 '5XX':
186 $ref: '#/components/responses/UnexpectedError'
187 default:
188 $ref: '#/components/responses/UnexpectedError'
189 delete:
190 tags:
191 - "NS packages"
192 summary: Delete an individual NS descriptor resource
193 description: Delete an individual NS descriptor resource
194 operationId: deleteNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100195 responses:
196 '204':
197 description: No Content
198 '400':
199 $ref: '#/components/responses/BadRequest'
200 '401':
201 $ref: '#/components/responses/Unauthorized'
202 '403':
203 $ref: '#/components/responses/Forbidden'
204 '404':
205 $ref: '#/components/responses/NotFound'
206 '405':
207 $ref: '#/components/responses/MethodNotAllowed'
208 '406':
209 $ref: '#/components/responses/NotAcceptable'
210 '409':
211 $ref: '#/components/responses/Conflict'
212 '422':
213 $ref: '#/components/responses/UnprocessableEntity'
214 '500':
215 $ref: '#/components/responses/InternalServerError'
216 '503':
217 $ref: '#/components/responses/ServiceUnavailable'
218 '5XX':
219 $ref: '#/components/responses/UnexpectedError'
220 default:
221 $ref: '#/components/responses/UnexpectedError'
222 patch:
223 tags:
224 - "NS packages"
delacruzramfb52ade2019-10-07 16:46:59 +0200225 summary: Modify the data of an individual NS descriptor resource
226 description: Modify the data of an individual NS descriptor resource
garciadeblas60e2ee92018-02-27 19:09:51 +0100227 operationId: updateNSD
garciadeblas60e2ee92018-02-27 19:09:51 +0100228 requestBody:
229 $ref: '#/components/requestBodies/NsdInfoModifications'
230 responses:
delacruzramfb52ade2019-10-07 16:46:59 +0200231 '204':
232 description: No Content
garciadeblas60e2ee92018-02-27 19:09:51 +0100233 '400':
234 $ref: '#/components/responses/BadRequest'
235 '401':
236 $ref: '#/components/responses/Unauthorized'
237 '403':
238 $ref: '#/components/responses/Forbidden'
239 '404':
240 $ref: '#/components/responses/NotFound'
241 '405':
242 $ref: '#/components/responses/MethodNotAllowed'
243 '406':
244 $ref: '#/components/responses/NotAcceptable'
245 '409':
246 $ref: '#/components/responses/Conflict'
247 '422':
248 $ref: '#/components/responses/UnprocessableEntity'
249 '500':
250 $ref: '#/components/responses/InternalServerError'
251 '503':
252 $ref: '#/components/responses/ServiceUnavailable'
253 '5XX':
254 $ref: '#/components/responses/UnexpectedError'
255 default:
256 $ref: '#/components/responses/UnexpectedError'
257 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
delacruzramfb52ade2019-10-07 16:46:59 +0200258 parameters:
259 - name: nsdInfoId
260 in: path
261 required: true
262 description: NSD Info ID
263 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200264 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +0100265 get:
266 tags:
267 - "NS packages"
268 summary: Fetch the content of a NSD
269 description: Fetch the content of a NSD
270 operationId: getNSDcontent
garciadeblas60e2ee92018-02-27 19:09:51 +0100271 responses:
272 '200':
273 description: OK
delacruzramfb52ade2019-10-07 16:46:59 +0200274 content:
275 application/zip:
276 schema:
277 $ref: '#/components/schemas/NsPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100278 '206':
279 description: Partial Content
280 headers:
281 Content-Range:
282 schema:
283 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200284 content:
285 application/zip:
286 schema:
287 $ref: '#/components/schemas/NsPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100288 '400':
289 $ref: '#/components/responses/BadRequest'
290 '401':
291 $ref: '#/components/responses/Unauthorized'
292 '403':
293 $ref: '#/components/responses/Forbidden'
294 '404':
295 $ref: '#/components/responses/NotFound'
296 '405':
297 $ref: '#/components/responses/MethodNotAllowed'
298 '406':
299 $ref: '#/components/responses/NotAcceptable'
300 '409':
301 $ref: '#/components/responses/Conflict'
302 '422':
303 $ref: '#/components/responses/UnprocessableEntity'
304 '500':
305 $ref: '#/components/responses/InternalServerError'
306 '503':
307 $ref: '#/components/responses/ServiceUnavailable'
308 '5XX':
309 $ref: '#/components/responses/UnexpectedError'
310 default:
311 $ref: '#/components/responses/UnexpectedError'
312 put:
313 tags:
314 - "NS packages"
315 summary: Upload the content of a NSD
316 description: Upload the content of a NSD
317 operationId: updateNSDcontent
garciadeblas60e2ee92018-02-27 19:09:51 +0100318 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +0200319 $ref: '#/components/requestBodies/NsPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +0100320 responses:
321 '202':
322 description: Accepted
323 '204':
324 description: No Content
325 '400':
326 $ref: '#/components/responses/BadRequest'
327 '401':
328 $ref: '#/components/responses/Unauthorized'
329 '403':
330 $ref: '#/components/responses/Forbidden'
331 '404':
332 $ref: '#/components/responses/NotFound'
333 '405':
334 $ref: '#/components/responses/MethodNotAllowed'
335 '406':
336 $ref: '#/components/responses/NotAcceptable'
337 '409':
338 $ref: '#/components/responses/Conflict'
339 '422':
340 $ref: '#/components/responses/UnprocessableEntity'
341 '500':
342 $ref: '#/components/responses/InternalServerError'
343 '503':
344 $ref: '#/components/responses/ServiceUnavailable'
345 '5XX':
346 $ref: '#/components/responses/UnexpectedError'
347 default:
348 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +0200349 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
350 parameters:
351 - name: nsdInfoId
352 in: path
353 required: true
354 description: NS Package ID
355 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200356 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200357 - name: artifactPath
358 in: path
359 required: true
360 description: Artifact Path
361 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200362 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200363 get:
364 tags:
365 - "NS packages"
366 summary: Fetch individual NS package artifact
367 description: Fetch individual NS package artifact
368 operationId: getNsPkgArtifact
369 responses:
370 '200':
371 description: OK
372 content:
373 application/octet-stream:
374 schema:
375 type: string
376 format: binary
377 '206':
378 description: Partial Content
379 headers:
380 Content-Range:
381 schema:
382 type: string
383 content:
384 application/octet-stream:
385 schema:
386 type: string
387 format: binary
388 '400':
389 $ref: '#/components/responses/BadRequest'
390 '401':
391 $ref: '#/components/responses/Unauthorized'
392 '403':
393 $ref: '#/components/responses/Forbidden'
394 '404':
395 $ref: '#/components/responses/NotFound'
396 '405':
397 $ref: '#/components/responses/MethodNotAllowed'
398 '406':
399 $ref: '#/components/responses/NotAcceptable'
400 '409':
401 $ref: '#/components/responses/Conflict'
402 '422':
403 $ref: '#/components/responses/UnprocessableEntity'
404 '500':
405 $ref: '#/components/responses/InternalServerError'
406 '503':
407 $ref: '#/components/responses/ServiceUnavailable'
408 '5XX':
409 $ref: '#/components/responses/UnexpectedError'
410 default:
411 $ref: '#/components/responses/UnexpectedError'
412 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
413 parameters:
414 - name: nsdInfoId
415 in: path
416 required: true
417 description: NS Package ID
418 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200419 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200420 get:
421 tags:
422 - "NS packages"
423 summary: Read NSD of an on-boarded NS package
424 description: Read NSD of an on-boarded NS package
425 operationId: getNsPkgNsd
426 responses:
427 '200':
428 description: OK
429 content:
430 text/plain:
431 schema:
432 $ref: '#/components/schemas/NsDescriptor'
433 '400':
434 $ref: '#/components/responses/BadRequest'
435 '401':
436 $ref: '#/components/responses/Unauthorized'
437 '403':
438 $ref: '#/components/responses/Forbidden'
439 '404':
440 $ref: '#/components/responses/NotFound'
441 '405':
442 $ref: '#/components/responses/MethodNotAllowed'
443 '406':
444 $ref: '#/components/responses/NotAcceptable'
445 '409':
446 $ref: '#/components/responses/Conflict'
447 '422':
448 $ref: '#/components/responses/UnprocessableEntity'
449 '500':
450 $ref: '#/components/responses/InternalServerError'
451 '503':
452 $ref: '#/components/responses/ServiceUnavailable'
453 '5XX':
454 $ref: '#/components/responses/UnexpectedError'
455 default:
456 $ref: '#/components/responses/UnexpectedError'
457 '/nsd/v1/ns_descriptors_content':
458 post:
459 tags:
460 - "NS packages"
461 summary: Upload a NS package by providing the content of the NS package
462 description: Upload a NS package by providing the content of the NS package
463 operationId: uploadNsPkgsContent
464 requestBody:
465 content:
466 application/zip:
467 schema:
468 $ref: '#/components/schemas/NsPackage'
469 responses:
470 '201':
471 description: Created
472 headers:
473 Location:
474 schema:
475 type: string
476 format: uri
477 content:
478 application/json:
479 schema:
480 $ref: '#/components/schemas/ObjectId'
481 application/yaml:
482 schema:
483 $ref: '#/components/schemas/ObjectId'
484 '202':
485 description: Accepted
486 '204':
487 description: No Content
488 '400':
489 $ref: '#/components/responses/BadRequest'
490 '401':
491 $ref: '#/components/responses/Unauthorized'
492 '403':
493 $ref: '#/components/responses/Forbidden'
494 '404':
495 $ref: '#/components/responses/NotFound'
496 '405':
497 $ref: '#/components/responses/MethodNotAllowed'
498 '406':
499 $ref: '#/components/responses/NotAcceptable'
500 '409':
501 $ref: '#/components/responses/Conflict'
502 '422':
503 $ref: '#/components/responses/UnprocessableEntity'
504 '500':
505 $ref: '#/components/responses/InternalServerError'
506 '503':
507 $ref: '#/components/responses/ServiceUnavailable'
508 '5XX':
509 $ref: '#/components/responses/UnexpectedError'
510 default:
511 $ref: '#/components/responses/UnexpectedError'
512 get:
513 tags:
514 - "NS packages"
515 summary: Query information about multiple NS package resources
516 description: Query information about multiple NS package resources
517 operationId: getNsPkgsContent
518 responses:
519 '200':
520 description: OK
521 content:
522 application/json:
523 schema:
524 $ref: '#/components/schemas/ArrayOfNsdInfo'
525 application/yaml:
526 schema:
527 $ref: '#/components/schemas/ArrayOfNsdInfo'
528 '206':
529 description: Partial Content
530 headers:
531 Content-Range:
532 schema:
533 type: string
534 content:
535 application/octet-stream:
536 schema:
537 type: string
538 format: binary
539 '400':
540 $ref: '#/components/responses/BadRequest'
541 '401':
542 $ref: '#/components/responses/Unauthorized'
543 '403':
544 $ref: '#/components/responses/Forbidden'
545 '404':
546 $ref: '#/components/responses/NotFound'
547 '405':
548 $ref: '#/components/responses/MethodNotAllowed'
549 '406':
550 $ref: '#/components/responses/NotAcceptable'
551 '409':
552 $ref: '#/components/responses/Conflict'
553 '422':
554 $ref: '#/components/responses/UnprocessableEntity'
555 '500':
556 $ref: '#/components/responses/InternalServerError'
557 '503':
558 $ref: '#/components/responses/ServiceUnavailable'
559 '5XX':
560 $ref: '#/components/responses/UnexpectedError'
561 default:
562 $ref: '#/components/responses/UnexpectedError'
563 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
564 parameters:
565 - name: nsdInfoId
566 in: path
567 required: true
568 description: NS Package ID
569 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200570 type: string
delacruzramfb52ade2019-10-07 16:46:59 +0200571 get:
572 tags:
573 - "NS packages"
574 summary: Read information about an individual NS package resource
575 description: Read information about an individual NS package resource
576 operationId: getNsPkgsIdContent
577 responses:
578 '200':
579 description: OK
580 content:
581 application/json:
582 schema:
583 $ref: '#/components/schemas/NsdInfo'
584 application/yaml:
585 schema:
586 $ref: '#/components/schemas/NsdInfo'
587 '400':
588 $ref: '#/components/responses/BadRequest'
589 '401':
590 $ref: '#/components/responses/Unauthorized'
591 '403':
592 $ref: '#/components/responses/Forbidden'
593 '404':
594 $ref: '#/components/responses/NotFound'
595 '405':
596 $ref: '#/components/responses/MethodNotAllowed'
597 '406':
598 $ref: '#/components/responses/NotAcceptable'
599 '409':
600 $ref: '#/components/responses/Conflict'
601 '422':
602 $ref: '#/components/responses/UnprocessableEntity'
603 '500':
604 $ref: '#/components/responses/InternalServerError'
605 '503':
606 $ref: '#/components/responses/ServiceUnavailable'
607 '5XX':
608 $ref: '#/components/responses/UnexpectedError'
609 default:
610 $ref: '#/components/responses/UnexpectedError'
611 put:
612 tags:
613 - "NS packages"
614 summary: Modify an individual NS package resource
615 description: Modify an individual NS package resource
616 operationId: updateNsPkgsIdContent
617 requestBody:
618 $ref: '#/components/requestBodies/NsdInfoModifications'
619 responses:
620 '204':
621 description: No Content
622 '400':
623 $ref: '#/components/responses/BadRequest'
624 '401':
625 $ref: '#/components/responses/Unauthorized'
626 '403':
627 $ref: '#/components/responses/Forbidden'
628 '404':
629 $ref: '#/components/responses/NotFound'
630 '405':
631 $ref: '#/components/responses/MethodNotAllowed'
632 '406':
633 $ref: '#/components/responses/NotAcceptable'
634 '409':
635 $ref: '#/components/responses/Conflict'
636 '422':
637 $ref: '#/components/responses/UnprocessableEntity'
638 '500':
639 $ref: '#/components/responses/InternalServerError'
640 '503':
641 $ref: '#/components/responses/ServiceUnavailable'
642 '5XX':
643 $ref: '#/components/responses/UnexpectedError'
644 default:
645 $ref: '#/components/responses/UnexpectedError'
646 delete:
647 tags:
648 - "NS packages"
649 summary: Delete an individual NS package resource
650 description: Delete an individual NS package resource
651 operationId: deleteNSPkgsIdContent
652 responses:
653 '204':
654 description: No Content
655 '400':
656 $ref: '#/components/responses/BadRequest'
657 '401':
658 $ref: '#/components/responses/Unauthorized'
659 '403':
660 $ref: '#/components/responses/Forbidden'
661 '404':
662 $ref: '#/components/responses/NotFound'
663 '405':
664 $ref: '#/components/responses/MethodNotAllowed'
665 '406':
666 $ref: '#/components/responses/NotAcceptable'
667 '409':
668 $ref: '#/components/responses/Conflict'
669 '422':
670 $ref: '#/components/responses/UnprocessableEntity'
671 '500':
672 $ref: '#/components/responses/InternalServerError'
673 '503':
674 $ref: '#/components/responses/ServiceUnavailable'
675 '5XX':
676 $ref: '#/components/responses/UnexpectedError'
677 default:
678 $ref: '#/components/responses/UnexpectedError'
679# END NS Packages
680
kayal2001ae8f00a2024-06-24 18:04:47 +0530681# BEGIN Ns Config Templates
682 '/nsd/v1/ns_config_template':
683 get:
684 tags:
685 - "Ns packages"
686 summary: Query information about multiple Ns config templates
687 description: Query information about multiple Ns config templates
688 operationId: getNsconfigtemplates
689 responses:
690 '200':
691 description: OK
692 content:
693 application/json:
694 schema:
695 $ref: '#/components/schemas/ArrayOfNsConfigTemplateInfo'
696 application/yaml:
697 schema:
698 $ref: '#/components/schemas/ArrayOfNsConfigTemplateInfo'
699 '400':
700 $ref: '#/components/responses/BadRequest'
701 '401':
702 $ref: '#/components/responses/Unauthorized'
703 '403':
704 $ref: '#/components/responses/Forbidden'
705 '404':
706 $ref: '#/components/responses/NotFound'
707 '405':
708 $ref: '#/components/responses/MethodNotAllowed'
709 '406':
710 $ref: '#/components/responses/NotAcceptable'
711 '409':
712 $ref: '#/components/responses/Conflict'
713 '422':
714 $ref: '#/components/responses/UnprocessableEntity'
715 '500':
716 $ref: '#/components/responses/InternalServerError'
717 '503':
718 $ref: '#/components/responses/ServiceUnavailable'
719 '5XX':
720 $ref: '#/components/responses/UnexpectedError'
721 default:
722 $ref: '#/components/responses/UnexpectedError'
723 post:
724 tags:
725 - "Ns packages"
726 summary: Create a new Ns config template
727 description: |
728 NS config templates are specific configuration templates
729 (instantiation parameters) to be applied to NS packages.
730 when they are instantiated.
731 Template consist of NSD ID, template name and instantiation parameters.
732 operationId: addNsconfigtemplate
733 requestBody:
734 $ref: '#/components/requestBodies/CreateNsConfigTemplateInfoRequest'
735 responses:
736 '201':
737 description: Created
738 headers:
739 Location:
740 schema:
741 type: string
742 format: uri
743 content:
744 application/json:
745 schema:
746 $ref: '#/components/schemas/ObjectId'
747 application/yaml:
748 schema:
749 $ref: '#/components/schemas/ObjectId'
750 '400':
751 $ref: '#/components/responses/BadRequest'
752 '401':
753 $ref: '#/components/responses/Unauthorized'
754 '403':
755 $ref: '#/components/responses/Forbidden'
756 '404':
757 $ref: '#/components/responses/NotFound'
758 '405':
759 $ref: '#/components/responses/MethodNotAllowed'
760 '406':
761 $ref: '#/components/responses/NotAcceptable'
762 '409':
763 $ref: '#/components/responses/Conflict'
764 '422':
765 $ref: '#/components/responses/UnprocessableEntity'
766 '500':
767 $ref: '#/components/responses/InternalServerError'
768 '503':
769 $ref: '#/components/responses/ServiceUnavailable'
770 '5XX':
771 $ref: '#/components/responses/UnexpectedError'
772 default:
773 $ref: '#/components/responses/UnexpectedError'
774 '/nsd/v1/ns_config_template/{nsconfigTemplateId}':
775 parameters:
776 - name: nsconfigTemplateId
777 in: path
778 required: true
779 description: Ns config template ID
780 schema:
781 type: string
782 get:
783 tags:
784 - "Ns packages"
785 summary: Read information about an individual Ns config template resource
786 description: Read information about an individual Ns config template resource
787 operationId: getNsconfigtemplate
788 responses:
789 '200':
790 description: OK
791 content:
792 application/json:
793 schema:
794 $ref: '#/components/schemas/NsConfigTemplateInfo'
795 application/yaml:
796 schema:
797 $ref: '#/components/schemas/NsConfigTemplateInfo'
798 '400':
799 $ref: '#/components/responses/BadRequest'
800 '401':
801 $ref: '#/components/responses/Unauthorized'
802 '403':
803 $ref: '#/components/responses/Forbidden'
804 '404':
805 $ref: '#/components/responses/NotFound'
806 '405':
807 $ref: '#/components/responses/MethodNotAllowed'
808 '406':
809 $ref: '#/components/responses/NotAcceptable'
810 '409':
811 $ref: '#/components/responses/Conflict'
812 '422':
813 $ref: '#/components/responses/UnprocessableEntity'
814 '500':
815 $ref: '#/components/responses/InternalServerError'
816 '503':
817 $ref: '#/components/responses/ServiceUnavailable'
818 '5XX':
819 $ref: '#/components/responses/UnexpectedError'
820 default:
821 $ref: '#/components/responses/UnexpectedError'
822 delete:
823 tags:
824 - "Ns packages"
825 summary: Delete an individual NS config template
826 description: Delete an individual NS config template
827 operationId: deleteNsconfigtemplate
828 responses:
829 '204':
830 description: No Content
831 '400':
832 $ref: '#/components/responses/BadRequest'
833 '401':
834 $ref: '#/components/responses/Unauthorized'
835 '403':
836 $ref: '#/components/responses/Forbidden'
837 '404':
838 $ref: '#/components/responses/NotFound'
839 '405':
840 $ref: '#/components/responses/MethodNotAllowed'
841 '406':
842 $ref: '#/components/responses/NotAcceptable'
843 '409':
844 $ref: '#/components/responses/Conflict'
845 '422':
846 $ref: '#/components/responses/UnprocessableEntity'
847 '500':
848 $ref: '#/components/responses/InternalServerError'
849 '503':
850 $ref: '#/components/responses/ServiceUnavailable'
851 '5XX':
852 $ref: '#/components/responses/UnexpectedError'
853 default:
854 $ref: '#/components/responses/UnexpectedError'
855 '/nsd/v1/ns_config_template/{nsconfigTemplateId}/template_content':
856 parameters:
857 - name: nsconfigTemplateId
858 in: path
859 required: true
860 description: Ns config template ID
861 schema:
862 type: string
863 get:
864 tags:
865 - "Ns packages"
866 summary: Fetch the content of a Ns config template
867 description: Fetch the content of a Ns config template
868 operationId: getTemplatecontent
869 responses:
870 '200':
871 description: OK
872 content:
873 application/json:
874 schema:
875 $ref: '#/components/schemas/NsConfigTemplateInfo'
876 application/yaml:
877 schema:
878 $ref: '#/components/schemas/NsConfigTemplateInfo'
879 '206':
880 description: Partial Content
881 headers:
882 Content-Range:
883 schema:
884 type: string
885 content:
886 application/json:
887 schema:
888 $ref: '#/components/schemas/NsConfigTemplateInfo'
889 application/yaml:
890 schema:
891 $ref: '#/components/schemas/NsConfigTemplateInfo'
892 '400':
893 $ref: '#/components/responses/BadRequest'
894 '401':
895 $ref: '#/components/responses/Unauthorized'
896 '403':
897 $ref: '#/components/responses/Forbidden'
898 '404':
899 $ref: '#/components/responses/NotFound'
900 '405':
901 $ref: '#/components/responses/MethodNotAllowed'
902 '406':
903 $ref: '#/components/responses/NotAcceptable'
904 '409':
905 $ref: '#/components/responses/Conflict'
906 '422':
907 $ref: '#/components/responses/UnprocessableEntity'
908 '500':
909 $ref: '#/components/responses/InternalServerError'
910 '503':
911 $ref: '#/components/responses/ServiceUnavailable'
912 '5XX':
913 $ref: '#/components/responses/UnexpectedError'
914 default:
915 $ref: '#/components/responses/UnexpectedError'
916 put:
917 tags:
918 - "Ns packages"
919 summary: Modify the content of a Ns config template
920 description: |
921 Template name and instantiation parameters
922 can be modified.
923 operationId: updateTemplatecontent
924 requestBody:
925 $ref: '#/components/requestBodies/NsConfigTemplateInfoModifications'
926 responses:
927 '202':
928 description: Accepted
929 '204':
930 description: No Content
931 '400':
932 $ref: '#/components/responses/BadRequest'
933 '401':
934 $ref: '#/components/responses/Unauthorized'
935 '403':
936 $ref: '#/components/responses/Forbidden'
937 '404':
938 $ref: '#/components/responses/NotFound'
939 '405':
940 $ref: '#/components/responses/MethodNotAllowed'
941 '406':
942 $ref: '#/components/responses/NotAcceptable'
943 '409':
944 $ref: '#/components/responses/Conflict'
945 '422':
946 $ref: '#/components/responses/UnprocessableEntity'
947 '500':
948 $ref: '#/components/responses/InternalServerError'
949 '503':
950 $ref: '#/components/responses/ServiceUnavailable'
951 '5XX':
952 $ref: '#/components/responses/UnexpectedError'
953 default:
954 $ref: '#/components/responses/UnexpectedError'
955# END Ns Config Templates
956
delacruzramfb52ade2019-10-07 16:46:59 +0200957# BEGIN VNF Packages
garciadeblas12fcc4b2018-03-02 16:12:02 +0100958 '/vnfpkgm/v1/vnf_packages':
garciadeblas63fe88c2018-02-28 19:32:41 +0100959 get:
960 tags:
961 - "VNF packages"
962 summary: Query information about multiple VNF package resources
delacruzramfb52ade2019-10-07 16:46:59 +0200963 description: Query information about multiple VNF package resources
garciadeblas63fe88c2018-02-28 19:32:41 +0100964 operationId: getVnfPkgs
garciadeblas63fe88c2018-02-28 19:32:41 +0100965 responses:
966 '200':
967 description: OK
968 content:
969 application/json:
970 schema:
971 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
972 application/yaml:
973 schema:
974 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
975 '400':
976 $ref: '#/components/responses/BadRequest'
977 '401':
978 $ref: '#/components/responses/Unauthorized'
979 '403':
980 $ref: '#/components/responses/Forbidden'
981 '404':
982 $ref: '#/components/responses/NotFound'
983 '405':
984 $ref: '#/components/responses/MethodNotAllowed'
985 '406':
986 $ref: '#/components/responses/NotAcceptable'
987 '409':
988 $ref: '#/components/responses/Conflict'
989 '422':
990 $ref: '#/components/responses/UnprocessableEntity'
991 '500':
992 $ref: '#/components/responses/InternalServerError'
993 '503':
994 $ref: '#/components/responses/ServiceUnavailable'
995 '5XX':
996 $ref: '#/components/responses/UnexpectedError'
997 default:
998 $ref: '#/components/responses/UnexpectedError'
999 post:
1000 tags:
1001 - "VNF packages"
1002 summary: Create a new VNF package resource
1003 description: Create a new VNF package resource
1004 operationId: addVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +01001005 requestBody:
1006 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
1007 responses:
1008 '201':
1009 description: Created
1010 headers:
1011 Location:
1012 schema:
1013 type: string
1014 format: uri
1015 content:
1016 application/json:
1017 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02001018 $ref: '#/components/schemas/ObjectId'
garciadeblas63fe88c2018-02-28 19:32:41 +01001019 application/yaml:
1020 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02001021 $ref: '#/components/schemas/ObjectId'
garciadeblas63fe88c2018-02-28 19:32:41 +01001022 '400':
1023 $ref: '#/components/responses/BadRequest'
1024 '401':
1025 $ref: '#/components/responses/Unauthorized'
1026 '403':
1027 $ref: '#/components/responses/Forbidden'
1028 '404':
1029 $ref: '#/components/responses/NotFound'
1030 '405':
1031 $ref: '#/components/responses/MethodNotAllowed'
1032 '406':
1033 $ref: '#/components/responses/NotAcceptable'
1034 '409':
1035 $ref: '#/components/responses/Conflict'
1036 '422':
1037 $ref: '#/components/responses/UnprocessableEntity'
1038 '500':
1039 $ref: '#/components/responses/InternalServerError'
1040 '503':
1041 $ref: '#/components/responses/ServiceUnavailable'
1042 '5XX':
1043 $ref: '#/components/responses/UnexpectedError'
1044 default:
1045 $ref: '#/components/responses/UnexpectedError'
1046 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
delacruzramfb52ade2019-10-07 16:46:59 +02001047 parameters:
1048 - name: vnfPkgId
1049 in: path
1050 required: true
1051 description: VNF Package ID
1052 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001053 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01001054 get:
1055 tags:
1056 - "VNF packages"
1057 summary: Read information about an individual VNF package resource
1058 description: Read information about an individual VNF package resource
1059 operationId: getVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +01001060 responses:
1061 '200':
1062 description: OK
1063 content:
1064 application/json:
1065 schema:
1066 $ref: '#/components/schemas/VnfPkgInfo'
1067 application/yaml:
1068 schema:
1069 $ref: '#/components/schemas/VnfPkgInfo'
1070 '400':
1071 $ref: '#/components/responses/BadRequest'
1072 '401':
1073 $ref: '#/components/responses/Unauthorized'
1074 '403':
1075 $ref: '#/components/responses/Forbidden'
1076 '404':
1077 $ref: '#/components/responses/NotFound'
1078 '405':
1079 $ref: '#/components/responses/MethodNotAllowed'
1080 '406':
1081 $ref: '#/components/responses/NotAcceptable'
1082 '409':
1083 $ref: '#/components/responses/Conflict'
1084 '422':
1085 $ref: '#/components/responses/UnprocessableEntity'
1086 '500':
1087 $ref: '#/components/responses/InternalServerError'
1088 '503':
1089 $ref: '#/components/responses/ServiceUnavailable'
1090 '5XX':
1091 $ref: '#/components/responses/UnexpectedError'
1092 default:
1093 $ref: '#/components/responses/UnexpectedError'
1094 delete:
1095 tags:
1096 - "VNF packages"
1097 summary: Delete an individual VNF package resource
1098 description: Delete an individual VNF package resource
1099 operationId: deleteVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +01001100 responses:
1101 '204':
1102 description: No Content
1103 '400':
1104 $ref: '#/components/responses/BadRequest'
1105 '401':
1106 $ref: '#/components/responses/Unauthorized'
1107 '403':
1108 $ref: '#/components/responses/Forbidden'
1109 '404':
1110 $ref: '#/components/responses/NotFound'
1111 '405':
1112 $ref: '#/components/responses/MethodNotAllowed'
1113 '406':
1114 $ref: '#/components/responses/NotAcceptable'
1115 '409':
1116 $ref: '#/components/responses/Conflict'
1117 '422':
1118 $ref: '#/components/responses/UnprocessableEntity'
1119 '500':
1120 $ref: '#/components/responses/InternalServerError'
1121 '503':
1122 $ref: '#/components/responses/ServiceUnavailable'
1123 '5XX':
1124 $ref: '#/components/responses/UnexpectedError'
1125 default:
1126 $ref: '#/components/responses/UnexpectedError'
1127 patch:
1128 tags:
1129 - "VNF packages"
delacruzramfb52ade2019-10-07 16:46:59 +02001130 summary: Modify an individual VNF package resource
1131 description: Modify an individual VNF package resource
garciadeblas63fe88c2018-02-28 19:32:41 +01001132 operationId: updateVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +01001133 requestBody:
1134 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1135 responses:
delacruzramfb52ade2019-10-07 16:46:59 +02001136 '204':
1137 description: No Content
garciadeblas63fe88c2018-02-28 19:32:41 +01001138 '400':
1139 $ref: '#/components/responses/BadRequest'
1140 '401':
1141 $ref: '#/components/responses/Unauthorized'
1142 '403':
1143 $ref: '#/components/responses/Forbidden'
1144 '404':
1145 $ref: '#/components/responses/NotFound'
1146 '405':
1147 $ref: '#/components/responses/MethodNotAllowed'
1148 '406':
1149 $ref: '#/components/responses/NotAcceptable'
1150 '409':
1151 $ref: '#/components/responses/Conflict'
1152 '422':
1153 $ref: '#/components/responses/UnprocessableEntity'
1154 '500':
1155 $ref: '#/components/responses/InternalServerError'
1156 '503':
1157 $ref: '#/components/responses/ServiceUnavailable'
1158 '5XX':
1159 $ref: '#/components/responses/UnexpectedError'
1160 default:
1161 $ref: '#/components/responses/UnexpectedError'
1162 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
delacruzramfb52ade2019-10-07 16:46:59 +02001163 parameters:
1164 - name: vnfPkgId
1165 in: path
1166 required: true
1167 description: VNF Package ID
1168 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001169 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01001170 get:
1171 tags:
1172 - "VNF packages"
1173 summary: Read VNFD of an on-boarded VNF package
1174 description: Read VNFD of an on-boarded VNF package
delacruzramfb52ade2019-10-07 16:46:59 +02001175 operationId: getVnfPkgVnfd
garciadeblas63fe88c2018-02-28 19:32:41 +01001176 responses:
1177 '200':
1178 description: OK
1179 content:
1180 text/plain:
1181 schema:
1182 $ref: '#/components/schemas/VnfDescriptor'
1183 '400':
1184 $ref: '#/components/responses/BadRequest'
1185 '401':
1186 $ref: '#/components/responses/Unauthorized'
1187 '403':
1188 $ref: '#/components/responses/Forbidden'
1189 '404':
1190 $ref: '#/components/responses/NotFound'
1191 '405':
1192 $ref: '#/components/responses/MethodNotAllowed'
1193 '406':
1194 $ref: '#/components/responses/NotAcceptable'
1195 '409':
1196 $ref: '#/components/responses/Conflict'
1197 '422':
1198 $ref: '#/components/responses/UnprocessableEntity'
1199 '500':
1200 $ref: '#/components/responses/InternalServerError'
1201 '503':
1202 $ref: '#/components/responses/ServiceUnavailable'
1203 '5XX':
1204 $ref: '#/components/responses/UnexpectedError'
1205 default:
1206 $ref: '#/components/responses/UnexpectedError'
1207 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
delacruzramfb52ade2019-10-07 16:46:59 +02001208 parameters:
1209 - name: vnfPkgId
1210 in: path
1211 required: true
1212 description: VNF Package ID
1213 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001214 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01001215 get:
1216 tags:
1217 - "VNF packages"
1218 summary: Fetch an on-boarded VNF package
1219 description: Fetch an on-boarded VNF package
1220 operationId: getVnfPkgContent
garciadeblas63fe88c2018-02-28 19:32:41 +01001221 responses:
1222 '200':
1223 description: OK
1224 content:
1225 application/zip:
1226 schema:
1227 $ref: '#/components/schemas/VnfPackage'
1228 '206':
1229 description: Partial Content
1230 headers:
1231 Content-Range:
1232 schema:
1233 type: string
1234 content:
1235 application/zip:
1236 schema:
1237 $ref: '#/components/schemas/VnfPackage'
1238 '400':
1239 $ref: '#/components/responses/BadRequest'
1240 '401':
1241 $ref: '#/components/responses/Unauthorized'
1242 '403':
1243 $ref: '#/components/responses/Forbidden'
1244 '404':
1245 $ref: '#/components/responses/NotFound'
1246 '405':
1247 $ref: '#/components/responses/MethodNotAllowed'
1248 '406':
1249 $ref: '#/components/responses/NotAcceptable'
1250 '409':
1251 $ref: '#/components/responses/Conflict'
1252 '422':
1253 $ref: '#/components/responses/UnprocessableEntity'
1254 '500':
1255 $ref: '#/components/responses/InternalServerError'
1256 '503':
1257 $ref: '#/components/responses/ServiceUnavailable'
1258 '5XX':
1259 $ref: '#/components/responses/UnexpectedError'
1260 default:
1261 $ref: '#/components/responses/UnexpectedError'
1262 put:
1263 tags:
1264 - "VNF packages"
1265 summary: Upload a VNF package by providing the content of the VNF package
1266 description: Upload a VNF package by providing the content of the VNF package
1267 operationId: uploadVnfPkgContent
garciadeblas63fe88c2018-02-28 19:32:41 +01001268 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +02001269 content:
1270 application/zip:
1271 schema:
1272 $ref: '#/components/schemas/VnfPackage'
garciadeblas63fe88c2018-02-28 19:32:41 +01001273 responses:
1274 '202':
1275 description: Accepted
delacruzramfb52ade2019-10-07 16:46:59 +02001276 '204':
1277 description: No Content
garciadeblas63fe88c2018-02-28 19:32:41 +01001278 '400':
1279 $ref: '#/components/responses/BadRequest'
1280 '401':
1281 $ref: '#/components/responses/Unauthorized'
1282 '403':
1283 $ref: '#/components/responses/Forbidden'
1284 '404':
1285 $ref: '#/components/responses/NotFound'
1286 '405':
1287 $ref: '#/components/responses/MethodNotAllowed'
1288 '406':
1289 $ref: '#/components/responses/NotAcceptable'
1290 '409':
1291 $ref: '#/components/responses/Conflict'
1292 '422':
1293 $ref: '#/components/responses/UnprocessableEntity'
1294 '500':
1295 $ref: '#/components/responses/InternalServerError'
1296 '503':
1297 $ref: '#/components/responses/ServiceUnavailable'
1298 '5XX':
1299 $ref: '#/components/responses/UnexpectedError'
1300 default:
1301 $ref: '#/components/responses/UnexpectedError'
1302 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
delacruzramfb52ade2019-10-07 16:46:59 +02001303 parameters:
1304 - name: vnfPkgId
1305 in: path
1306 required: true
1307 description: VNF Package ID
1308 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001309 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02001310 - name: artifactPath
1311 in: path
1312 required: true
1313 description: Artifact Path
1314 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001315 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01001316 get:
1317 tags:
1318 - "VNF packages"
1319 summary: Fetch individual VNF package artifact
1320 description: Fetch individual VNF package artifact
1321 operationId: getVnfPkgArtifact
garciadeblas63fe88c2018-02-28 19:32:41 +01001322 responses:
1323 '200':
1324 description: OK
1325 content:
1326 application/octet-stream:
1327 schema:
1328 type: string
1329 format: binary
1330 '206':
1331 description: Partial Content
1332 headers:
1333 Content-Range:
1334 schema:
1335 type: string
1336 content:
1337 application/octet-stream:
1338 schema:
1339 type: string
1340 format: binary
1341 '400':
1342 $ref: '#/components/responses/BadRequest'
1343 '401':
1344 $ref: '#/components/responses/Unauthorized'
1345 '403':
1346 $ref: '#/components/responses/Forbidden'
1347 '404':
1348 $ref: '#/components/responses/NotFound'
1349 '405':
1350 $ref: '#/components/responses/MethodNotAllowed'
1351 '406':
1352 $ref: '#/components/responses/NotAcceptable'
1353 '409':
1354 $ref: '#/components/responses/Conflict'
1355 '422':
1356 $ref: '#/components/responses/UnprocessableEntity'
1357 '500':
1358 $ref: '#/components/responses/InternalServerError'
1359 '503':
1360 $ref: '#/components/responses/ServiceUnavailable'
1361 '5XX':
1362 $ref: '#/components/responses/UnexpectedError'
1363 default:
1364 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02001365 '/vnfpkgm/v1/vnf_packages_content':
1366 post:
1367 tags:
1368 - "VNF packages"
1369 summary: Upload a VNF package by providing the content of the VNF package
1370 description: Upload a VNF package by providing the content of the VNF package
1371 operationId: uploadVnfPkgsContent
1372 requestBody:
1373 content:
1374 application/zip:
1375 schema:
1376 $ref: '#/components/schemas/VnfPackage'
1377 responses:
1378 '201':
1379 description: Created
1380 headers:
1381 Location:
1382 schema:
1383 type: string
1384 format: uri
1385 content:
1386 application/json:
1387 schema:
1388 $ref: '#/components/schemas/ObjectId'
1389 application/yaml:
1390 schema:
1391 $ref: '#/components/schemas/ObjectId'
1392 '202':
1393 description: Accepted
1394 '204':
1395 description: No Content
1396 '400':
1397 $ref: '#/components/responses/BadRequest'
1398 '401':
1399 $ref: '#/components/responses/Unauthorized'
1400 '403':
1401 $ref: '#/components/responses/Forbidden'
1402 '404':
1403 $ref: '#/components/responses/NotFound'
1404 '405':
1405 $ref: '#/components/responses/MethodNotAllowed'
1406 '406':
1407 $ref: '#/components/responses/NotAcceptable'
1408 '409':
1409 $ref: '#/components/responses/Conflict'
1410 '422':
1411 $ref: '#/components/responses/UnprocessableEntity'
1412 '500':
1413 $ref: '#/components/responses/InternalServerError'
1414 '503':
1415 $ref: '#/components/responses/ServiceUnavailable'
1416 '5XX':
1417 $ref: '#/components/responses/UnexpectedError'
1418 default:
1419 $ref: '#/components/responses/UnexpectedError'
1420 get:
1421 tags:
1422 - "VNF packages"
1423 summary: Query information about multiple VNF package resources
1424 description: Query information about multiple VNF package resources
1425 operationId: getVnfPkgsContent
1426 responses:
1427 '200':
1428 description: OK
1429 content:
1430 application/json:
1431 schema:
1432 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1433 application/yaml:
1434 schema:
1435 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1436 '206':
1437 description: Partial Content
1438 headers:
1439 Content-Range:
1440 schema:
1441 type: string
1442 content:
1443 application/octet-stream:
1444 schema:
1445 type: string
1446 format: binary
1447 '400':
1448 $ref: '#/components/responses/BadRequest'
1449 '401':
1450 $ref: '#/components/responses/Unauthorized'
1451 '403':
1452 $ref: '#/components/responses/Forbidden'
1453 '404':
1454 $ref: '#/components/responses/NotFound'
1455 '405':
1456 $ref: '#/components/responses/MethodNotAllowed'
1457 '406':
1458 $ref: '#/components/responses/NotAcceptable'
1459 '409':
1460 $ref: '#/components/responses/Conflict'
1461 '422':
1462 $ref: '#/components/responses/UnprocessableEntity'
1463 '500':
1464 $ref: '#/components/responses/InternalServerError'
1465 '503':
1466 $ref: '#/components/responses/ServiceUnavailable'
1467 '5XX':
1468 $ref: '#/components/responses/UnexpectedError'
1469 default:
1470 $ref: '#/components/responses/UnexpectedError'
1471 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1472 parameters:
1473 - name: packageContentId
1474 in: path
1475 required: true
1476 description: VNF Package Content ID
1477 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001478 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02001479 get:
1480 tags:
1481 - "VNF packages"
1482 summary: Read information about an individual VNF package resource
1483 description: Read information about an individual VNF package resource
1484 operationId: getVnfPkgsIdContent
1485 responses:
1486 '200':
1487 description: OK
1488 content:
1489 application/json:
1490 schema:
1491 $ref: '#/components/schemas/VnfPkgInfo'
1492 application/yaml:
1493 schema:
1494 $ref: '#/components/schemas/VnfPkgInfo'
1495 '400':
1496 $ref: '#/components/responses/BadRequest'
1497 '401':
1498 $ref: '#/components/responses/Unauthorized'
1499 '403':
1500 $ref: '#/components/responses/Forbidden'
1501 '404':
1502 $ref: '#/components/responses/NotFound'
1503 '405':
1504 $ref: '#/components/responses/MethodNotAllowed'
1505 '406':
1506 $ref: '#/components/responses/NotAcceptable'
1507 '409':
1508 $ref: '#/components/responses/Conflict'
1509 '422':
1510 $ref: '#/components/responses/UnprocessableEntity'
1511 '500':
1512 $ref: '#/components/responses/InternalServerError'
1513 '503':
1514 $ref: '#/components/responses/ServiceUnavailable'
1515 '5XX':
1516 $ref: '#/components/responses/UnexpectedError'
1517 default:
1518 $ref: '#/components/responses/UnexpectedError'
1519 put:
1520 tags:
1521 - "VNF packages"
1522 summary: Modify an individual VNF package resource
1523 description: Modify an individual VNF package resource
1524 operationId: updateVnfPkgsIdContent
1525 requestBody:
1526 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1527 responses:
1528 '204':
1529 description: No Content
1530 '400':
1531 $ref: '#/components/responses/BadRequest'
1532 '401':
1533 $ref: '#/components/responses/Unauthorized'
1534 '403':
1535 $ref: '#/components/responses/Forbidden'
1536 '404':
1537 $ref: '#/components/responses/NotFound'
1538 '405':
1539 $ref: '#/components/responses/MethodNotAllowed'
1540 '406':
1541 $ref: '#/components/responses/NotAcceptable'
1542 '409':
1543 $ref: '#/components/responses/Conflict'
1544 '422':
1545 $ref: '#/components/responses/UnprocessableEntity'
1546 '500':
1547 $ref: '#/components/responses/InternalServerError'
1548 '503':
1549 $ref: '#/components/responses/ServiceUnavailable'
1550 '5XX':
1551 $ref: '#/components/responses/UnexpectedError'
1552 default:
1553 $ref: '#/components/responses/UnexpectedError'
1554 delete:
1555 tags:
1556 - "VNF packages"
1557 summary: Delete an individual VNF package resource
1558 description: Delete an individual VNF package resource
1559 operationId: deleteVnfPkgsIdContent
1560 responses:
1561 '204':
1562 description: No Content
1563 '400':
1564 $ref: '#/components/responses/BadRequest'
1565 '401':
1566 $ref: '#/components/responses/Unauthorized'
1567 '403':
1568 $ref: '#/components/responses/Forbidden'
1569 '404':
1570 $ref: '#/components/responses/NotFound'
1571 '405':
1572 $ref: '#/components/responses/MethodNotAllowed'
1573 '406':
1574 $ref: '#/components/responses/NotAcceptable'
1575 '409':
1576 $ref: '#/components/responses/Conflict'
1577 '422':
1578 $ref: '#/components/responses/UnprocessableEntity'
1579 '500':
1580 $ref: '#/components/responses/InternalServerError'
1581 '503':
1582 $ref: '#/components/responses/ServiceUnavailable'
1583 '5XX':
1584 $ref: '#/components/responses/UnexpectedError'
1585 default:
1586 $ref: '#/components/responses/UnexpectedError'
1587# END VNF Packages
1588
1589# BEGIN NS Instances
garciadeblas12fcc4b2018-03-02 16:12:02 +01001590 '/nslcm/v1/ns_instances':
1591 get:
1592 tags:
1593 - "NS instances"
1594 summary: Query information about multiple NS instances
1595 description: Query information about multiple NS isntances
1596 operationId: getNSinstances
garciadeblas12fcc4b2018-03-02 16:12:02 +01001597 responses:
1598 '200':
1599 description: OK
1600 content:
1601 application/json:
1602 schema:
1603 $ref: '#/components/schemas/ArrayOfNsInstance'
1604 application/yaml:
1605 schema:
1606 $ref: '#/components/schemas/ArrayOfNsInstance'
1607 '400':
1608 $ref: '#/components/responses/BadRequest'
1609 '401':
1610 $ref: '#/components/responses/Unauthorized'
1611 '403':
1612 $ref: '#/components/responses/Forbidden'
1613 '404':
1614 $ref: '#/components/responses/NotFound'
1615 '405':
1616 $ref: '#/components/responses/MethodNotAllowed'
1617 '406':
1618 $ref: '#/components/responses/NotAcceptable'
1619 '409':
1620 $ref: '#/components/responses/Conflict'
1621 '422':
1622 $ref: '#/components/responses/UnprocessableEntity'
1623 '500':
1624 $ref: '#/components/responses/InternalServerError'
1625 '503':
1626 $ref: '#/components/responses/ServiceUnavailable'
1627 '5XX':
1628 $ref: '#/components/responses/UnexpectedError'
1629 default:
1630 $ref: '#/components/responses/UnexpectedError'
1631 post:
1632 tags:
1633 - "NS instances"
1634 summary: Create a new NS instance resource
1635 description: Create a new NS instance resource
1636 operationId: addNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001637 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02001638 $ref: '#/components/requestBodies/InstantiateNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001639 responses:
1640 '201':
1641 description: Created
1642 headers:
1643 Location:
1644 schema:
1645 type: string
1646 format: uri
1647 content:
1648 application/json:
1649 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02001650 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001651 application/yaml:
1652 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02001653 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001654 '400':
1655 $ref: '#/components/responses/BadRequest'
1656 '401':
1657 $ref: '#/components/responses/Unauthorized'
1658 '403':
1659 $ref: '#/components/responses/Forbidden'
1660 '404':
1661 $ref: '#/components/responses/NotFound'
1662 '405':
1663 $ref: '#/components/responses/MethodNotAllowed'
1664 '406':
1665 $ref: '#/components/responses/NotAcceptable'
1666 '409':
1667 $ref: '#/components/responses/Conflict'
1668 '422':
1669 $ref: '#/components/responses/UnprocessableEntity'
1670 '500':
1671 $ref: '#/components/responses/InternalServerError'
1672 '503':
1673 $ref: '#/components/responses/ServiceUnavailable'
1674 '5XX':
1675 $ref: '#/components/responses/UnexpectedError'
1676 default:
1677 $ref: '#/components/responses/UnexpectedError'
1678 '/nslcm/v1/ns_instances/{nsInstanceId}':
delacruzramfb52ade2019-10-07 16:46:59 +02001679 parameters:
1680 - name: nsInstanceId
1681 in: path
1682 required: true
1683 description: NS Instance ID
1684 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001685 type: string
ksaikiranr6400ff72021-04-07 14:19:50 +05301686 - name: vcaStatusRefresh
1687 in: query
1688 required: false
1689 description: Set to true if vca status needs to be refreshed.
1690 schema:
1691 type: boolean
garciadeblas12fcc4b2018-03-02 16:12:02 +01001692 get:
1693 tags:
1694 - "NS instances"
1695 summary: Read an individual NS instance resource
1696 description: Read an individual NS instance resource
1697 operationId: getNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001698 responses:
1699 '200':
1700 description: OK
1701 content:
1702 application/json:
1703 schema:
1704 $ref: '#/components/schemas/NsInstance'
1705 application/yaml:
1706 schema:
1707 $ref: '#/components/schemas/NsInstance'
1708 '400':
1709 $ref: '#/components/responses/BadRequest'
1710 '401':
1711 $ref: '#/components/responses/Unauthorized'
1712 '403':
1713 $ref: '#/components/responses/Forbidden'
1714 '404':
1715 $ref: '#/components/responses/NotFound'
1716 '405':
1717 $ref: '#/components/responses/MethodNotAllowed'
1718 '406':
1719 $ref: '#/components/responses/NotAcceptable'
1720 '409':
1721 $ref: '#/components/responses/Conflict'
1722 '422':
1723 $ref: '#/components/responses/UnprocessableEntity'
1724 '500':
1725 $ref: '#/components/responses/InternalServerError'
1726 '503':
1727 $ref: '#/components/responses/ServiceUnavailable'
1728 '5XX':
1729 $ref: '#/components/responses/UnexpectedError'
1730 default:
1731 $ref: '#/components/responses/UnexpectedError'
1732 delete:
1733 tags:
1734 - "NS instances"
1735 summary: Delete an individual NS instance resource
1736 description: Delete an individual NS instance resource
1737 operationId: deleteNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001738 responses:
1739 '204':
1740 description: No Content
1741 '400':
1742 $ref: '#/components/responses/BadRequest'
1743 '401':
1744 $ref: '#/components/responses/Unauthorized'
1745 '403':
1746 $ref: '#/components/responses/Forbidden'
1747 '404':
1748 $ref: '#/components/responses/NotFound'
1749 '405':
1750 $ref: '#/components/responses/MethodNotAllowed'
1751 '406':
1752 $ref: '#/components/responses/NotAcceptable'
1753 '409':
1754 $ref: '#/components/responses/Conflict'
1755 '422':
1756 $ref: '#/components/responses/UnprocessableEntity'
1757 '500':
1758 $ref: '#/components/responses/InternalServerError'
1759 '503':
1760 $ref: '#/components/responses/ServiceUnavailable'
1761 '5XX':
1762 $ref: '#/components/responses/UnexpectedError'
1763 default:
1764 $ref: '#/components/responses/UnexpectedError'
1765 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
delacruzramfb52ade2019-10-07 16:46:59 +02001766 parameters:
1767 - name: nsInstanceId
1768 in: path
1769 required: true
1770 description: NS Instance ID
1771 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001772 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01001773 post:
1774 tags:
1775 - "NS instances"
1776 summary: Instantiate a NS
1777 description: |
1778 Instantiate a NS. The precondition is that the NS instance must have
1779 been created and must be in NOT_INSTANTIATED state. As a result of the
1780 success of this operation, the NFVO creates a "NS Lifecycle Operation
1781 Occurrence" resource for the request, and the NS instance state becomes
1782 INSTANTIATED.
1783 operationId: instantiateNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001784 requestBody:
1785 $ref: '#/components/requestBodies/InstantiateNsRequest'
1786 responses:
1787 '202':
1788 description: Accepted
1789 headers:
1790 Location:
1791 description: |
1792 It must point to the new "NS Lifecycle Operation Occurrence"
1793 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1794 schema:
1795 type: string
1796 format: uri
delacruzramfb52ade2019-10-07 16:46:59 +02001797 content:
1798 application/json:
1799 schema:
1800 $ref: '#/components/schemas/ObjectId'
1801 application/yaml:
1802 schema:
1803 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001804 '400':
1805 $ref: '#/components/responses/BadRequest'
1806 '401':
1807 $ref: '#/components/responses/Unauthorized'
1808 '403':
1809 $ref: '#/components/responses/Forbidden'
1810 '404':
1811 $ref: '#/components/responses/NotFound'
1812 '405':
1813 $ref: '#/components/responses/MethodNotAllowed'
1814 '406':
1815 $ref: '#/components/responses/NotAcceptable'
1816 '409':
1817 $ref: '#/components/responses/Conflict'
1818 '422':
1819 $ref: '#/components/responses/UnprocessableEntity'
1820 '500':
1821 $ref: '#/components/responses/InternalServerError'
1822 '503':
1823 $ref: '#/components/responses/ServiceUnavailable'
1824 '5XX':
1825 $ref: '#/components/responses/UnexpectedError'
1826 default:
1827 $ref: '#/components/responses/UnexpectedError'
1828 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
delacruzramfb52ade2019-10-07 16:46:59 +02001829 parameters:
1830 - name: nsInstanceId
1831 in: path
1832 required: true
1833 description: NS Instance ID
1834 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001835 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01001836 post:
1837 tags:
1838 - "NS instances"
1839 summary: Scale a NS instance
1840 description: |
1841 Scale a NS instance. The precondition is that the NS instance must have
1842 been created and must be in INSTANTIATED state. As a result of the
1843 success of this operation, the NFVO creates a "NS Lifecycle Operation
1844 Occurrence" resource for the request, and the NS instance state remains
1845 INSTANTIATED.
1846 operationId: scaleNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001847 requestBody:
1848 $ref: '#/components/requestBodies/ScaleNsRequest'
1849 responses:
1850 '202':
1851 description: Accepted
1852 headers:
1853 Location:
1854 description: |
1855 It must point to the new "NS Lifecycle Operation Occurrence"
1856 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1857 schema:
1858 type: string
1859 format: uri
1860 '400':
1861 $ref: '#/components/responses/BadRequest'
1862 '401':
1863 $ref: '#/components/responses/Unauthorized'
1864 '403':
1865 $ref: '#/components/responses/Forbidden'
1866 '404':
1867 $ref: '#/components/responses/NotFound'
1868 '405':
1869 $ref: '#/components/responses/MethodNotAllowed'
1870 '406':
1871 $ref: '#/components/responses/NotAcceptable'
1872 '409':
1873 $ref: '#/components/responses/Conflict'
1874 '422':
1875 $ref: '#/components/responses/UnprocessableEntity'
1876 '500':
1877 $ref: '#/components/responses/InternalServerError'
1878 '503':
1879 $ref: '#/components/responses/ServiceUnavailable'
1880 '5XX':
1881 $ref: '#/components/responses/UnexpectedError'
1882 default:
1883 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +01001884 '/nslcm/v1/ns_instances/{nsInstanceId}/heal':
1885 parameters:
1886 - name: nsInstanceId
1887 in: path
1888 required: true
1889 description: NS Instance ID
1890 schema:
1891 type: string
1892 post:
1893 tags:
1894 - "NS instances"
1895 summary: Heal a NS instance
1896 description: |
1897 Heal a NS instance. The precondition is that the NS instance must have
1898 been created and must be in INSTANTIATED state. As a result of the
1899 success of this operation, the NFVO creates a "NS Lifecycle Operation
1900 Occurrence" resource for the request, and the NS instance state remains
1901 INSTANTIATED.
1902 operationId: healNSinstance
1903 requestBody:
1904 $ref: '#/components/requestBodies/HealNsRequest'
1905 responses:
1906 '202':
1907 description: Accepted
1908 headers:
1909 Location:
1910 description: |
1911 It must point to the new "NS Lifecycle Operation Occurrence"
1912 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1913 schema:
1914 type: string
1915 format: uri
1916 '400':
1917 $ref: '#/components/responses/BadRequest'
1918 '401':
1919 $ref: '#/components/responses/Unauthorized'
1920 '403':
1921 $ref: '#/components/responses/Forbidden'
1922 '404':
1923 $ref: '#/components/responses/NotFound'
1924 '405':
1925 $ref: '#/components/responses/MethodNotAllowed'
1926 '406':
1927 $ref: '#/components/responses/NotAcceptable'
1928 '409':
1929 $ref: '#/components/responses/Conflict'
1930 '422':
1931 $ref: '#/components/responses/UnprocessableEntity'
1932 '500':
1933 $ref: '#/components/responses/InternalServerError'
1934 '503':
1935 $ref: '#/components/responses/ServiceUnavailable'
1936 '5XX':
1937 $ref: '#/components/responses/UnexpectedError'
1938 default:
1939 $ref: '#/components/responses/UnexpectedError'
elumalai4b120f12022-04-28 16:44:35 +05301940 '/nslcm/v1/ns_instances/{nsInstanceId}/migrate':
1941 parameters:
1942 - name: nsInstanceId
1943 in: path
1944 required: true
1945 description: NS Instance ID
1946 schema:
1947 type: string
1948 post:
1949 tags:
1950 - "NS instances"
1951 summary: Migrate VNFs in a NS instance
1952 description: |
1953 Migrate the VNFs and VDUs in a NS instance. The precondition is
1954 that the NS instance must have been created and must be in
1955 INSTANTIATED state. As a result of the success of this operation,
1956 the NFVO creates a "NS Lifecycle Operation Occurrence" resource
1957 for the request, and the NS instance state remains INSTANTIATED.
1958 operationId: migrateNSinstance
1959 requestBody:
1960 $ref: '#/components/requestBodies/NSinstanceMigrateRequest'
1961 responses:
1962 '202':
1963 description: Accepted
1964 headers:
1965 Location:
1966 description: |
1967 It must point to the new "NS Lifecycle Operation Occurrence"
1968 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1969 schema:
1970 type: string
1971 format: uri
1972 '400':
1973 $ref: '#/components/responses/BadRequest'
1974 '401':
1975 $ref: '#/components/responses/Unauthorized'
1976 '403':
1977 $ref: '#/components/responses/Forbidden'
1978 '404':
1979 $ref: '#/components/responses/NotFound'
1980 '405':
1981 $ref: '#/components/responses/MethodNotAllowed'
1982 '406':
1983 $ref: '#/components/responses/NotAcceptable'
1984 '409':
1985 $ref: '#/components/responses/Conflict'
1986 '422':
1987 $ref: '#/components/responses/UnprocessableEntity'
1988 '500':
1989 $ref: '#/components/responses/InternalServerError'
1990 '503':
1991 $ref: '#/components/responses/ServiceUnavailable'
1992 '5XX':
1993 $ref: '#/components/responses/UnexpectedError'
1994 default:
1995 $ref: '#/components/responses/UnexpectedError'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001996 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
delacruzramfb52ade2019-10-07 16:46:59 +02001997 parameters:
1998 - name: nsInstanceId
1999 in: path
2000 required: true
2001 description: NS Instance ID
2002 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002003 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01002004 post:
2005 tags:
2006 - "NS instances"
2007 summary: Terminate a NS instance
2008 description: |
2009 Terminate a NS instance. The precondition is that the NS instance must have
2010 been created and must be in INSTANTIATED state. As a result of the
2011 success of this operation, the NFVO creates a "NS Lifecycle Operation
2012 Occurrence" resource for the request, and the NS instance state becomes
2013 NOT_INSTANTIATED.
2014 operationId: terminateNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01002015 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +02002016 # Request data is not required
garciadeblas12fcc4b2018-03-02 16:12:02 +01002017 $ref: '#/components/requestBodies/TerminateNsRequest'
2018 responses:
2019 '202':
2020 description: Accepted
2021 headers:
2022 Location:
2023 description: |
2024 It must point to the new "NS Lifecycle Operation Occurrence"
2025 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
2026 schema:
2027 type: string
2028 format: uri
delacruzramfb52ade2019-10-07 16:46:59 +02002029 content:
2030 application/json:
2031 schema:
2032 $ref: '#/components/schemas/ObjectId'
2033 application/yaml:
2034 schema:
2035 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01002036 '400':
2037 $ref: '#/components/responses/BadRequest'
2038 '401':
2039 $ref: '#/components/responses/Unauthorized'
2040 '403':
2041 $ref: '#/components/responses/Forbidden'
2042 '404':
2043 $ref: '#/components/responses/NotFound'
2044 '405':
2045 $ref: '#/components/responses/MethodNotAllowed'
2046 '406':
2047 $ref: '#/components/responses/NotAcceptable'
2048 '409':
2049 $ref: '#/components/responses/Conflict'
2050 '422':
2051 $ref: '#/components/responses/UnprocessableEntity'
2052 '500':
2053 $ref: '#/components/responses/InternalServerError'
2054 '503':
2055 $ref: '#/components/responses/ServiceUnavailable'
2056 '5XX':
2057 $ref: '#/components/responses/UnexpectedError'
2058 default:
2059 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002060 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
2061 parameters:
2062 - name: nsInstanceId
2063 in: path
2064 required: true
2065 description: NS Instance ID
2066 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002067 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002068 post:
2069 tags:
2070 - "NS instances"
2071 summary: Execute an action on a NS instance
2072 description: |
2073 Execute an action on a NS instance.
2074 The NS instance must have been created and must be in INSTANTIATED state.
2075 operationId: actionOnNSinstance
2076 requestBody:
2077 content:
2078 application/json:
2079 schema:
2080 $ref: '#/components/schemas/NSinstanceActionRequest'
2081 application/yaml:
2082 schema:
2083 $ref: '#/components/schemas/NSinstanceActionRequest'
2084 responses:
2085 '202':
2086 description: Accepted
2087 headers:
2088 Location:
2089 description: |
2090 It must point to the new "NS Lifecycle Operation Occurrence"
2091 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
2092 schema:
2093 type: string
2094 format: uri
2095 content:
2096 application/json:
2097 schema:
2098 $ref: '#/components/schemas/ObjectId'
2099 application/yaml:
2100 schema:
2101 $ref: '#/components/schemas/ObjectId'
2102 '400':
2103 $ref: '#/components/responses/BadRequest'
2104 '401':
2105 $ref: '#/components/responses/Unauthorized'
2106 '403':
2107 $ref: '#/components/responses/Forbidden'
2108 '404':
2109 $ref: '#/components/responses/NotFound'
2110 '405':
2111 $ref: '#/components/responses/MethodNotAllowed'
2112 '406':
2113 $ref: '#/components/responses/NotAcceptable'
2114 '409':
2115 $ref: '#/components/responses/Conflict'
2116 '422':
2117 $ref: '#/components/responses/UnprocessableEntity'
2118 '500':
2119 $ref: '#/components/responses/InternalServerError'
2120 '503':
2121 $ref: '#/components/responses/ServiceUnavailable'
2122 '5XX':
2123 $ref: '#/components/responses/UnexpectedError'
2124 default:
2125 $ref: '#/components/responses/UnexpectedError'
elumalaif2eb5e72022-03-21 19:44:39 +05302126 '/nslcm/v1/ns_instances/{nsInstanceId}/update':
2127 parameters:
2128 - name: nsInstanceId
2129 in: path
2130 required: true
2131 description: NS Instance ID
2132 schema:
2133 type: string
2134 post:
2135 tags:
2136 - "NS instances"
2137 summary: Update a NS instance
2138 description: |
2139 Update a NS instance. The precondition is that the NS instance must have
2140 been created and must be in INSTANTIATED state. As a result of the
2141 success of this operation, the NFVO creates a "NS Lifecycle Operation
2142 Occurrence" resource for the request, and the NS instance state remains
2143 INSTANTIATED.
2144 operationId: updateNSinstance
2145 requestBody:
2146 $ref: '#/components/requestBodies/UpdateNsRequest'
2147 responses:
2148 '202':
2149 description: Accepted
2150 headers:
2151 Location:
2152 description: |
2153 It must point to the new "NS Lifecycle Operation Occurrence"
2154 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
2155 schema:
2156 type: string
2157 format: uri
2158 '400':
2159 $ref: '#/components/responses/BadRequest'
2160 '401':
2161 $ref: '#/components/responses/Unauthorized'
2162 '403':
2163 $ref: '#/components/responses/Forbidden'
2164 '404':
2165 $ref: '#/components/responses/NotFound'
2166 '405':
2167 $ref: '#/components/responses/MethodNotAllowed'
2168 '406':
2169 $ref: '#/components/responses/NotAcceptable'
2170 '409':
2171 $ref: '#/components/responses/Conflict'
2172 '422':
2173 $ref: '#/components/responses/UnprocessableEntity'
2174 '500':
2175 $ref: '#/components/responses/InternalServerError'
2176 '503':
2177 $ref: '#/components/responses/ServiceUnavailable'
2178 '5XX':
2179 $ref: '#/components/responses/UnexpectedError'
2180 default:
2181 $ref: '#/components/responses/UnexpectedError'
adurtiafd75092024-05-31 14:52:18 +05302182 '/nslcm/v1/ns_instances_terminate':
2183 post:
2184 tags:
2185 - "NS instances"
2186 summary: Terminates NS instances
2187 description: Terminates multiple NS instances.
2188 operationId: MultiNsTerminateRequest
2189 requestBody:
2190 $ref: '#/components/requestBodies/MultiNsTerminateRequest'
2191 responses:
2192 '202':
2193 description: Accepted
2194 content:
2195 application/json:
2196 schema:
2197 $ref: '#/components/schemas/ObjectIdList'
2198 application/yaml:
2199 schema:
2200 $ref: '#/components/schemas/ObjectIdList'
2201 '400':
2202 $ref: '#/components/responses/BadRequest'
2203 '401':
2204 $ref: '#/components/responses/Unauthorized'
2205 '403':
2206 $ref: '#/components/responses/Forbidden'
2207 '404':
2208 $ref: '#/components/responses/NotFound'
2209 '405':
2210 $ref: '#/components/responses/MethodNotAllowed'
2211 '406':
2212 $ref: '#/components/responses/NotAcceptable'
2213 '409':
2214 $ref: '#/components/responses/Conflict'
2215 '422':
2216 $ref: '#/components/responses/UnprocessableEntity'
2217 '500':
2218 $ref: '#/components/responses/InternalServerError'
2219 '503':
2220 $ref: '#/components/responses/ServiceUnavailable'
2221 '5XX':
2222 $ref: '#/components/responses/UnexpectedError'
2223 default:
2224 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002225 '/nslcm/v1/ns_instances_content':
2226 get:
2227 tags:
2228 - "NS instances"
2229 summary: Query information about multiple NS instances
2230 description: Query information about multiple NS isntances
2231 operationId: getNSinstancesContent
2232 responses:
2233 '200':
2234 description: OK
2235 content:
2236 application/json:
2237 schema:
2238 $ref: '#/components/schemas/ArrayOfNsInstance'
2239 application/yaml:
2240 schema:
2241 $ref: '#/components/schemas/ArrayOfNsInstance'
2242 '400':
2243 $ref: '#/components/responses/BadRequest'
2244 '401':
2245 $ref: '#/components/responses/Unauthorized'
2246 '403':
2247 $ref: '#/components/responses/Forbidden'
2248 '404':
2249 $ref: '#/components/responses/NotFound'
2250 '405':
2251 $ref: '#/components/responses/MethodNotAllowed'
2252 '406':
2253 $ref: '#/components/responses/NotAcceptable'
2254 '409':
2255 $ref: '#/components/responses/Conflict'
2256 '422':
2257 $ref: '#/components/responses/UnprocessableEntity'
2258 '500':
2259 $ref: '#/components/responses/InternalServerError'
2260 '503':
2261 $ref: '#/components/responses/ServiceUnavailable'
2262 '5XX':
2263 $ref: '#/components/responses/UnexpectedError'
2264 default:
2265 $ref: '#/components/responses/UnexpectedError'
2266 post:
2267 tags:
2268 - "NS instances"
2269 summary: Create a new NS instance
2270 description: Create a new NS instance
2271 operationId: createNSinstanceContent
2272 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02002273 $ref: '#/components/requestBodies/InstantiateNsRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02002274 responses:
2275 '201':
2276 description: Created
2277 headers:
2278 Location:
2279 schema:
2280 type: string
2281 format: uri
2282 content:
2283 application/json:
2284 schema:
2285 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2286 application/yaml:
2287 schema:
2288 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2289 '400':
2290 $ref: '#/components/responses/BadRequest'
2291 '401':
2292 $ref: '#/components/responses/Unauthorized'
2293 '403':
2294 $ref: '#/components/responses/Forbidden'
2295 '404':
2296 $ref: '#/components/responses/NotFound'
2297 '405':
2298 $ref: '#/components/responses/MethodNotAllowed'
2299 '406':
2300 $ref: '#/components/responses/NotAcceptable'
2301 '409':
2302 $ref: '#/components/responses/Conflict'
2303 '422':
2304 $ref: '#/components/responses/UnprocessableEntity'
2305 '500':
2306 $ref: '#/components/responses/InternalServerError'
2307 '503':
2308 $ref: '#/components/responses/ServiceUnavailable'
2309 '5XX':
2310 $ref: '#/components/responses/UnexpectedError'
2311 default:
2312 $ref: '#/components/responses/UnexpectedError'
2313 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
2314 parameters:
2315 - name: nsInstanceContentId
2316 in: path
2317 required: true
2318 description: NS Instance Content ID
2319 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002320 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002321 get:
2322 tags:
2323 - "NS instances"
2324 summary: Read an individual NS instance resource
2325 description: Read an individual NS instance resource
2326 operationId: getNSinstanceContent
2327 responses:
2328 '200':
2329 description: OK
2330 content:
2331 application/json:
2332 schema:
2333 $ref: '#/components/schemas/NsInstance'
2334 application/yaml:
2335 schema:
2336 $ref: '#/components/schemas/NsInstance'
2337 '400':
2338 $ref: '#/components/responses/BadRequest'
2339 '401':
2340 $ref: '#/components/responses/Unauthorized'
2341 '403':
2342 $ref: '#/components/responses/Forbidden'
2343 '404':
2344 $ref: '#/components/responses/NotFound'
2345 '405':
2346 $ref: '#/components/responses/MethodNotAllowed'
2347 '406':
2348 $ref: '#/components/responses/NotAcceptable'
2349 '409':
2350 $ref: '#/components/responses/Conflict'
2351 '422':
2352 $ref: '#/components/responses/UnprocessableEntity'
2353 '500':
2354 $ref: '#/components/responses/InternalServerError'
2355 '503':
2356 $ref: '#/components/responses/ServiceUnavailable'
2357 '5XX':
2358 $ref: '#/components/responses/UnexpectedError'
2359 default:
2360 $ref: '#/components/responses/UnexpectedError'
2361 delete:
2362 tags:
2363 - "NS instances"
2364 summary: Delete an individual NS instance resource
2365 description: Delete an individual NS instance resource
2366 operationId: deleteNSinstanceContent
2367 responses:
2368 '202':
2369 description: Accepted
2370 content:
2371 application/json:
2372 schema:
2373 $ref: '#/components/schemas/ObjectId'
2374 application/yaml:
2375 schema:
2376 $ref: '#/components/schemas/ObjectId'
2377 '204':
2378 description: No Content
2379 '400':
2380 $ref: '#/components/responses/BadRequest'
2381 '401':
2382 $ref: '#/components/responses/Unauthorized'
2383 '403':
2384 $ref: '#/components/responses/Forbidden'
2385 '404':
2386 $ref: '#/components/responses/NotFound'
2387 '405':
2388 $ref: '#/components/responses/MethodNotAllowed'
2389 '406':
2390 $ref: '#/components/responses/NotAcceptable'
2391 '409':
2392 $ref: '#/components/responses/Conflict'
2393 '422':
2394 $ref: '#/components/responses/UnprocessableEntity'
2395 '500':
2396 $ref: '#/components/responses/InternalServerError'
2397 '503':
2398 $ref: '#/components/responses/ServiceUnavailable'
2399 '5XX':
2400 $ref: '#/components/responses/UnexpectedError'
2401 default:
2402 $ref: '#/components/responses/UnexpectedError'
2403 '/nslcm/v1/ns_lcm_op_occs':
2404 get:
2405 tags:
2406 - "NS instances"
2407 summary: Query information about multiple NS LCM Operation Occurrences
2408 description: Query information about multiple NS LCM Operation Occurrences
2409 operationId: getNSLCMOpOccs
2410 responses:
2411 '200':
2412 description: OK
2413 content:
2414 application/json:
2415 schema:
2416 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2417 application/yaml:
2418 schema:
2419 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2420 '400':
2421 $ref: '#/components/responses/BadRequest'
2422 '401':
2423 $ref: '#/components/responses/Unauthorized'
2424 '403':
2425 $ref: '#/components/responses/Forbidden'
2426 '404':
2427 $ref: '#/components/responses/NotFound'
2428 '405':
2429 $ref: '#/components/responses/MethodNotAllowed'
2430 '406':
2431 $ref: '#/components/responses/NotAcceptable'
2432 '409':
2433 $ref: '#/components/responses/Conflict'
2434 '422':
2435 $ref: '#/components/responses/UnprocessableEntity'
2436 '500':
2437 $ref: '#/components/responses/InternalServerError'
2438 '503':
2439 $ref: '#/components/responses/ServiceUnavailable'
2440 '5XX':
2441 $ref: '#/components/responses/UnexpectedError'
2442 default:
2443 $ref: '#/components/responses/UnexpectedError'
2444 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2445 parameters:
2446 - name: nsLcmOpOccId
2447 in: path
2448 required: true
2449 description: NS LCM Operation Occurrence ID
2450 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002451 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002452 get:
2453 tags:
2454 - "NS instances"
2455 summary: Query information about an individual NS LCM Operation Occurrence
2456 description: Query information about an individual NS LCM Operation Occurrence
2457 operationId: getNSLCMOpOcc
2458 responses:
2459 '200':
2460 description: OK
2461 content:
2462 application/json:
2463 schema:
2464 $ref: '#/components/schemas/NsLcmOpOcc'
2465 application/yaml:
2466 schema:
2467 $ref: '#/components/schemas/NsLcmOpOcc'
2468 '400':
2469 $ref: '#/components/responses/BadRequest'
2470 '401':
2471 $ref: '#/components/responses/Unauthorized'
2472 '403':
2473 $ref: '#/components/responses/Forbidden'
2474 '404':
2475 $ref: '#/components/responses/NotFound'
2476 '405':
2477 $ref: '#/components/responses/MethodNotAllowed'
2478 '406':
2479 $ref: '#/components/responses/NotAcceptable'
2480 '409':
2481 $ref: '#/components/responses/Conflict'
2482 '422':
2483 $ref: '#/components/responses/UnprocessableEntity'
2484 '500':
2485 $ref: '#/components/responses/InternalServerError'
2486 '503':
2487 $ref: '#/components/responses/ServiceUnavailable'
2488 '5XX':
2489 $ref: '#/components/responses/UnexpectedError'
2490 default:
2491 $ref: '#/components/responses/UnexpectedError'
Gabriel Cuba2c8be082023-11-14 16:52:01 -05002492 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
2493 parameters:
2494 - name: nsLcmOpOccId
2495 in: path
2496 required: true
2497 description: NS LCM Operation Occurrence ID
2498 schema:
2499 type: string
2500 post:
2501 tags:
2502 - "NS instances"
2503 summary: Cancel an ongoing NS lifecycle management operation
2504 description: Cancel an ongoing NS lifecycle management operation while it is being executed or rolled back
2505 operationId: cancelNSLCMOpOcc
2506 requestBody:
2507 $ref: '#/components/requestBodies/CancelNSLCMOpOccRequest'
2508 responses:
2509 '202':
2510 description: Accepted
2511 '400':
2512 $ref: '#/components/responses/BadRequest'
2513 '401':
2514 $ref: '#/components/responses/Unauthorized'
2515 '403':
2516 $ref: '#/components/responses/Forbidden'
2517 '404':
2518 $ref: '#/components/responses/NotFound'
2519 '405':
2520 $ref: '#/components/responses/MethodNotAllowed'
2521 '406':
2522 $ref: '#/components/responses/NotAcceptable'
2523 '409':
2524 $ref: '#/components/responses/Conflict'
2525 '422':
2526 $ref: '#/components/responses/UnprocessableEntity'
2527 '500':
2528 $ref: '#/components/responses/InternalServerError'
2529 '503':
2530 $ref: '#/components/responses/ServiceUnavailable'
2531 '5XX':
2532 $ref: '#/components/responses/UnexpectedError'
2533 default:
2534 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002535 '/nslcm/v1/vnf_instances':
2536 get:
2537 tags:
2538 - "NS instances"
2539 summary: Query information about multiple VNF Instances
2540 description: Query information about multiple VNF Instances
2541 operationId: getVnfInstances
2542 responses:
2543 '200':
2544 description: OK
2545 content:
2546 application/json:
2547 schema:
2548 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2549 application/yaml:
2550 schema:
2551 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2552 '400':
2553 $ref: '#/components/responses/BadRequest'
2554 '401':
2555 $ref: '#/components/responses/Unauthorized'
2556 '403':
2557 $ref: '#/components/responses/Forbidden'
2558 '404':
2559 $ref: '#/components/responses/NotFound'
2560 '405':
2561 $ref: '#/components/responses/MethodNotAllowed'
2562 '406':
2563 $ref: '#/components/responses/NotAcceptable'
2564 '409':
2565 $ref: '#/components/responses/Conflict'
2566 '422':
2567 $ref: '#/components/responses/UnprocessableEntity'
2568 '500':
2569 $ref: '#/components/responses/InternalServerError'
2570 '503':
2571 $ref: '#/components/responses/ServiceUnavailable'
2572 '5XX':
2573 $ref: '#/components/responses/UnexpectedError'
2574 default:
2575 $ref: '#/components/responses/UnexpectedError'
2576 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2577 parameters:
2578 - name: vnfInstanceId
2579 in: path
2580 required: true
2581 description: VNF Instance ID
2582 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002583 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002584 get:
2585 tags:
2586 - "NS instances"
2587 summary: Query information about an individual VNF Instance
2588 description: Query information about an individual VNF Instance
2589 operationId: getVnfInstance
2590 responses:
2591 '200':
2592 description: OK
2593 content:
2594 application/json:
2595 schema:
2596 $ref: '#/components/schemas/VnfInstanceInfo'
2597 application/yaml:
2598 schema:
2599 $ref: '#/components/schemas/VnfInstanceInfo'
2600 '400':
2601 $ref: '#/components/responses/BadRequest'
2602 '401':
2603 $ref: '#/components/responses/Unauthorized'
2604 '403':
2605 $ref: '#/components/responses/Forbidden'
2606 '404':
2607 $ref: '#/components/responses/NotFound'
2608 '405':
2609 $ref: '#/components/responses/MethodNotAllowed'
2610 '406':
2611 $ref: '#/components/responses/NotAcceptable'
2612 '409':
2613 $ref: '#/components/responses/Conflict'
2614 '422':
2615 $ref: '#/components/responses/UnprocessableEntity'
2616 '500':
2617 $ref: '#/components/responses/InternalServerError'
2618 '503':
2619 $ref: '#/components/responses/ServiceUnavailable'
2620 '5XX':
2621 $ref: '#/components/responses/UnexpectedError'
2622 default:
2623 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +01002624 '/nslcm/v1/subscriptions':
preethika.p31b3a802020-07-28 09:14:01 +00002625 get:
2626 tags:
2627 - NS instances
2628 summary: Query information about multiple NS instance subscription
2629 description: Query information about multiple NS instance subscription
2630 operationId: getNsSubcriptions
2631 responses:
2632 '200':
2633 description: OK
2634 content:
2635 application/json:
2636 schema:
2637 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2638 application/yaml:
2639 schema:
2640 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2641 '400':
2642 $ref: '#/components/responses/BadRequest'
2643 '401':
2644 $ref: '#/components/responses/Unauthorized'
2645 '403':
2646 $ref: '#/components/responses/Forbidden'
2647 '404':
2648 $ref: '#/components/responses/NotFound'
2649 '405':
2650 $ref: '#/components/responses/MethodNotAllowed'
2651 '406':
2652 $ref: '#/components/responses/NotAcceptable'
2653 '409':
2654 $ref: '#/components/responses/Conflict'
2655 '422':
2656 $ref: '#/components/responses/UnprocessableEntity'
2657 '500':
2658 $ref: '#/components/responses/InternalServerError'
2659 '503':
2660 $ref: '#/components/responses/ServiceUnavailable'
2661 5XX:
2662 $ref: '#/components/responses/UnexpectedError'
2663 default:
2664 $ref: '#/components/responses/UnexpectedError'
2665 post:
2666 tags:
2667 - NS instances
2668 summary: Create a new subscription for the Network service
2669 description: Create a new subscription for the Network service
2670 operationId: addNsSubcriptions
2671 requestBody:
2672 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2673 responses:
2674 '201':
2675 description: Created
2676 headers:
2677 Location:
2678 schema:
2679 type: object
2680 content:
2681 application/json:
2682 schema:
2683 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2684 application/yaml:
2685 schema:
2686 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2687 '400':
2688 $ref: '#/components/responses/BadRequest'
2689 '401':
2690 $ref: '#/components/responses/Unauthorized'
2691 '403':
2692 $ref: '#/components/responses/Forbidden'
2693 '404':
2694 $ref: '#/components/responses/NotFound'
2695 '405':
2696 $ref: '#/components/responses/MethodNotAllowed'
2697 '406':
2698 $ref: '#/components/responses/NotAcceptable'
2699 '409':
2700 $ref: '#/components/responses/Conflict'
2701 '422':
2702 $ref: '#/components/responses/UnprocessableEntity'
2703 '500':
2704 $ref: '#/components/responses/InternalServerError'
2705 '503':
2706 $ref: '#/components/responses/ServiceUnavailable'
2707 5XX:
2708 $ref: '#/components/responses/UnexpectedError'
2709 default:
2710 $ref: '#/components/responses/UnexpectedError'
2711 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2712 parameters:
2713 - name: nsSubscriptionsId
2714 in: path
2715 required: true
2716 description: Network Service Subscription ID
2717 schema:
2718 type: string
2719 get:
2720 tags:
2721 - NS instances
2722 summary: Read information about an individual Network Service Subscription
2723 description: Read information about an individual Network Service Subscription
2724 operationId: getNsSubcriptionId
2725 responses:
2726 '200':
2727 description: OK
2728 content:
2729 application/json:
2730 schema:
2731 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2732 application/yaml:
2733 schema:
2734 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2735 '400':
2736 $ref: '#/components/responses/BadRequest'
2737 '401':
2738 $ref: '#/components/responses/Unauthorized'
2739 '403':
2740 $ref: '#/components/responses/Forbidden'
2741 '404':
2742 $ref: '#/components/responses/NotFound'
2743 '405':
2744 $ref: '#/components/responses/MethodNotAllowed'
2745 '406':
2746 $ref: '#/components/responses/NotAcceptable'
2747 '409':
2748 $ref: '#/components/responses/Conflict'
2749 '422':
2750 $ref: '#/components/responses/UnprocessableEntity'
2751 '500':
2752 $ref: '#/components/responses/InternalServerError'
2753 '503':
2754 $ref: '#/components/responses/ServiceUnavailable'
2755 5XX:
2756 $ref: '#/components/responses/UnexpectedError'
2757 default:
2758 $ref: '#/components/responses/UnexpectedError'
2759 delete:
2760 tags:
2761 - NS instances
2762 summary: Delete an individual Network Service Subscription
2763 description: Delete an individual Network Service Subscription
2764 operationId: deleteNsSubcriptionId
2765 responses:
2766 '204':
2767 description: No Content
2768 '400':
2769 $ref: '#/components/responses/BadRequest'
2770 '401':
2771 $ref: '#/components/responses/Unauthorized'
2772 '403':
2773 $ref: '#/components/responses/Forbidden'
2774 '404':
2775 $ref: '#/components/responses/NotFound'
2776 '405':
2777 $ref: '#/components/responses/MethodNotAllowed'
2778 '406':
2779 $ref: '#/components/responses/NotAcceptable'
2780 '409':
2781 $ref: '#/components/responses/Conflict'
2782 '422':
2783 $ref: '#/components/responses/UnprocessableEntity'
2784 '500':
2785 $ref: '#/components/responses/InternalServerError'
2786 '503':
2787 $ref: '#/components/responses/ServiceUnavailable'
2788 5XX:
2789 $ref: '#/components/responses/UnexpectedError'
2790 default:
2791 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002792# END NS Instances
2793
Atul Agarwal4cd9e952021-05-20 09:24:26 +00002794# BEGIN Alarms
2795 '/nsfm/v1/alarms':
2796 get:
2797 tags:
2798 - "Alarms"
2799 summary: Query information about multiple alarms
2800 description: Query information about multiple alarms
2801 operationId: getAlarms
2802 responses:
2803 '200':
2804 description: OK
2805 content:
2806 application/json:
2807 schema:
2808 $ref: '#/components/schemas/ArrayOfAlarm'
2809 application/yaml:
2810 schema:
2811 $ref: '#/components/schemas/ArrayOfAlarm'
2812 '400':
2813 $ref: '#/components/responses/BadRequest'
2814 '401':
2815 $ref: '#/components/responses/Unauthorized'
2816 '403':
2817 $ref: '#/components/responses/Forbidden'
2818 '404':
2819 $ref: '#/components/responses/NotFound'
2820 '405':
2821 $ref: '#/components/responses/MethodNotAllowed'
2822 '406':
2823 $ref: '#/components/responses/NotAcceptable'
2824 '409':
2825 $ref: '#/components/responses/Conflict'
2826 '422':
2827 $ref: '#/components/responses/UnprocessableEntity'
2828 '500':
2829 $ref: '#/components/responses/InternalServerError'
2830 '503':
2831 $ref: '#/components/responses/ServiceUnavailable'
2832 '5XX':
2833 $ref: '#/components/responses/UnexpectedError'
2834 default:
2835 $ref: '#/components/responses/UnexpectedError'
2836 '/nsfm/v1/alarms/{uuid}':
2837 parameters:
2838 - name: uuid
2839 in: path
2840 required: true
2841 description: Alarm UUID
2842 schema:
2843 type: string
2844 get:
2845 tags:
2846 - "Alarms"
2847 summary: Read an individual Alarm
2848 description: Read an individual Alarm
2849 operationId: getAlarm
2850 responses:
2851 '200':
2852 description: OK
2853 content:
2854 application/json:
2855 schema:
2856 $ref: '#/components/schemas/Alarm'
2857 application/yaml:
2858 schema:
2859 $ref: '#/components/schemas/Alarm'
2860 '400':
2861 $ref: '#/components/responses/BadRequest'
2862 '401':
2863 $ref: '#/components/responses/Unauthorized'
2864 '403':
2865 $ref: '#/components/responses/Forbidden'
2866 '404':
2867 $ref: '#/components/responses/NotFound'
2868 '405':
2869 $ref: '#/components/responses/MethodNotAllowed'
2870 '406':
2871 $ref: '#/components/responses/NotAcceptable'
2872 '409':
2873 $ref: '#/components/responses/Conflict'
2874 '422':
2875 $ref: '#/components/responses/UnprocessableEntity'
2876 '500':
2877 $ref: '#/components/responses/InternalServerError'
2878 '503':
2879 $ref: '#/components/responses/ServiceUnavailable'
2880 '5XX':
2881 $ref: '#/components/responses/UnexpectedError'
2882 default:
2883 $ref: '#/components/responses/UnexpectedError'
2884 patch:
2885 tags:
2886 - "Alarms"
2887 summary: Modify the data of an individual Alarm
2888 description: Modify the data of an individual Alarm
2889 operationId: updateAlarm
2890 requestBody:
2891 $ref: '#/components/requestBodies/AlarmInfoModifications'
2892 responses:
2893 '204':
2894 description: No Content
2895 '400':
2896 $ref: '#/components/responses/BadRequest'
2897 '401':
2898 $ref: '#/components/responses/Unauthorized'
2899 '403':
2900 $ref: '#/components/responses/Forbidden'
2901 '404':
2902 $ref: '#/components/responses/NotFound'
2903 '405':
2904 $ref: '#/components/responses/MethodNotAllowed'
2905 '406':
2906 $ref: '#/components/responses/NotAcceptable'
2907 '409':
2908 $ref: '#/components/responses/Conflict'
2909 '422':
2910 $ref: '#/components/responses/UnprocessableEntity'
2911 '500':
2912 $ref: '#/components/responses/InternalServerError'
2913 '503':
2914 $ref: '#/components/responses/ServiceUnavailable'
2915 '5XX':
2916 $ref: '#/components/responses/UnexpectedError'
2917 default:
2918 $ref: '#/components/responses/UnexpectedError'
2919# END Alarms
2920
delacruzramfb52ade2019-10-07 16:46:59 +02002921# BEGIN NetSlice Templates
2922 '/nst/v1/netslice_templates':
2923 get:
2924 tags:
2925 - "NetSlice templates"
2926 summary: Query information about multiple NetSlice template resources
2927 description: Query information about multiple NetSlice template resources
2928 operationId: getNSTs
2929 responses:
2930 '200':
2931 description: OK
2932 content:
2933 application/json:
2934 schema:
2935 $ref: '#/components/schemas/ArrayOfNstInfo'
2936 application/yaml:
2937 schema:
2938 $ref: '#/components/schemas/ArrayOfNstInfo'
2939 '400':
2940 $ref: '#/components/responses/BadRequest'
2941 '401':
2942 $ref: '#/components/responses/Unauthorized'
2943 '403':
2944 $ref: '#/components/responses/Forbidden'
2945 '404':
2946 $ref: '#/components/responses/NotFound'
2947 '405':
2948 $ref: '#/components/responses/MethodNotAllowed'
2949 '406':
2950 $ref: '#/components/responses/NotAcceptable'
2951 '409':
2952 $ref: '#/components/responses/Conflict'
2953 '422':
2954 $ref: '#/components/responses/UnprocessableEntity'
2955 '500':
2956 $ref: '#/components/responses/InternalServerError'
2957 '503':
2958 $ref: '#/components/responses/ServiceUnavailable'
2959 '5XX':
2960 $ref: '#/components/responses/UnexpectedError'
2961 default:
2962 $ref: '#/components/responses/UnexpectedError'
2963 post:
2964 tags:
2965 - "NetSlice templates"
2966 summary: Create a new NetSlice template resource
2967 description: Create a new NetSlice template resource
2968 operationId: addNST
2969 requestBody:
2970 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2971 responses:
2972 '201':
2973 description: Created
2974 headers:
2975 Location:
2976 schema:
2977 type: string
2978 format: uri
2979 content:
2980 application/json:
2981 schema:
2982 $ref: '#/components/schemas/ObjectId'
2983 application/yaml:
2984 schema:
2985 $ref: '#/components/schemas/ObjectId'
2986 '400':
2987 $ref: '#/components/responses/BadRequest'
2988 '401':
2989 $ref: '#/components/responses/Unauthorized'
2990 '403':
2991 $ref: '#/components/responses/Forbidden'
2992 '404':
2993 $ref: '#/components/responses/NotFound'
2994 '405':
2995 $ref: '#/components/responses/MethodNotAllowed'
2996 '406':
2997 $ref: '#/components/responses/NotAcceptable'
2998 '409':
2999 $ref: '#/components/responses/Conflict'
3000 '422':
3001 $ref: '#/components/responses/UnprocessableEntity'
3002 '500':
3003 $ref: '#/components/responses/InternalServerError'
3004 '503':
3005 $ref: '#/components/responses/ServiceUnavailable'
3006 '5XX':
3007 $ref: '#/components/responses/UnexpectedError'
3008 default:
3009 $ref: '#/components/responses/UnexpectedError'
3010 '/nst/v1/netslice_templates/{netsliceTemplateId}':
3011 parameters:
3012 - name: netsliceTemplateId
3013 in: path
3014 required: true
3015 description: NetSlice Template ID
3016 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003017 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003018 get:
3019 tags:
3020 - "NetSlice templates"
3021 summary: Read information about an individual NetSlice template resource
3022 description: Read information about an individual NetSlice template resource
3023 operationId: getNST
3024 responses:
3025 '200':
3026 description: OK
3027 content:
3028 application/json:
3029 schema:
3030 $ref: '#/components/schemas/NstInfo'
3031 application/yaml:
3032 schema:
3033 $ref: '#/components/schemas/NstInfo'
3034 '400':
3035 $ref: '#/components/responses/BadRequest'
3036 '401':
3037 $ref: '#/components/responses/Unauthorized'
3038 '403':
3039 $ref: '#/components/responses/Forbidden'
3040 '404':
3041 $ref: '#/components/responses/NotFound'
3042 '405':
3043 $ref: '#/components/responses/MethodNotAllowed'
3044 '406':
3045 $ref: '#/components/responses/NotAcceptable'
3046 '409':
3047 $ref: '#/components/responses/Conflict'
3048 '422':
3049 $ref: '#/components/responses/UnprocessableEntity'
3050 '500':
3051 $ref: '#/components/responses/InternalServerError'
3052 '503':
3053 $ref: '#/components/responses/ServiceUnavailable'
3054 '5XX':
3055 $ref: '#/components/responses/UnexpectedError'
3056 default:
3057 $ref: '#/components/responses/UnexpectedError'
3058 delete:
3059 tags:
3060 - "NetSlice templates"
3061 summary: Delete an individual NetSlice template resource
3062 description: Delete an individual NetSlice template resource
3063 operationId: deleteNST
3064 responses:
3065 '204':
3066 description: No Content
3067 '400':
3068 $ref: '#/components/responses/BadRequest'
3069 '401':
3070 $ref: '#/components/responses/Unauthorized'
3071 '403':
3072 $ref: '#/components/responses/Forbidden'
3073 '404':
3074 $ref: '#/components/responses/NotFound'
3075 '405':
3076 $ref: '#/components/responses/MethodNotAllowed'
3077 '406':
3078 $ref: '#/components/responses/NotAcceptable'
3079 '409':
3080 $ref: '#/components/responses/Conflict'
3081 '422':
3082 $ref: '#/components/responses/UnprocessableEntity'
3083 '500':
3084 $ref: '#/components/responses/InternalServerError'
3085 '503':
3086 $ref: '#/components/responses/ServiceUnavailable'
3087 '5XX':
3088 $ref: '#/components/responses/UnexpectedError'
3089 default:
3090 $ref: '#/components/responses/UnexpectedError'
3091 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
3092 parameters:
3093 - name: netsliceTemplateId
3094 in: path
3095 required: true
3096 description: NetSlice Template ID
3097 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003098 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003099 - name: artifactPath
3100 in: path
3101 required: true
3102 description: Artifact Path
3103 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003104 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003105 get:
3106 tags:
3107 - "NetSlice templates"
3108 summary: Fetch individual NetSlice Template artifact
3109 description: Fetch individual NetSlice Template artifact
3110 operationId: getNstArtifact
3111 responses:
3112 '200':
3113 description: OK
3114 content:
3115 application/octet-stream:
3116 schema:
3117 type: string
3118 format: binary
3119 '206':
3120 description: Partial Content
3121 headers:
3122 Content-Range:
3123 schema:
3124 type: string
3125 content:
3126 application/octet-stream:
3127 schema:
3128 type: string
3129 format: binary
3130 '400':
3131 $ref: '#/components/responses/BadRequest'
3132 '401':
3133 $ref: '#/components/responses/Unauthorized'
3134 '403':
3135 $ref: '#/components/responses/Forbidden'
3136 '404':
3137 $ref: '#/components/responses/NotFound'
3138 '405':
3139 $ref: '#/components/responses/MethodNotAllowed'
3140 '406':
3141 $ref: '#/components/responses/NotAcceptable'
3142 '409':
3143 $ref: '#/components/responses/Conflict'
3144 '422':
3145 $ref: '#/components/responses/UnprocessableEntity'
3146 '500':
3147 $ref: '#/components/responses/InternalServerError'
3148 '503':
3149 $ref: '#/components/responses/ServiceUnavailable'
3150 '5XX':
3151 $ref: '#/components/responses/UnexpectedError'
3152 default:
3153 $ref: '#/components/responses/UnexpectedError'
3154 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
3155 parameters:
3156 - name: netsliceTemplateId
3157 in: path
3158 required: true
3159 description: NetSlice Template ID
3160 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003161 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003162 get:
3163 tags:
3164 - "NetSlice templates"
3165 summary: Read NST of an on-boarded NetSlice Template
3166 description: Read NST of an on-boarded NetSlice Template
3167 operationId: getNstNst
3168 responses:
3169 '200':
3170 description: OK
3171 content:
3172 text/plain:
3173 schema:
3174 $ref: '#/components/schemas/NetSliceTemplate'
3175 '400':
3176 $ref: '#/components/responses/BadRequest'
3177 '401':
3178 $ref: '#/components/responses/Unauthorized'
3179 '403':
3180 $ref: '#/components/responses/Forbidden'
3181 '404':
3182 $ref: '#/components/responses/NotFound'
3183 '405':
3184 $ref: '#/components/responses/MethodNotAllowed'
3185 '406':
3186 $ref: '#/components/responses/NotAcceptable'
3187 '409':
3188 $ref: '#/components/responses/Conflict'
3189 '422':
3190 $ref: '#/components/responses/UnprocessableEntity'
3191 '500':
3192 $ref: '#/components/responses/InternalServerError'
3193 '503':
3194 $ref: '#/components/responses/ServiceUnavailable'
3195 '5XX':
3196 $ref: '#/components/responses/UnexpectedError'
3197 default:
3198 $ref: '#/components/responses/UnexpectedError'
3199 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
3200 parameters:
3201 - name: netsliceTemplateId
3202 in: path
3203 required: true
3204 description: NetSlice Template ID
3205 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003206 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003207 get:
3208 tags:
3209 - "NetSlice templates"
3210 summary: Fetch the content of a NST
3211 description: Fetch the content of a NST
3212 operationId: getNSTcontent
3213 responses:
3214 '200':
3215 description: OK
3216 content:
3217 application/zip:
3218 schema:
3219 $ref: '#/components/schemas/NetSlicePackage'
3220 '206':
3221 description: Partial Content
3222 headers:
3223 Content-Range:
3224 schema:
3225 type: string
3226 content:
3227 application/zip:
3228 schema:
3229 $ref: '#/components/schemas/NetSlicePackage'
3230 '400':
3231 $ref: '#/components/responses/BadRequest'
3232 '401':
3233 $ref: '#/components/responses/Unauthorized'
3234 '403':
3235 $ref: '#/components/responses/Forbidden'
3236 '404':
3237 $ref: '#/components/responses/NotFound'
3238 '405':
3239 $ref: '#/components/responses/MethodNotAllowed'
3240 '406':
3241 $ref: '#/components/responses/NotAcceptable'
3242 '409':
3243 $ref: '#/components/responses/Conflict'
3244 '422':
3245 $ref: '#/components/responses/UnprocessableEntity'
3246 '500':
3247 $ref: '#/components/responses/InternalServerError'
3248 '503':
3249 $ref: '#/components/responses/ServiceUnavailable'
3250 '5XX':
3251 $ref: '#/components/responses/UnexpectedError'
3252 default:
3253 $ref: '#/components/responses/UnexpectedError'
3254 put:
3255 tags:
3256 - "NetSlice templates"
3257 summary: Upload the content of a NST
3258 description: Upload the content of a NST
3259 operationId: updateNSTcontent
3260 requestBody:
3261 $ref: '#/components/requestBodies/NetSlicePackage'
3262 responses:
3263 '202':
3264 description: Accepted
3265 '204':
3266 description: No Content
3267 '400':
3268 $ref: '#/components/responses/BadRequest'
3269 '401':
3270 $ref: '#/components/responses/Unauthorized'
3271 '403':
3272 $ref: '#/components/responses/Forbidden'
3273 '404':
3274 $ref: '#/components/responses/NotFound'
3275 '405':
3276 $ref: '#/components/responses/MethodNotAllowed'
3277 '406':
3278 $ref: '#/components/responses/NotAcceptable'
3279 '409':
3280 $ref: '#/components/responses/Conflict'
3281 '422':
3282 $ref: '#/components/responses/UnprocessableEntity'
3283 '500':
3284 $ref: '#/components/responses/InternalServerError'
3285 '503':
3286 $ref: '#/components/responses/ServiceUnavailable'
3287 '5XX':
3288 $ref: '#/components/responses/UnexpectedError'
3289 default:
3290 $ref: '#/components/responses/UnexpectedError'
3291 '/nst/v1/netslice_templates_content':
3292 post:
3293 tags:
3294 - "NetSlice templates"
3295 summary: Upload a NetSlice package by providing the content of the NetSlice package
3296 description: Upload a NetSlice package by providing the content of the NetSlice package
3297 operationId: uploadNstContent
3298 requestBody:
3299 content:
3300 application/zip:
3301 schema:
3302 $ref: '#/components/schemas/NetSlicePackage'
3303 responses:
3304 '201':
3305 description: Created
3306 headers:
3307 Location:
3308 schema:
3309 type: string
3310 format: uri
3311 content:
3312 application/json:
3313 schema:
3314 $ref: '#/components/schemas/ObjectId'
3315 application/yaml:
3316 schema:
3317 $ref: '#/components/schemas/ObjectId'
3318 '202':
3319 description: Accepted
3320 '204':
3321 description: No Content
3322 '400':
3323 $ref: '#/components/responses/BadRequest'
3324 '401':
3325 $ref: '#/components/responses/Unauthorized'
3326 '403':
3327 $ref: '#/components/responses/Forbidden'
3328 '404':
3329 $ref: '#/components/responses/NotFound'
3330 '405':
3331 $ref: '#/components/responses/MethodNotAllowed'
3332 '406':
3333 $ref: '#/components/responses/NotAcceptable'
3334 '409':
3335 $ref: '#/components/responses/Conflict'
3336 '422':
3337 $ref: '#/components/responses/UnprocessableEntity'
3338 '500':
3339 $ref: '#/components/responses/InternalServerError'
3340 '503':
3341 $ref: '#/components/responses/ServiceUnavailable'
3342 '5XX':
3343 $ref: '#/components/responses/UnexpectedError'
3344 default:
3345 $ref: '#/components/responses/UnexpectedError'
3346 get:
3347 tags:
3348 - "NetSlice templates"
3349 summary: Query information about multiple NetSlice Template resources
3350 description: Query information about multiple NetSlice Template resources
3351 operationId: getNstContent
3352 responses:
3353 '200':
3354 description: OK
3355 content:
3356 application/json:
3357 schema:
3358 $ref: '#/components/schemas/ArrayOfNstInfo'
3359 application/yaml:
3360 schema:
3361 $ref: '#/components/schemas/ArrayOfNstInfo'
3362 '206':
3363 description: Partial Content
3364 headers:
3365 Content-Range:
3366 schema:
3367 type: string
3368 content:
3369 application/octet-stream:
3370 schema:
3371 type: string
3372 format: binary
3373 '400':
3374 $ref: '#/components/responses/BadRequest'
3375 '401':
3376 $ref: '#/components/responses/Unauthorized'
3377 '403':
3378 $ref: '#/components/responses/Forbidden'
3379 '404':
3380 $ref: '#/components/responses/NotFound'
3381 '405':
3382 $ref: '#/components/responses/MethodNotAllowed'
3383 '406':
3384 $ref: '#/components/responses/NotAcceptable'
3385 '409':
3386 $ref: '#/components/responses/Conflict'
3387 '422':
3388 $ref: '#/components/responses/UnprocessableEntity'
3389 '500':
3390 $ref: '#/components/responses/InternalServerError'
3391 '503':
3392 $ref: '#/components/responses/ServiceUnavailable'
3393 '5XX':
3394 $ref: '#/components/responses/UnexpectedError'
3395 default:
3396 $ref: '#/components/responses/UnexpectedError'
3397 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
3398 parameters:
3399 - name: netsliceTemplateContentId
3400 in: path
3401 required: true
3402 description: NetSlice Template ID
3403 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003404 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003405 get:
3406 tags:
3407 - "NetSlice templates"
3408 summary: Read information about an individual NetSlice Template resource
3409 description: Read information about an individual NetSlice Template resource
3410 operationId: getNstIdContent
3411 responses:
3412 '200':
3413 description: OK
3414 content:
3415 application/json:
3416 schema:
3417 $ref: '#/components/schemas/NstInfo'
3418 application/yaml:
3419 schema:
3420 $ref: '#/components/schemas/NstInfo'
3421 '400':
3422 $ref: '#/components/responses/BadRequest'
3423 '401':
3424 $ref: '#/components/responses/Unauthorized'
3425 '403':
3426 $ref: '#/components/responses/Forbidden'
3427 '404':
3428 $ref: '#/components/responses/NotFound'
3429 '405':
3430 $ref: '#/components/responses/MethodNotAllowed'
3431 '406':
3432 $ref: '#/components/responses/NotAcceptable'
3433 '409':
3434 $ref: '#/components/responses/Conflict'
3435 '422':
3436 $ref: '#/components/responses/UnprocessableEntity'
3437 '500':
3438 $ref: '#/components/responses/InternalServerError'
3439 '503':
3440 $ref: '#/components/responses/ServiceUnavailable'
3441 '5XX':
3442 $ref: '#/components/responses/UnexpectedError'
3443 default:
3444 $ref: '#/components/responses/UnexpectedError'
3445 put:
3446 tags:
3447 - "NetSlice templates"
3448 summary: Modify an individual NetSlice Template resource
3449 description: Modify an individual NetSlice Template resource
3450 operationId: updateNstIdContent
3451 requestBody:
3452 $ref: '#/components/requestBodies/NstInfoModifications'
3453 responses:
3454 '204':
3455 description: No Content
3456 '400':
3457 $ref: '#/components/responses/BadRequest'
3458 '401':
3459 $ref: '#/components/responses/Unauthorized'
3460 '403':
3461 $ref: '#/components/responses/Forbidden'
3462 '404':
3463 $ref: '#/components/responses/NotFound'
3464 '405':
3465 $ref: '#/components/responses/MethodNotAllowed'
3466 '406':
3467 $ref: '#/components/responses/NotAcceptable'
3468 '409':
3469 $ref: '#/components/responses/Conflict'
3470 '422':
3471 $ref: '#/components/responses/UnprocessableEntity'
3472 '500':
3473 $ref: '#/components/responses/InternalServerError'
3474 '503':
3475 $ref: '#/components/responses/ServiceUnavailable'
3476 '5XX':
3477 $ref: '#/components/responses/UnexpectedError'
3478 default:
3479 $ref: '#/components/responses/UnexpectedError'
3480 delete:
3481 tags:
3482 - "NetSlice templates"
3483 summary: Delete an individual NetSlice Template resource
3484 description: Delete an individual NetSlice Template resource
3485 operationId: deleteNstIdContent
3486 responses:
3487 '204':
3488 description: No Content
3489 '400':
3490 $ref: '#/components/responses/BadRequest'
3491 '401':
3492 $ref: '#/components/responses/Unauthorized'
3493 '403':
3494 $ref: '#/components/responses/Forbidden'
3495 '404':
3496 $ref: '#/components/responses/NotFound'
3497 '405':
3498 $ref: '#/components/responses/MethodNotAllowed'
3499 '406':
3500 $ref: '#/components/responses/NotAcceptable'
3501 '409':
3502 $ref: '#/components/responses/Conflict'
3503 '422':
3504 $ref: '#/components/responses/UnprocessableEntity'
3505 '500':
3506 $ref: '#/components/responses/InternalServerError'
3507 '503':
3508 $ref: '#/components/responses/ServiceUnavailable'
3509 '5XX':
3510 $ref: '#/components/responses/UnexpectedError'
3511 default:
3512 $ref: '#/components/responses/UnexpectedError'
3513# END NetSlice Templates
3514
3515# BEGIN NetSlice Instances
3516 '/nsilcm/v1/netslice_instances':
3517 get:
3518 tags:
3519 - "NetSlice instances"
3520 summary: Query information about multiple NetSlice instances
3521 description: Query information about multiple NetSlice isntances
3522 operationId: getNSIs
3523 responses:
3524 '200':
3525 description: OK
3526 content:
3527 application/json:
3528 schema:
3529 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3530 application/yaml:
3531 schema:
3532 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3533 '400':
3534 $ref: '#/components/responses/BadRequest'
3535 '401':
3536 $ref: '#/components/responses/Unauthorized'
3537 '403':
3538 $ref: '#/components/responses/Forbidden'
3539 '404':
3540 $ref: '#/components/responses/NotFound'
3541 '405':
3542 $ref: '#/components/responses/MethodNotAllowed'
3543 '406':
3544 $ref: '#/components/responses/NotAcceptable'
3545 '409':
3546 $ref: '#/components/responses/Conflict'
3547 '422':
3548 $ref: '#/components/responses/UnprocessableEntity'
3549 '500':
3550 $ref: '#/components/responses/InternalServerError'
3551 '503':
3552 $ref: '#/components/responses/ServiceUnavailable'
3553 '5XX':
3554 $ref: '#/components/responses/UnexpectedError'
3555 default:
3556 $ref: '#/components/responses/UnexpectedError'
3557 post:
3558 tags:
3559 - "NetSlice instances"
3560 summary: Create a new NetSlice instance resource
3561 description: Create a new NetSlice instance resource
3562 operationId: addNSI
3563 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02003564 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02003565 responses:
3566 '201':
3567 description: Created
3568 headers:
3569 Location:
3570 schema:
3571 type: string
3572 format: uri
3573 content:
3574 application/json:
3575 schema:
3576 $ref: '#/components/schemas/ObjectId'
3577 application/yaml:
3578 schema:
3579 $ref: '#/components/schemas/ObjectId'
3580 '400':
3581 $ref: '#/components/responses/BadRequest'
3582 '401':
3583 $ref: '#/components/responses/Unauthorized'
3584 '403':
3585 $ref: '#/components/responses/Forbidden'
3586 '404':
3587 $ref: '#/components/responses/NotFound'
3588 '405':
3589 $ref: '#/components/responses/MethodNotAllowed'
3590 '406':
3591 $ref: '#/components/responses/NotAcceptable'
3592 '409':
3593 $ref: '#/components/responses/Conflict'
3594 '422':
3595 $ref: '#/components/responses/UnprocessableEntity'
3596 '500':
3597 $ref: '#/components/responses/InternalServerError'
3598 '503':
3599 $ref: '#/components/responses/ServiceUnavailable'
3600 '5XX':
3601 $ref: '#/components/responses/UnexpectedError'
3602 default:
3603 $ref: '#/components/responses/UnexpectedError'
3604 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3605 parameters:
3606 - name: netsliceInstanceId
3607 in: path
3608 required: true
3609 description: NetSlice Instance ID
3610 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003611 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003612 get:
3613 tags:
3614 - "NetSlice instances"
3615 summary: Read an individual NetSlice instance resource
3616 description: Read an individual NetSlice instance resource
3617 operationId: getNSI
3618 responses:
3619 '200':
3620 description: OK
3621 content:
3622 application/json:
3623 schema:
3624 $ref: '#/components/schemas/NetSliceInstance'
3625 application/yaml:
3626 schema:
3627 $ref: '#/components/schemas/NetSliceInstance'
3628 '400':
3629 $ref: '#/components/responses/BadRequest'
3630 '401':
3631 $ref: '#/components/responses/Unauthorized'
3632 '403':
3633 $ref: '#/components/responses/Forbidden'
3634 '404':
3635 $ref: '#/components/responses/NotFound'
3636 '405':
3637 $ref: '#/components/responses/MethodNotAllowed'
3638 '406':
3639 $ref: '#/components/responses/NotAcceptable'
3640 '409':
3641 $ref: '#/components/responses/Conflict'
3642 '422':
3643 $ref: '#/components/responses/UnprocessableEntity'
3644 '500':
3645 $ref: '#/components/responses/InternalServerError'
3646 '503':
3647 $ref: '#/components/responses/ServiceUnavailable'
3648 '5XX':
3649 $ref: '#/components/responses/UnexpectedError'
3650 default:
3651 $ref: '#/components/responses/UnexpectedError'
3652 delete:
3653 tags:
3654 - "NetSlice instances"
3655 summary: Delete an individual NetSlice instance resource
3656 description: Delete an individual NetSlice instance resource
3657 operationId: deleteNSI
3658 responses:
3659 '204':
3660 description: No Content
3661 '400':
3662 $ref: '#/components/responses/BadRequest'
3663 '401':
3664 $ref: '#/components/responses/Unauthorized'
3665 '403':
3666 $ref: '#/components/responses/Forbidden'
3667 '404':
3668 $ref: '#/components/responses/NotFound'
3669 '405':
3670 $ref: '#/components/responses/MethodNotAllowed'
3671 '406':
3672 $ref: '#/components/responses/NotAcceptable'
3673 '409':
3674 $ref: '#/components/responses/Conflict'
3675 '422':
3676 $ref: '#/components/responses/UnprocessableEntity'
3677 '500':
3678 $ref: '#/components/responses/InternalServerError'
3679 '503':
3680 $ref: '#/components/responses/ServiceUnavailable'
3681 '5XX':
3682 $ref: '#/components/responses/UnexpectedError'
3683 default:
3684 $ref: '#/components/responses/UnexpectedError'
3685 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3686 parameters:
3687 - name: netsliceInstanceId
3688 in: path
3689 required: true
3690 description: NetSlice Instance ID
3691 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003692 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003693 post:
3694 tags:
3695 - "NetSlice instances"
3696 summary: Instantiate a NetSlice
3697 description: |
3698 Instantiate a NetSlice. The precondition is that the NetSlice instance
3699 must have been created and must be in NOT_INSTANTIATED state. As a result
3700 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3701 Operation Occurrence" resource for the request, and the NS instance state
3702 becomes INSTANTIATED.
3703 operationId: instantiateNSI
3704 requestBody:
3705 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3706 responses:
3707 '202':
3708 description: Accepted
3709 headers:
3710 Location:
3711 description: |
3712 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3713 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3714 schema:
3715 type: string
3716 format: uri
3717 content:
3718 application/json:
3719 schema:
3720 $ref: '#/components/schemas/ObjectId'
3721 application/yaml:
3722 schema:
3723 $ref: '#/components/schemas/ObjectId'
3724 '400':
3725 $ref: '#/components/responses/BadRequest'
3726 '401':
3727 $ref: '#/components/responses/Unauthorized'
3728 '403':
3729 $ref: '#/components/responses/Forbidden'
3730 '404':
3731 $ref: '#/components/responses/NotFound'
3732 '405':
3733 $ref: '#/components/responses/MethodNotAllowed'
3734 '406':
3735 $ref: '#/components/responses/NotAcceptable'
3736 '409':
3737 $ref: '#/components/responses/Conflict'
3738 '422':
3739 $ref: '#/components/responses/UnprocessableEntity'
3740 '500':
3741 $ref: '#/components/responses/InternalServerError'
3742 '503':
3743 $ref: '#/components/responses/ServiceUnavailable'
3744 '5XX':
3745 $ref: '#/components/responses/UnexpectedError'
3746 default:
3747 $ref: '#/components/responses/UnexpectedError'
3748 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3749 parameters:
3750 - name: netsliceInstanceId
3751 in: path
3752 required: true
3753 description: NetSlice Instance ID
3754 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003755 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003756 post:
3757 tags:
3758 - "NetSlice instances"
3759 summary: Terminate a NetSlice instance
3760 description: |
3761 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3762 must have been created and must be in INSTANTIATED state. As a result of the
3763 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3764 Occurrence" resource for the request, and the NetSlice instance state becomes
3765 NOT_INSTANTIATED.
3766 operationId: terminateNSI
3767 requestBody:
3768 # Request data is not required
3769 $ref: '#/components/requestBodies/TerminateNsiRequest'
3770 responses:
3771 '202':
3772 description: Accepted
3773 headers:
3774 Location:
3775 description: |
3776 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3777 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3778 schema:
3779 type: string
3780 format: uri
3781 content:
3782 application/json:
3783 schema:
3784 $ref: '#/components/schemas/ObjectId'
3785 application/yaml:
3786 schema:
3787 $ref: '#/components/schemas/ObjectId'
3788 '400':
3789 $ref: '#/components/responses/BadRequest'
3790 '401':
3791 $ref: '#/components/responses/Unauthorized'
3792 '403':
3793 $ref: '#/components/responses/Forbidden'
3794 '404':
3795 $ref: '#/components/responses/NotFound'
3796 '405':
3797 $ref: '#/components/responses/MethodNotAllowed'
3798 '406':
3799 $ref: '#/components/responses/NotAcceptable'
3800 '409':
3801 $ref: '#/components/responses/Conflict'
3802 '422':
3803 $ref: '#/components/responses/UnprocessableEntity'
3804 '500':
3805 $ref: '#/components/responses/InternalServerError'
3806 '503':
3807 $ref: '#/components/responses/ServiceUnavailable'
3808 '5XX':
3809 $ref: '#/components/responses/UnexpectedError'
3810 default:
3811 $ref: '#/components/responses/UnexpectedError'
3812 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3813 parameters:
3814 - name: netsliceInstanceId
3815 in: path
3816 required: true
3817 description: NetSlice Instance ID
3818 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003819 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003820 post:
3821 tags:
3822 - "NetSlice instances"
3823 summary: Execute an action on a NetSlice instance
3824 description: |
3825 Execute an action on a NetSlice instance.
3826 The NetSlice instance must have been created and must be in INSTANTIATED state.
3827 operationId: actionOnNSI
3828 requestBody:
3829 content:
3830 application/json:
3831 schema:
3832 $ref: '#/components/schemas/NsiActionRequest'
3833 application/yaml:
3834 schema:
3835 $ref: '#/components/schemas/NsiActionRequest'
3836 responses:
3837 '202':
3838 description: Accepted
3839 headers:
3840 Location:
3841 description: |
3842 It must point to the new "NS Lifecycle Operation Occurrence"
3843 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3844 schema:
3845 type: string
3846 format: uri
3847 content:
3848 application/json:
3849 schema:
3850 $ref: '#/components/schemas/ObjectId'
3851 application/yaml:
3852 schema:
3853 $ref: '#/components/schemas/ObjectId'
3854 '400':
3855 $ref: '#/components/responses/BadRequest'
3856 '401':
3857 $ref: '#/components/responses/Unauthorized'
3858 '403':
3859 $ref: '#/components/responses/Forbidden'
3860 '404':
3861 $ref: '#/components/responses/NotFound'
3862 '405':
3863 $ref: '#/components/responses/MethodNotAllowed'
3864 '406':
3865 $ref: '#/components/responses/NotAcceptable'
3866 '409':
3867 $ref: '#/components/responses/Conflict'
3868 '422':
3869 $ref: '#/components/responses/UnprocessableEntity'
3870 '500':
3871 $ref: '#/components/responses/InternalServerError'
3872 '503':
3873 $ref: '#/components/responses/ServiceUnavailable'
3874 '5XX':
3875 $ref: '#/components/responses/UnexpectedError'
3876 default:
3877 $ref: '#/components/responses/UnexpectedError'
3878 '/nsilcm/v1/netslice_instances_content':
3879 get:
3880 tags:
3881 - "NetSlice instances"
3882 summary: Query information about multiple NetSlice instances
3883 description: Query information about multiple NetSlice isntances
3884 operationId: getNSIsContent
3885 responses:
3886 '200':
3887 description: OK
3888 content:
3889 application/json:
3890 schema:
3891 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3892 application/yaml:
3893 schema:
3894 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3895 '400':
3896 $ref: '#/components/responses/BadRequest'
3897 '401':
3898 $ref: '#/components/responses/Unauthorized'
3899 '403':
3900 $ref: '#/components/responses/Forbidden'
3901 '404':
3902 $ref: '#/components/responses/NotFound'
3903 '405':
3904 $ref: '#/components/responses/MethodNotAllowed'
3905 '406':
3906 $ref: '#/components/responses/NotAcceptable'
3907 '409':
3908 $ref: '#/components/responses/Conflict'
3909 '422':
3910 $ref: '#/components/responses/UnprocessableEntity'
3911 '500':
3912 $ref: '#/components/responses/InternalServerError'
3913 '503':
3914 $ref: '#/components/responses/ServiceUnavailable'
3915 '5XX':
3916 $ref: '#/components/responses/UnexpectedError'
3917 default:
3918 $ref: '#/components/responses/UnexpectedError'
3919 post:
3920 tags:
3921 - "NetSlice instances"
3922 summary: Create a new NetSlice instance
3923 description: Create a new NetSlice instance
3924 operationId: createNSIContent
3925 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02003926 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02003927 responses:
3928 '201':
3929 description: Created
3930 headers:
3931 Location:
3932 schema:
3933 type: string
3934 format: uri
3935 content:
3936 application/json:
3937 schema:
3938 $ref: '#/components/schemas/CreateNsiContentResponse'
3939 application/yaml:
3940 schema:
3941 $ref: '#/components/schemas/CreateNsiContentResponse'
3942 '400':
3943 $ref: '#/components/responses/BadRequest'
3944 '401':
3945 $ref: '#/components/responses/Unauthorized'
3946 '403':
3947 $ref: '#/components/responses/Forbidden'
3948 '404':
3949 $ref: '#/components/responses/NotFound'
3950 '405':
3951 $ref: '#/components/responses/MethodNotAllowed'
3952 '406':
3953 $ref: '#/components/responses/NotAcceptable'
3954 '409':
3955 $ref: '#/components/responses/Conflict'
3956 '422':
3957 $ref: '#/components/responses/UnprocessableEntity'
3958 '500':
3959 $ref: '#/components/responses/InternalServerError'
3960 '503':
3961 $ref: '#/components/responses/ServiceUnavailable'
3962 '5XX':
3963 $ref: '#/components/responses/UnexpectedError'
3964 default:
3965 $ref: '#/components/responses/UnexpectedError'
3966 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3967 parameters:
3968 - name: netsliceInstanceContentId
3969 in: path
3970 required: true
3971 description: NetSlice Instance Content ID
3972 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003973 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003974 get:
3975 tags:
3976 - "NetSlice instances"
3977 summary: Read an individual NetSlice instance resource
3978 description: Read an individual NetSlice instance resource
3979 operationId: getNSIContent
3980 responses:
3981 '200':
3982 description: OK
3983 content:
3984 application/json:
3985 schema:
3986 $ref: '#/components/schemas/NetSliceInstance'
3987 application/yaml:
3988 schema:
3989 $ref: '#/components/schemas/NetSliceInstance'
3990 '400':
3991 $ref: '#/components/responses/BadRequest'
3992 '401':
3993 $ref: '#/components/responses/Unauthorized'
3994 '403':
3995 $ref: '#/components/responses/Forbidden'
3996 '404':
3997 $ref: '#/components/responses/NotFound'
3998 '405':
3999 $ref: '#/components/responses/MethodNotAllowed'
4000 '406':
4001 $ref: '#/components/responses/NotAcceptable'
4002 '409':
4003 $ref: '#/components/responses/Conflict'
4004 '422':
4005 $ref: '#/components/responses/UnprocessableEntity'
4006 '500':
4007 $ref: '#/components/responses/InternalServerError'
4008 '503':
4009 $ref: '#/components/responses/ServiceUnavailable'
4010 '5XX':
4011 $ref: '#/components/responses/UnexpectedError'
4012 default:
4013 $ref: '#/components/responses/UnexpectedError'
4014 delete:
4015 tags:
4016 - "NetSlice instances"
4017 summary: Delete an individual NS instance resource
4018 description: Delete an individual NS instance resource
4019 operationId: deleteNSIContent
4020 responses:
4021 '202':
4022 description: Accepted
4023 content:
4024 application/json:
4025 schema:
4026 $ref: '#/components/schemas/ObjectId'
4027 application/yaml:
4028 schema:
4029 $ref: '#/components/schemas/ObjectId'
4030 '204':
4031 description: No Content
4032 '400':
4033 $ref: '#/components/responses/BadRequest'
4034 '401':
4035 $ref: '#/components/responses/Unauthorized'
4036 '403':
4037 $ref: '#/components/responses/Forbidden'
4038 '404':
4039 $ref: '#/components/responses/NotFound'
4040 '405':
4041 $ref: '#/components/responses/MethodNotAllowed'
4042 '406':
4043 $ref: '#/components/responses/NotAcceptable'
4044 '409':
4045 $ref: '#/components/responses/Conflict'
4046 '422':
4047 $ref: '#/components/responses/UnprocessableEntity'
4048 '500':
4049 $ref: '#/components/responses/InternalServerError'
4050 '503':
4051 $ref: '#/components/responses/ServiceUnavailable'
4052 '5XX':
4053 $ref: '#/components/responses/UnexpectedError'
4054 default:
4055 $ref: '#/components/responses/UnexpectedError'
4056 '/nsilcm/v1/nsi_lcm_op_occs':
4057 get:
4058 tags:
4059 - "NetSlice instances"
4060 summary: Query information about multiple NetSlice LCM Operation Occurrences
4061 description: Query information about multiple NetSlice LCM Operation Occurrences
4062 operationId: getNsiLcmOpOccs
4063 responses:
4064 '200':
4065 description: OK
4066 content:
4067 application/json:
4068 schema:
4069 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
4070 application/yaml:
4071 schema:
4072 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
4073 '400':
4074 $ref: '#/components/responses/BadRequest'
4075 '401':
4076 $ref: '#/components/responses/Unauthorized'
4077 '403':
4078 $ref: '#/components/responses/Forbidden'
4079 '404':
4080 $ref: '#/components/responses/NotFound'
4081 '405':
4082 $ref: '#/components/responses/MethodNotAllowed'
4083 '406':
4084 $ref: '#/components/responses/NotAcceptable'
4085 '409':
4086 $ref: '#/components/responses/Conflict'
4087 '422':
4088 $ref: '#/components/responses/UnprocessableEntity'
4089 '500':
4090 $ref: '#/components/responses/InternalServerError'
4091 '503':
4092 $ref: '#/components/responses/ServiceUnavailable'
4093 '5XX':
4094 $ref: '#/components/responses/UnexpectedError'
4095 default:
4096 $ref: '#/components/responses/UnexpectedError'
4097 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
4098 parameters:
4099 - name: nsiLcmOpOccId
4100 in: path
4101 required: true
4102 description: NetSlice LCM Operation Occurrence ID
4103 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02004104 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02004105 get:
4106 tags:
4107 - "NetSlice instances"
4108 summary: Query information about an individual NetSlice LCM Operation Occurrence
4109 description: Query information about an individual NetSlice LCM Operation Occurrence
4110 operationId: getNsiLcmOpOcc
4111 responses:
4112 '200':
4113 description: OK
4114 content:
4115 application/json:
4116 schema:
4117 $ref: '#/components/schemas/NsiLcmOpOcc'
4118 application/yaml:
4119 schema:
4120 $ref: '#/components/schemas/NsiLcmOpOcc'
4121 '400':
4122 $ref: '#/components/responses/BadRequest'
4123 '401':
4124 $ref: '#/components/responses/Unauthorized'
4125 '403':
4126 $ref: '#/components/responses/Forbidden'
4127 '404':
4128 $ref: '#/components/responses/NotFound'
4129 '405':
4130 $ref: '#/components/responses/MethodNotAllowed'
4131 '406':
4132 $ref: '#/components/responses/NotAcceptable'
4133 '409':
4134 $ref: '#/components/responses/Conflict'
4135 '422':
4136 $ref: '#/components/responses/UnprocessableEntity'
4137 '500':
4138 $ref: '#/components/responses/InternalServerError'
4139 '503':
4140 $ref: '#/components/responses/ServiceUnavailable'
4141 '5XX':
4142 $ref: '#/components/responses/UnexpectedError'
4143 default:
4144 $ref: '#/components/responses/UnexpectedError'
4145# END NetSlice Instances
4146
4147# BEGIN NSPM
delacruzramaf79f3c2019-10-22 13:13:01 +02004148 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
4149 parameters:
4150 - name: pmJobId
4151 in: path
4152 required: true
4153 description: NS PM Job ID
4154 schema:
4155 type: string
4156 - name: nsId
4157 in: path
4158 required: true
4159 description: NS ID
4160 schema:
4161 type: string
4162 get:
4163 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004164 - "NS Performance Management"
delacruzramaf79f3c2019-10-22 13:13:01 +02004165 summary: Query information about an individual NS PM Job Report
4166 description: Query information about an individual NS PM Job Report
4167 operationId: getNsPmJobReport
4168 responses:
4169 '200':
4170 description: OK
4171 content:
4172 application/json:
4173 schema:
4174 $ref: '#/components/schemas/NsPmJobReportInfo'
4175 application/yaml:
4176 schema:
4177 $ref: '#/components/schemas/NsPmJobReportInfo'
4178 '400':
4179 $ref: '#/components/responses/BadRequest'
4180 '401':
4181 $ref: '#/components/responses/Unauthorized'
4182 '403':
4183 $ref: '#/components/responses/Forbidden'
4184 '404':
4185 $ref: '#/components/responses/NotFound'
4186 '405':
4187 $ref: '#/components/responses/MethodNotAllowed'
4188 '406':
4189 $ref: '#/components/responses/NotAcceptable'
4190 '409':
4191 $ref: '#/components/responses/Conflict'
4192 '422':
4193 $ref: '#/components/responses/UnprocessableEntity'
4194 '500':
4195 $ref: '#/components/responses/InternalServerError'
4196 '503':
4197 $ref: '#/components/responses/ServiceUnavailable'
4198 '5XX':
4199 $ref: '#/components/responses/UnexpectedError'
4200 default:
4201 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02004202# END NSPM
4203
4204# BEGIN PDU
delacruzramaf79f3c2019-10-22 13:13:01 +02004205 '/pdu/v1/pdu_descriptors':
4206 get:
4207 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004208 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004209 summary: Query information about multiple PDU Descriptors
4210 description: Query information about multiple PDU Descriptors
4211 operationId: getPDUs
4212 responses:
4213 '200':
4214 description: OK
4215 content:
4216 application/json:
4217 schema:
4218 $ref: '#/components/schemas/ArrayOfPduInfo'
4219 application/yaml:
4220 schema:
4221 $ref: '#/components/schemas/ArrayOfPduInfo'
4222 '400':
4223 $ref: '#/components/responses/BadRequest'
4224 '401':
4225 $ref: '#/components/responses/Unauthorized'
4226 '403':
4227 $ref: '#/components/responses/Forbidden'
4228 '404':
4229 $ref: '#/components/responses/NotFound'
4230 '405':
4231 $ref: '#/components/responses/MethodNotAllowed'
4232 '406':
4233 $ref: '#/components/responses/NotAcceptable'
4234 '409':
4235 $ref: '#/components/responses/Conflict'
4236 '422':
4237 $ref: '#/components/responses/UnprocessableEntity'
4238 '500':
4239 $ref: '#/components/responses/InternalServerError'
4240 '503':
4241 $ref: '#/components/responses/ServiceUnavailable'
4242 '5XX':
4243 $ref: '#/components/responses/UnexpectedError'
4244 default:
4245 $ref: '#/components/responses/UnexpectedError'
4246 post:
4247 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004248 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004249 summary: Create a new PDU
4250 description: Create a new PDU Descriptor
4251 operationId: createPDU
4252 requestBody:
4253 $ref: '#/components/requestBodies/CreatePduRequest'
4254 responses:
4255 '200':
4256 description: OK
4257 headers:
4258 Location:
4259 schema:
4260 type: string
4261 format: uri
4262 content:
4263 application/json:
4264 schema:
4265 $ref: '#/components/schemas/ObjectId'
4266 application/yaml:
4267 schema:
4268 $ref: '#/components/schemas/ObjectId'
4269 '400':
4270 $ref: '#/components/responses/BadRequest'
4271 '401':
4272 $ref: '#/components/responses/Unauthorized'
4273 '403':
4274 $ref: '#/components/responses/Forbidden'
4275 '404':
4276 $ref: '#/components/responses/NotFound'
4277 '405':
4278 $ref: '#/components/responses/MethodNotAllowed'
4279 '406':
4280 $ref: '#/components/responses/NotAcceptable'
4281 '409':
4282 $ref: '#/components/responses/Conflict'
4283 '422':
4284 $ref: '#/components/responses/UnprocessableEntity'
4285 '500':
4286 $ref: '#/components/responses/InternalServerError'
4287 '503':
4288 $ref: '#/components/responses/ServiceUnavailable'
4289 '5XX':
4290 $ref: '#/components/responses/UnexpectedError'
4291 default:
4292 $ref: '#/components/responses/UnexpectedError'
4293 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
4294 parameters:
4295 - name: pduDescriptorId
4296 in: path
4297 required: true
4298 description: PDU Descriptor ID
4299 schema:
4300 type: string
4301 get:
4302 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004303 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004304 summary: Query information about an individual PDU Descriptor
4305 description: Query information about an individual PDU Descriptor
4306 operationId: getPDU
4307 responses:
4308 '200':
4309 description: OK
4310 content:
4311 application/json:
4312 schema:
4313 $ref: '#/components/schemas/PduInfo'
4314 application/yaml:
4315 schema:
4316 $ref: '#/components/schemas/PduInfo'
4317 '400':
4318 $ref: '#/components/responses/BadRequest'
4319 '401':
4320 $ref: '#/components/responses/Unauthorized'
4321 '403':
4322 $ref: '#/components/responses/Forbidden'
4323 '404':
4324 $ref: '#/components/responses/NotFound'
4325 '405':
4326 $ref: '#/components/responses/MethodNotAllowed'
4327 '406':
4328 $ref: '#/components/responses/NotAcceptable'
4329 '409':
4330 $ref: '#/components/responses/Conflict'
4331 '422':
4332 $ref: '#/components/responses/UnprocessableEntity'
4333 '500':
4334 $ref: '#/components/responses/InternalServerError'
4335 '503':
4336 $ref: '#/components/responses/ServiceUnavailable'
4337 '5XX':
4338 $ref: '#/components/responses/UnexpectedError'
4339 default:
4340 $ref: '#/components/responses/UnexpectedError'
4341 patch:
4342 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004343 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004344 summary: Modify an individual PDU Descriptor
4345 description: Modify an individual PDU Descriptor
4346 operationId: editPDU
4347 requestBody:
4348 $ref: '#/components/requestBodies/EditPduRequest'
4349 responses:
4350 '204':
4351 description: No Content
4352 '400':
4353 $ref: '#/components/responses/BadRequest'
4354 '401':
4355 $ref: '#/components/responses/Unauthorized'
4356 '403':
4357 $ref: '#/components/responses/Forbidden'
4358 '404':
4359 $ref: '#/components/responses/NotFound'
4360 '405':
4361 $ref: '#/components/responses/MethodNotAllowed'
4362 '406':
4363 $ref: '#/components/responses/NotAcceptable'
4364 '409':
4365 $ref: '#/components/responses/Conflict'
4366 '422':
4367 $ref: '#/components/responses/UnprocessableEntity'
4368 '500':
4369 $ref: '#/components/responses/InternalServerError'
4370 '503':
4371 $ref: '#/components/responses/ServiceUnavailable'
4372 '5XX':
4373 $ref: '#/components/responses/UnexpectedError'
4374 default:
4375 $ref: '#/components/responses/UnexpectedError'
4376 delete:
4377 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004378 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004379 summary: Delete an individual PDU Descriptor
4380 description: Delete an individual PDU Descriptor
4381 operationId: deletePDU
4382 responses:
4383 '204':
4384 description: No Content
4385 '400':
4386 $ref: '#/components/responses/BadRequest'
4387 '401':
4388 $ref: '#/components/responses/Unauthorized'
4389 '403':
4390 $ref: '#/components/responses/Forbidden'
4391 '404':
4392 $ref: '#/components/responses/NotFound'
4393 '405':
4394 $ref: '#/components/responses/MethodNotAllowed'
4395 '406':
4396 $ref: '#/components/responses/NotAcceptable'
4397 '409':
4398 $ref: '#/components/responses/Conflict'
4399 '422':
4400 $ref: '#/components/responses/UnprocessableEntity'
4401 '500':
4402 $ref: '#/components/responses/InternalServerError'
4403 '503':
4404 $ref: '#/components/responses/ServiceUnavailable'
4405 '5XX':
4406 $ref: '#/components/responses/UnexpectedError'
4407 default:
4408 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02004409# END PDU
4410
4411# BEGIN Admin
delacruzramaf79f3c2019-10-22 13:13:01 +02004412 '/admin/v1/tokens':
4413 get:
4414 tags:
garciadeblas77849982020-02-28 15:41:43 +01004415 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004416 - "Admin"
4417 summary: Query information about multiple Tokens
4418 description: Query information about multiple Tokens
4419 operationId: getTokens
4420 responses:
4421 '200':
4422 description: OK
4423 content:
4424 application/json:
4425 schema:
4426 $ref: '#/components/schemas/ArrayOfTokenInfo'
4427 application/yaml:
4428 schema:
4429 $ref: '#/components/schemas/ArrayOfTokenInfo'
4430 '400':
4431 $ref: '#/components/responses/BadRequest'
4432 '401':
4433 $ref: '#/components/responses/Unauthorized'
4434 '403':
4435 $ref: '#/components/responses/Forbidden'
4436 '404':
4437 $ref: '#/components/responses/NotFound'
4438 '405':
4439 $ref: '#/components/responses/MethodNotAllowed'
4440 '406':
4441 $ref: '#/components/responses/NotAcceptable'
4442 '409':
4443 $ref: '#/components/responses/Conflict'
4444 '422':
4445 $ref: '#/components/responses/UnprocessableEntity'
4446 '500':
4447 $ref: '#/components/responses/InternalServerError'
4448 '503':
4449 $ref: '#/components/responses/ServiceUnavailable'
4450 '5XX':
4451 $ref: '#/components/responses/UnexpectedError'
4452 default:
4453 $ref: '#/components/responses/UnexpectedError'
4454 post:
4455 tags:
garciadeblas77849982020-02-28 15:41:43 +01004456 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004457 - "Admin"
4458 summary: Request a new Token
4459 description: Request a new Token
4460 operationId: createToken
4461 requestBody:
4462 $ref: '#/components/requestBodies/CreateTokenRequest'
4463 responses:
4464 '200':
4465 description: OK
4466 headers:
4467 Location:
4468 schema:
4469 type: string
4470 format: uri
4471 content:
4472 application/json:
4473 schema:
selvi.ja6f638b2022-03-23 12:27:35 +00004474 oneOf:
4475 - $ref: '#/components/schemas/TokenInfo'
4476 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02004477 application/yaml:
4478 schema:
selvi.ja6f638b2022-03-23 12:27:35 +00004479 oneOf:
4480 - $ref: '#/components/schemas/TokenInfo'
4481 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02004482 '400':
4483 $ref: '#/components/responses/BadRequest'
4484 '401':
4485 $ref: '#/components/responses/Unauthorized'
4486 '403':
4487 $ref: '#/components/responses/Forbidden'
4488 '404':
4489 $ref: '#/components/responses/NotFound'
4490 '405':
4491 $ref: '#/components/responses/MethodNotAllowed'
4492 '406':
4493 $ref: '#/components/responses/NotAcceptable'
4494 '409':
4495 $ref: '#/components/responses/Conflict'
4496 '422':
4497 $ref: '#/components/responses/UnprocessableEntity'
4498 '500':
4499 $ref: '#/components/responses/InternalServerError'
4500 '503':
4501 $ref: '#/components/responses/ServiceUnavailable'
4502 '5XX':
4503 $ref: '#/components/responses/UnexpectedError'
4504 default:
4505 $ref: '#/components/responses/UnexpectedError'
4506 delete:
4507 tags:
garciadeblas77849982020-02-28 15:41:43 +01004508 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004509 - "Admin"
4510 summary: Delete the Token indicated in the Authorization Header
4511 description: Delete the Token indicated in the Authorization Header
4512 operationId: deleteAuthToken
4513 responses:
4514 '200':
4515 description: OK
4516 content:
4517 application/json:
4518 schema:
4519 type: string
4520 application/yaml:
4521 schema:
4522 type: string
4523 '400':
4524 $ref: '#/components/responses/BadRequest'
4525 '401':
4526 $ref: '#/components/responses/Unauthorized'
4527 '403':
4528 $ref: '#/components/responses/Forbidden'
4529 '404':
4530 $ref: '#/components/responses/NotFound'
4531 '405':
4532 $ref: '#/components/responses/MethodNotAllowed'
4533 '406':
4534 $ref: '#/components/responses/NotAcceptable'
4535 '409':
4536 $ref: '#/components/responses/Conflict'
4537 '422':
4538 $ref: '#/components/responses/UnprocessableEntity'
4539 '500':
4540 $ref: '#/components/responses/InternalServerError'
4541 '503':
4542 $ref: '#/components/responses/ServiceUnavailable'
4543 '5XX':
4544 $ref: '#/components/responses/UnexpectedError'
4545 default:
4546 $ref: '#/components/responses/UnexpectedError'
4547 '/admin/v1/tokens/{tokenId}':
4548 parameters:
4549 - name: tokenId
4550 in: path
4551 required: true
4552 description: Token ID
4553 schema:
4554 type: string
4555 get:
4556 tags:
garciadeblas77849982020-02-28 15:41:43 +01004557 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004558 - "Admin"
4559 summary: Query information about an individual Token
4560 description: Query information about an individual Token
4561 operationId: getToken
4562 responses:
4563 '200':
4564 description: OK
4565 content:
4566 application/json:
4567 schema:
4568 $ref: '#/components/schemas/TokenInfo'
4569 application/yaml:
4570 schema:
4571 $ref: '#/components/schemas/TokenInfo'
4572 '400':
4573 $ref: '#/components/responses/BadRequest'
4574 '401':
4575 $ref: '#/components/responses/Unauthorized'
4576 '403':
4577 $ref: '#/components/responses/Forbidden'
4578 '404':
4579 $ref: '#/components/responses/NotFound'
4580 '405':
4581 $ref: '#/components/responses/MethodNotAllowed'
4582 '406':
4583 $ref: '#/components/responses/NotAcceptable'
4584 '409':
4585 $ref: '#/components/responses/Conflict'
4586 '422':
4587 $ref: '#/components/responses/UnprocessableEntity'
4588 '500':
4589 $ref: '#/components/responses/InternalServerError'
4590 '503':
4591 $ref: '#/components/responses/ServiceUnavailable'
4592 '5XX':
4593 $ref: '#/components/responses/UnexpectedError'
4594 default:
4595 $ref: '#/components/responses/UnexpectedError'
4596 delete:
4597 tags:
garciadeblas77849982020-02-28 15:41:43 +01004598 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004599 - "Admin"
4600 summary: Delete the Token indicated as parameter
4601 description: Delete the Token indicated as parameter
4602 operationId: deleteToken
4603 responses:
4604 '200':
4605 description: OK
4606 content:
4607 application/json:
4608 schema:
4609 type: string
4610 application/yaml:
4611 schema:
4612 type: string
4613 '400':
4614 $ref: '#/components/responses/BadRequest'
4615 '401':
4616 $ref: '#/components/responses/Unauthorized'
4617 '403':
4618 $ref: '#/components/responses/Forbidden'
4619 '404':
4620 $ref: '#/components/responses/NotFound'
4621 '405':
4622 $ref: '#/components/responses/MethodNotAllowed'
4623 '406':
4624 $ref: '#/components/responses/NotAcceptable'
4625 '409':
4626 $ref: '#/components/responses/Conflict'
4627 '422':
4628 $ref: '#/components/responses/UnprocessableEntity'
4629 '500':
4630 $ref: '#/components/responses/InternalServerError'
4631 '503':
4632 $ref: '#/components/responses/ServiceUnavailable'
4633 '5XX':
4634 $ref: '#/components/responses/UnexpectedError'
4635 default:
4636 $ref: '#/components/responses/UnexpectedError'
4637 '/admin/v1/users':
4638 get:
4639 tags:
garciadeblas77849982020-02-28 15:41:43 +01004640 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004641 - "Admin"
4642 summary: Query information about multiple Users
4643 description: Query information about multiple Users
4644 operationId: getUsers
4645 responses:
4646 '200':
4647 description: OK
4648 content:
4649 application/json:
4650 schema:
4651 $ref: '#/components/schemas/ArrayOfUserInfo'
4652 application/yaml:
4653 schema:
4654 $ref: '#/components/schemas/ArrayOfUserInfo'
4655 '400':
4656 $ref: '#/components/responses/BadRequest'
4657 '401':
4658 $ref: '#/components/responses/Unauthorized'
4659 '403':
4660 $ref: '#/components/responses/Forbidden'
4661 '404':
4662 $ref: '#/components/responses/NotFound'
4663 '405':
4664 $ref: '#/components/responses/MethodNotAllowed'
4665 '406':
4666 $ref: '#/components/responses/NotAcceptable'
4667 '409':
4668 $ref: '#/components/responses/Conflict'
4669 '422':
4670 $ref: '#/components/responses/UnprocessableEntity'
4671 '500':
4672 $ref: '#/components/responses/InternalServerError'
4673 '503':
4674 $ref: '#/components/responses/ServiceUnavailable'
4675 '5XX':
4676 $ref: '#/components/responses/UnexpectedError'
4677 default:
4678 $ref: '#/components/responses/UnexpectedError'
4679 post:
4680 tags:
garciadeblas77849982020-02-28 15:41:43 +01004681 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004682 - "Admin"
4683 summary: Create a new User
4684 description: Create a new User
4685 operationId: createUser
4686 requestBody:
4687 $ref: '#/components/requestBodies/CreateUserRequest'
4688 responses:
4689 '201':
4690 description: Created
4691 headers:
4692 Location:
4693 schema:
4694 type: string
4695 format: uri
4696 content:
4697 application/json:
4698 schema:
4699 $ref: '#/components/schemas/ObjectId'
4700 application/yaml:
4701 schema:
4702 $ref: '#/components/schemas/ObjectId'
4703 '400':
4704 $ref: '#/components/responses/BadRequest'
4705 '401':
4706 $ref: '#/components/responses/Unauthorized'
4707 '403':
4708 $ref: '#/components/responses/Forbidden'
4709 '404':
4710 $ref: '#/components/responses/NotFound'
4711 '405':
4712 $ref: '#/components/responses/MethodNotAllowed'
4713 '406':
4714 $ref: '#/components/responses/NotAcceptable'
4715 '409':
4716 $ref: '#/components/responses/Conflict'
4717 '422':
4718 $ref: '#/components/responses/UnprocessableEntity'
4719 '500':
4720 $ref: '#/components/responses/InternalServerError'
4721 '503':
4722 $ref: '#/components/responses/ServiceUnavailable'
4723 '5XX':
4724 $ref: '#/components/responses/UnexpectedError'
4725 default:
4726 $ref: '#/components/responses/UnexpectedError'
4727 '/admin/v1/users/{userId}':
4728 parameters:
4729 - name: userId
4730 in: path
4731 required: true
4732 description: User ID/Name
4733 schema:
4734 type: string
4735 get:
4736 tags:
garciadeblas77849982020-02-28 15:41:43 +01004737 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004738 - "Admin"
4739 summary: Query information about an individual User
4740 description: Query information about an individual User
4741 operationId: getUser
4742 responses:
4743 '200':
4744 description: OK
4745 content:
4746 application/json:
4747 schema:
4748 $ref: '#/components/schemas/UserInfo'
4749 application/yaml:
4750 schema:
4751 $ref: '#/components/schemas/UserInfo'
4752 '400':
4753 $ref: '#/components/responses/BadRequest'
4754 '401':
4755 $ref: '#/components/responses/Unauthorized'
4756 '403':
4757 $ref: '#/components/responses/Forbidden'
4758 '404':
4759 $ref: '#/components/responses/NotFound'
4760 '405':
4761 $ref: '#/components/responses/MethodNotAllowed'
4762 '406':
4763 $ref: '#/components/responses/NotAcceptable'
4764 '409':
4765 $ref: '#/components/responses/Conflict'
4766 '422':
4767 $ref: '#/components/responses/UnprocessableEntity'
4768 '500':
4769 $ref: '#/components/responses/InternalServerError'
4770 '503':
4771 $ref: '#/components/responses/ServiceUnavailable'
4772 '5XX':
4773 $ref: '#/components/responses/UnexpectedError'
4774 default:
4775 $ref: '#/components/responses/UnexpectedError'
4776 patch:
4777 tags:
garciadeblas77849982020-02-28 15:41:43 +01004778 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004779 - "Admin"
4780 summary: Modify a User
4781 description: Modify a User
4782 operationId: editUser
4783 requestBody:
4784 $ref: '#/components/requestBodies/EditUserRequest'
4785 responses:
4786 '204':
4787 description: No Content
4788 '400':
4789 $ref: '#/components/responses/BadRequest'
4790 '401':
4791 $ref: '#/components/responses/Unauthorized'
4792 '403':
4793 $ref: '#/components/responses/Forbidden'
4794 '404':
4795 $ref: '#/components/responses/NotFound'
4796 '405':
4797 $ref: '#/components/responses/MethodNotAllowed'
4798 '406':
4799 $ref: '#/components/responses/NotAcceptable'
4800 '409':
4801 $ref: '#/components/responses/Conflict'
4802 '422':
4803 $ref: '#/components/responses/UnprocessableEntity'
4804 '500':
4805 $ref: '#/components/responses/InternalServerError'
4806 '503':
4807 $ref: '#/components/responses/ServiceUnavailable'
4808 '5XX':
4809 $ref: '#/components/responses/UnexpectedError'
4810 default:
4811 $ref: '#/components/responses/UnexpectedError'
4812 delete:
4813 tags:
garciadeblas77849982020-02-28 15:41:43 +01004814 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004815 - "Admin"
4816 summary: Delete a User
4817 description: Delete a User
4818 operationId: deleteUser
4819 responses:
4820 '204':
4821 description: No Content
4822 '400':
4823 $ref: '#/components/responses/BadRequest'
4824 '401':
4825 $ref: '#/components/responses/Unauthorized'
4826 '403':
4827 $ref: '#/components/responses/Forbidden'
4828 '404':
4829 $ref: '#/components/responses/NotFound'
4830 '405':
4831 $ref: '#/components/responses/MethodNotAllowed'
4832 '406':
4833 $ref: '#/components/responses/NotAcceptable'
4834 '409':
4835 $ref: '#/components/responses/Conflict'
4836 '422':
4837 $ref: '#/components/responses/UnprocessableEntity'
4838 '500':
4839 $ref: '#/components/responses/InternalServerError'
4840 '503':
4841 $ref: '#/components/responses/ServiceUnavailable'
4842 '5XX':
4843 $ref: '#/components/responses/UnexpectedError'
4844 default:
4845 $ref: '#/components/responses/UnexpectedError'
4846 '/admin/v1/projects':
4847 get:
4848 tags:
garciadeblas77849982020-02-28 15:41:43 +01004849 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004850 - "Admin"
4851 summary: Query information about multiple Projects
4852 description: Query information about multiple Projects
4853 operationId: getProjects
4854 responses:
4855 '200':
4856 description: OK
4857 content:
4858 application/json:
4859 schema:
4860 $ref: '#/components/schemas/ArrayOfProjectInfo'
4861 application/yaml:
4862 schema:
4863 $ref: '#/components/schemas/ArrayOfProjectInfo'
4864 '400':
4865 $ref: '#/components/responses/BadRequest'
4866 '401':
4867 $ref: '#/components/responses/Unauthorized'
4868 '403':
4869 $ref: '#/components/responses/Forbidden'
4870 '404':
4871 $ref: '#/components/responses/NotFound'
4872 '405':
4873 $ref: '#/components/responses/MethodNotAllowed'
4874 '406':
4875 $ref: '#/components/responses/NotAcceptable'
4876 '409':
4877 $ref: '#/components/responses/Conflict'
4878 '422':
4879 $ref: '#/components/responses/UnprocessableEntity'
4880 '500':
4881 $ref: '#/components/responses/InternalServerError'
4882 '503':
4883 $ref: '#/components/responses/ServiceUnavailable'
4884 '5XX':
4885 $ref: '#/components/responses/UnexpectedError'
4886 default:
4887 $ref: '#/components/responses/UnexpectedError'
4888 post:
4889 tags:
garciadeblas77849982020-02-28 15:41:43 +01004890 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004891 - "Admin"
4892 summary: Create a new Project
4893 description: Create a new Project
4894 operationId: createProject
4895 requestBody:
4896 $ref: '#/components/requestBodies/CreateProjectRequest'
4897 responses:
4898 '201':
4899 description: Created
4900 headers:
4901 Location:
4902 schema:
4903 type: string
4904 format: uri
4905 content:
4906 application/json:
4907 schema:
4908 $ref: '#/components/schemas/ObjectId'
4909 application/yaml:
4910 schema:
4911 $ref: '#/components/schemas/ObjectId'
4912 '400':
4913 $ref: '#/components/responses/BadRequest'
4914 '401':
4915 $ref: '#/components/responses/Unauthorized'
4916 '403':
4917 $ref: '#/components/responses/Forbidden'
4918 '404':
4919 $ref: '#/components/responses/NotFound'
4920 '405':
4921 $ref: '#/components/responses/MethodNotAllowed'
4922 '406':
4923 $ref: '#/components/responses/NotAcceptable'
4924 '409':
4925 $ref: '#/components/responses/Conflict'
4926 '422':
4927 $ref: '#/components/responses/UnprocessableEntity'
4928 '500':
4929 $ref: '#/components/responses/InternalServerError'
4930 '503':
4931 $ref: '#/components/responses/ServiceUnavailable'
4932 '5XX':
4933 $ref: '#/components/responses/UnexpectedError'
4934 default:
4935 $ref: '#/components/responses/UnexpectedError'
4936 '/admin/v1/projects/{projectId}':
4937 parameters:
4938 - name: projectId
4939 in: path
4940 required: true
4941 description: Project ID/Name
4942 schema:
4943 type: string
4944 get:
4945 tags:
garciadeblas77849982020-02-28 15:41:43 +01004946 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004947 - "Admin"
4948 summary: Query information about an individual Project
4949 description: Query information about an individual Project
4950 operationId: getProject
4951 responses:
4952 '200':
4953 description: OK
4954 content:
4955 application/json:
4956 schema:
4957 $ref: '#/components/schemas/ProjectInfo'
4958 application/yaml:
4959 schema:
4960 $ref: '#/components/schemas/ProjectInfo'
4961 '400':
4962 $ref: '#/components/responses/BadRequest'
4963 '401':
4964 $ref: '#/components/responses/Unauthorized'
4965 '403':
4966 $ref: '#/components/responses/Forbidden'
4967 '404':
4968 $ref: '#/components/responses/NotFound'
4969 '405':
4970 $ref: '#/components/responses/MethodNotAllowed'
4971 '406':
4972 $ref: '#/components/responses/NotAcceptable'
4973 '409':
4974 $ref: '#/components/responses/Conflict'
4975 '422':
4976 $ref: '#/components/responses/UnprocessableEntity'
4977 '500':
4978 $ref: '#/components/responses/InternalServerError'
4979 '503':
4980 $ref: '#/components/responses/ServiceUnavailable'
4981 '5XX':
4982 $ref: '#/components/responses/UnexpectedError'
4983 default:
4984 $ref: '#/components/responses/UnexpectedError'
4985 patch:
4986 tags:
garciadeblas77849982020-02-28 15:41:43 +01004987 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004988 - "Admin"
4989 summary: Modify a Project
4990 description: Modify a Project
4991 operationId: editProject
4992 requestBody:
4993 $ref: '#/components/requestBodies/EditProjectRequest'
4994 responses:
4995 '204':
4996 description: No Content
4997 '400':
4998 $ref: '#/components/responses/BadRequest'
4999 '401':
5000 $ref: '#/components/responses/Unauthorized'
5001 '403':
5002 $ref: '#/components/responses/Forbidden'
5003 '404':
5004 $ref: '#/components/responses/NotFound'
5005 '405':
5006 $ref: '#/components/responses/MethodNotAllowed'
5007 '406':
5008 $ref: '#/components/responses/NotAcceptable'
5009 '409':
5010 $ref: '#/components/responses/Conflict'
5011 '422':
5012 $ref: '#/components/responses/UnprocessableEntity'
5013 '500':
5014 $ref: '#/components/responses/InternalServerError'
5015 '503':
5016 $ref: '#/components/responses/ServiceUnavailable'
5017 '5XX':
5018 $ref: '#/components/responses/UnexpectedError'
5019 default:
5020 $ref: '#/components/responses/UnexpectedError'
5021 delete:
5022 tags:
garciadeblas77849982020-02-28 15:41:43 +01005023 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005024 - "Admin"
5025 summary: Delete a Project
5026 description: Delete a Project
5027 operationId: deleteProject
5028 responses:
5029 '204':
5030 description: No Content
5031 '400':
5032 $ref: '#/components/responses/BadRequest'
5033 '401':
5034 $ref: '#/components/responses/Unauthorized'
5035 '403':
5036 $ref: '#/components/responses/Forbidden'
5037 '404':
5038 $ref: '#/components/responses/NotFound'
5039 '405':
5040 $ref: '#/components/responses/MethodNotAllowed'
5041 '406':
5042 $ref: '#/components/responses/NotAcceptable'
5043 '409':
5044 $ref: '#/components/responses/Conflict'
5045 '422':
5046 $ref: '#/components/responses/UnprocessableEntity'
5047 '500':
5048 $ref: '#/components/responses/InternalServerError'
5049 '503':
5050 $ref: '#/components/responses/ServiceUnavailable'
5051 '5XX':
5052 $ref: '#/components/responses/UnexpectedError'
5053 default:
5054 $ref: '#/components/responses/UnexpectedError'
5055 '/admin/v1/roles':
5056 get:
5057 tags:
garciadeblas77849982020-02-28 15:41:43 +01005058 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005059 - "Admin"
5060 summary: Query information about multiple Roles
5061 description: Query information about multiple Roles
5062 operationId: getRoles
5063 responses:
5064 '200':
5065 description: OK
5066 content:
5067 application/json:
5068 schema:
5069 $ref: '#/components/schemas/ArrayOfRoleInfo'
5070 application/yaml:
5071 schema:
5072 $ref: '#/components/schemas/ArrayOfRoleInfo'
5073 '400':
5074 $ref: '#/components/responses/BadRequest'
5075 '401':
5076 $ref: '#/components/responses/Unauthorized'
5077 '403':
5078 $ref: '#/components/responses/Forbidden'
5079 '404':
5080 $ref: '#/components/responses/NotFound'
5081 '405':
5082 $ref: '#/components/responses/MethodNotAllowed'
5083 '406':
5084 $ref: '#/components/responses/NotAcceptable'
5085 '409':
5086 $ref: '#/components/responses/Conflict'
5087 '422':
5088 $ref: '#/components/responses/UnprocessableEntity'
5089 '500':
5090 $ref: '#/components/responses/InternalServerError'
5091 '503':
5092 $ref: '#/components/responses/ServiceUnavailable'
5093 '5XX':
5094 $ref: '#/components/responses/UnexpectedError'
5095 default:
5096 $ref: '#/components/responses/UnexpectedError'
5097 post:
5098 tags:
garciadeblas77849982020-02-28 15:41:43 +01005099 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005100 - "Admin"
5101 summary: Create a new Role
5102 description: Create a new Role
5103 operationId: createRole
5104 requestBody:
5105 $ref: '#/components/requestBodies/CreateRoleRequest'
5106 responses:
5107 '201':
5108 description: Created
5109 headers:
5110 Location:
5111 schema:
5112 type: string
5113 format: uri
5114 content:
5115 application/json:
5116 schema:
5117 $ref: '#/components/schemas/ObjectId'
5118 application/yaml:
5119 schema:
5120 $ref: '#/components/schemas/ObjectId'
5121 '400':
5122 $ref: '#/components/responses/BadRequest'
5123 '401':
5124 $ref: '#/components/responses/Unauthorized'
5125 '403':
5126 $ref: '#/components/responses/Forbidden'
5127 '404':
5128 $ref: '#/components/responses/NotFound'
5129 '405':
5130 $ref: '#/components/responses/MethodNotAllowed'
5131 '406':
5132 $ref: '#/components/responses/NotAcceptable'
5133 '409':
5134 $ref: '#/components/responses/Conflict'
5135 '422':
5136 $ref: '#/components/responses/UnprocessableEntity'
5137 '500':
5138 $ref: '#/components/responses/InternalServerError'
5139 '503':
5140 $ref: '#/components/responses/ServiceUnavailable'
5141 '5XX':
5142 $ref: '#/components/responses/UnexpectedError'
5143 default:
5144 $ref: '#/components/responses/UnexpectedError'
5145 '/admin/v1/roles/{roleId}':
5146 parameters:
5147 - name: roleId
5148 in: path
5149 required: true
5150 description: Role ID/Name
5151 schema:
5152 type: string
5153 get:
5154 tags:
garciadeblas77849982020-02-28 15:41:43 +01005155 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005156 - "Admin"
5157 summary: Query information about an individual Role
5158 description: Query information about an individual Role
5159 operationId: getRole
5160 responses:
5161 '200':
5162 description: OK
5163 content:
5164 application/json:
5165 schema:
5166 $ref: '#/components/schemas/RoleInfo'
5167 application/yaml:
5168 schema:
5169 $ref: '#/components/schemas/RoleInfo'
5170 '400':
5171 $ref: '#/components/responses/BadRequest'
5172 '401':
5173 $ref: '#/components/responses/Unauthorized'
5174 '403':
5175 $ref: '#/components/responses/Forbidden'
5176 '404':
5177 $ref: '#/components/responses/NotFound'
5178 '405':
5179 $ref: '#/components/responses/MethodNotAllowed'
5180 '406':
5181 $ref: '#/components/responses/NotAcceptable'
5182 '409':
5183 $ref: '#/components/responses/Conflict'
5184 '422':
5185 $ref: '#/components/responses/UnprocessableEntity'
5186 '500':
5187 $ref: '#/components/responses/InternalServerError'
5188 '503':
5189 $ref: '#/components/responses/ServiceUnavailable'
5190 '5XX':
5191 $ref: '#/components/responses/UnexpectedError'
5192 default:
5193 $ref: '#/components/responses/UnexpectedError'
5194 patch:
5195 tags:
garciadeblas77849982020-02-28 15:41:43 +01005196 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005197 - "Admin"
5198 summary: Modify a Role
5199 description: Modify a Role
5200 operationId: editRole
5201 requestBody:
5202 $ref: '#/components/requestBodies/EditRoleRequest'
5203 responses:
5204 '204':
5205 description: No Content
5206 '400':
5207 $ref: '#/components/responses/BadRequest'
5208 '401':
5209 $ref: '#/components/responses/Unauthorized'
5210 '403':
5211 $ref: '#/components/responses/Forbidden'
5212 '404':
5213 $ref: '#/components/responses/NotFound'
5214 '405':
5215 $ref: '#/components/responses/MethodNotAllowed'
5216 '406':
5217 $ref: '#/components/responses/NotAcceptable'
5218 '409':
5219 $ref: '#/components/responses/Conflict'
5220 '422':
5221 $ref: '#/components/responses/UnprocessableEntity'
5222 '500':
5223 $ref: '#/components/responses/InternalServerError'
5224 '503':
5225 $ref: '#/components/responses/ServiceUnavailable'
5226 '5XX':
5227 $ref: '#/components/responses/UnexpectedError'
5228 default:
5229 $ref: '#/components/responses/UnexpectedError'
5230 delete:
5231 tags:
garciadeblas77849982020-02-28 15:41:43 +01005232 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005233 - "Admin"
5234 summary: Delete a Role
5235 description: Delete a Role
5236 operationId: deleteRole
5237 responses:
5238 '204':
5239 description: No Content
5240 '400':
5241 $ref: '#/components/responses/BadRequest'
5242 '401':
5243 $ref: '#/components/responses/Unauthorized'
5244 '403':
5245 $ref: '#/components/responses/Forbidden'
5246 '404':
5247 $ref: '#/components/responses/NotFound'
5248 '405':
5249 $ref: '#/components/responses/MethodNotAllowed'
5250 '406':
5251 $ref: '#/components/responses/NotAcceptable'
5252 '409':
5253 $ref: '#/components/responses/Conflict'
5254 '422':
5255 $ref: '#/components/responses/UnprocessableEntity'
5256 '500':
5257 $ref: '#/components/responses/InternalServerError'
5258 '503':
5259 $ref: '#/components/responses/ServiceUnavailable'
5260 '5XX':
5261 $ref: '#/components/responses/UnexpectedError'
5262 default:
5263 $ref: '#/components/responses/UnexpectedError'
5264 '/admin/v1/vims':
5265 get:
5266 tags:
garciadeblas77849982020-02-28 15:41:43 +01005267 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005268 - "Admin"
5269 summary: Query information about multiple VIMs
5270 description: Query information about multiple VIMs
5271 operationId: getVIMs
5272 responses:
5273 '200':
5274 description: OK
5275 content:
5276 application/json:
5277 schema:
5278 $ref: '#/components/schemas/ArrayOfVimInfo'
5279 application/yaml:
5280 schema:
5281 $ref: '#/components/schemas/ArrayOfVimInfo'
5282 '400':
5283 $ref: '#/components/responses/BadRequest'
5284 '401':
5285 $ref: '#/components/responses/Unauthorized'
5286 '403':
5287 $ref: '#/components/responses/Forbidden'
5288 '404':
5289 $ref: '#/components/responses/NotFound'
5290 '405':
5291 $ref: '#/components/responses/MethodNotAllowed'
5292 '406':
5293 $ref: '#/components/responses/NotAcceptable'
5294 '409':
5295 $ref: '#/components/responses/Conflict'
5296 '422':
5297 $ref: '#/components/responses/UnprocessableEntity'
5298 '500':
5299 $ref: '#/components/responses/InternalServerError'
5300 '503':
5301 $ref: '#/components/responses/ServiceUnavailable'
5302 '5XX':
5303 $ref: '#/components/responses/UnexpectedError'
5304 default:
5305 $ref: '#/components/responses/UnexpectedError'
5306 post:
5307 tags:
garciadeblas77849982020-02-28 15:41:43 +01005308 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005309 - "Admin"
5310 summary: Create a new VIM
5311 description: Create a new VIM
5312 operationId: createVIM
5313 requestBody:
5314 $ref: '#/components/requestBodies/CreateVimRequest'
5315 responses:
5316 '202':
5317 description: Accepted
5318 content:
5319 application/json:
5320 schema:
5321 $ref: '#/components/schemas/ObjectId_plus_OpId'
5322 application/yaml:
5323 schema:
5324 $ref: '#/components/schemas/ObjectId_plus_OpId'
5325 '400':
5326 $ref: '#/components/responses/BadRequest'
5327 '401':
5328 $ref: '#/components/responses/Unauthorized'
5329 '403':
5330 $ref: '#/components/responses/Forbidden'
5331 '404':
5332 $ref: '#/components/responses/NotFound'
5333 '405':
5334 $ref: '#/components/responses/MethodNotAllowed'
5335 '406':
5336 $ref: '#/components/responses/NotAcceptable'
5337 '409':
5338 $ref: '#/components/responses/Conflict'
5339 '422':
5340 $ref: '#/components/responses/UnprocessableEntity'
5341 '500':
5342 $ref: '#/components/responses/InternalServerError'
5343 '503':
5344 $ref: '#/components/responses/ServiceUnavailable'
5345 '5XX':
5346 $ref: '#/components/responses/UnexpectedError'
5347 default:
5348 $ref: '#/components/responses/UnexpectedError'
5349 '/admin/v1/vims/{vimId}':
5350 parameters:
5351 - name: vimId
5352 in: path
5353 required: true
5354 description: VIM ID
5355 schema:
5356 type: string
5357 format: uuid
5358 get:
5359 tags:
garciadeblas77849982020-02-28 15:41:43 +01005360 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005361 - "Admin"
5362 summary: Query information about an individual VIM
5363 description: Query information about an individual VIM
5364 operationId: getVIM
5365 responses:
5366 '200':
5367 description: OK
5368 content:
5369 application/json:
5370 schema:
5371 $ref: '#/components/schemas/VimInfo'
5372 application/yaml:
5373 schema:
5374 $ref: '#/components/schemas/VimInfo'
5375 '400':
5376 $ref: '#/components/responses/BadRequest'
5377 '401':
5378 $ref: '#/components/responses/Unauthorized'
5379 '403':
5380 $ref: '#/components/responses/Forbidden'
5381 '404':
5382 $ref: '#/components/responses/NotFound'
5383 '405':
5384 $ref: '#/components/responses/MethodNotAllowed'
5385 '406':
5386 $ref: '#/components/responses/NotAcceptable'
5387 '409':
5388 $ref: '#/components/responses/Conflict'
5389 '422':
5390 $ref: '#/components/responses/UnprocessableEntity'
5391 '500':
5392 $ref: '#/components/responses/InternalServerError'
5393 '503':
5394 $ref: '#/components/responses/ServiceUnavailable'
5395 '5XX':
5396 $ref: '#/components/responses/UnexpectedError'
5397 default:
5398 $ref: '#/components/responses/UnexpectedError'
5399 patch:
5400 tags:
garciadeblas77849982020-02-28 15:41:43 +01005401 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005402 - "Admin"
5403 summary: Modify a VIM
5404 description: Modify a VIM
5405 operationId: editVIM
5406 requestBody:
5407 $ref: '#/components/requestBodies/EditVimRequest'
5408 responses:
5409 '202':
5410 description: Accepted
5411 content:
5412 application/json:
5413 schema:
5414 $ref: '#/components/schemas/OpId'
5415 application/yaml:
5416 schema:
5417 $ref: '#/components/schemas/OpId'
5418 '400':
5419 $ref: '#/components/responses/BadRequest'
5420 '401':
5421 $ref: '#/components/responses/Unauthorized'
5422 '403':
5423 $ref: '#/components/responses/Forbidden'
5424 '404':
5425 $ref: '#/components/responses/NotFound'
5426 '405':
5427 $ref: '#/components/responses/MethodNotAllowed'
5428 '406':
5429 $ref: '#/components/responses/NotAcceptable'
5430 '409':
5431 $ref: '#/components/responses/Conflict'
5432 '422':
5433 $ref: '#/components/responses/UnprocessableEntity'
5434 '500':
5435 $ref: '#/components/responses/InternalServerError'
5436 '503':
5437 $ref: '#/components/responses/ServiceUnavailable'
5438 '5XX':
5439 $ref: '#/components/responses/UnexpectedError'
5440 default:
5441 $ref: '#/components/responses/UnexpectedError'
5442 delete:
5443 tags:
garciadeblas77849982020-02-28 15:41:43 +01005444 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005445 - "Admin"
5446 summary: Delete a VIM
5447 description: Delete a VIM
5448 operationId: deleteVIM
5449 responses:
5450 '202':
5451 description: Accepted
5452 '400':
5453 $ref: '#/components/responses/BadRequest'
5454 '401':
5455 $ref: '#/components/responses/Unauthorized'
5456 '403':
5457 $ref: '#/components/responses/Forbidden'
5458 '404':
5459 $ref: '#/components/responses/NotFound'
5460 '405':
5461 $ref: '#/components/responses/MethodNotAllowed'
5462 '406':
5463 $ref: '#/components/responses/NotAcceptable'
5464 '409':
5465 $ref: '#/components/responses/Conflict'
5466 '422':
5467 $ref: '#/components/responses/UnprocessableEntity'
5468 '500':
5469 $ref: '#/components/responses/InternalServerError'
5470 '503':
5471 $ref: '#/components/responses/ServiceUnavailable'
5472 '5XX':
5473 $ref: '#/components/responses/UnexpectedError'
5474 default:
5475 $ref: '#/components/responses/UnexpectedError'
5476 '/admin/v1/vim_accounts':
5477 get:
5478 tags:
garciadeblas77849982020-02-28 15:41:43 +01005479 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005480 - "Admin"
5481 summary: Query information about multiple VIM Accounts
5482 description: Query information about multiple VIM Accounts
5483 operationId: getVimAccounts
5484 responses:
5485 '200':
5486 description: OK
5487 content:
5488 application/json:
5489 schema:
5490 $ref: '#/components/schemas/ArrayOfVimInfo'
5491 application/yaml:
5492 schema:
5493 $ref: '#/components/schemas/ArrayOfVimInfo'
5494 '400':
5495 $ref: '#/components/responses/BadRequest'
5496 '401':
5497 $ref: '#/components/responses/Unauthorized'
5498 '403':
5499 $ref: '#/components/responses/Forbidden'
5500 '404':
5501 $ref: '#/components/responses/NotFound'
5502 '405':
5503 $ref: '#/components/responses/MethodNotAllowed'
5504 '406':
5505 $ref: '#/components/responses/NotAcceptable'
5506 '409':
5507 $ref: '#/components/responses/Conflict'
5508 '422':
5509 $ref: '#/components/responses/UnprocessableEntity'
5510 '500':
5511 $ref: '#/components/responses/InternalServerError'
5512 '503':
5513 $ref: '#/components/responses/ServiceUnavailable'
5514 '5XX':
5515 $ref: '#/components/responses/UnexpectedError'
5516 default:
5517 $ref: '#/components/responses/UnexpectedError'
5518 post:
5519 tags:
garciadeblas77849982020-02-28 15:41:43 +01005520 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005521 - "Admin"
5522 summary: Create a new VIM Account
5523 description: Create a new VIM Account
5524 operationId: createVimAccount
5525 requestBody:
5526 $ref: '#/components/requestBodies/CreateVimRequest'
5527 responses:
5528 '202':
5529 description: Accepted
5530 content:
5531 application/json:
5532 schema:
5533 $ref: '#/components/schemas/ObjectId_plus_OpId'
5534 application/yaml:
5535 schema:
5536 $ref: '#/components/schemas/ObjectId_plus_OpId'
5537 '400':
5538 $ref: '#/components/responses/BadRequest'
5539 '401':
5540 $ref: '#/components/responses/Unauthorized'
5541 '403':
5542 $ref: '#/components/responses/Forbidden'
5543 '404':
5544 $ref: '#/components/responses/NotFound'
5545 '405':
5546 $ref: '#/components/responses/MethodNotAllowed'
5547 '406':
5548 $ref: '#/components/responses/NotAcceptable'
5549 '409':
5550 $ref: '#/components/responses/Conflict'
5551 '422':
5552 $ref: '#/components/responses/UnprocessableEntity'
5553 '500':
5554 $ref: '#/components/responses/InternalServerError'
5555 '503':
5556 $ref: '#/components/responses/ServiceUnavailable'
5557 '5XX':
5558 $ref: '#/components/responses/UnexpectedError'
5559 default:
5560 $ref: '#/components/responses/UnexpectedError'
5561 '/admin/v1/vim_accounts/{vimAccountId}':
5562 parameters:
5563 - name: vimAccountId
5564 in: path
5565 required: true
5566 description: VIM Account ID
5567 schema:
5568 type: string
5569 format: uuid
5570 get:
5571 tags:
garciadeblas77849982020-02-28 15:41:43 +01005572 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005573 - "Admin"
5574 summary: Query information about an individual VIM Account
5575 description: Query information about an individual VIM Account
5576 operationId: getVimAccount
5577 responses:
5578 '200':
5579 description: OK
5580 content:
5581 application/json:
5582 schema:
5583 $ref: '#/components/schemas/VimInfo'
5584 application/yaml:
5585 schema:
5586 $ref: '#/components/schemas/VimInfo'
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 patch:
5612 tags:
garciadeblas77849982020-02-28 15:41:43 +01005613 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005614 - "Admin"
5615 summary: Modify a VIM Account
5616 description: Modify a VIM Account
5617 operationId: editVimAccount
5618 requestBody:
5619 $ref: '#/components/requestBodies/EditVimRequest'
5620 responses:
5621 '202':
5622 description: Accepted
5623 content:
5624 application/json:
5625 schema:
5626 $ref: '#/components/schemas/OpId'
5627 application/yaml:
5628 schema:
5629 $ref: '#/components/schemas/OpId'
5630 '400':
5631 $ref: '#/components/responses/BadRequest'
5632 '401':
5633 $ref: '#/components/responses/Unauthorized'
5634 '403':
5635 $ref: '#/components/responses/Forbidden'
5636 '404':
5637 $ref: '#/components/responses/NotFound'
5638 '405':
5639 $ref: '#/components/responses/MethodNotAllowed'
5640 '406':
5641 $ref: '#/components/responses/NotAcceptable'
5642 '409':
5643 $ref: '#/components/responses/Conflict'
5644 '422':
5645 $ref: '#/components/responses/UnprocessableEntity'
5646 '500':
5647 $ref: '#/components/responses/InternalServerError'
5648 '503':
5649 $ref: '#/components/responses/ServiceUnavailable'
5650 '5XX':
5651 $ref: '#/components/responses/UnexpectedError'
5652 default:
5653 $ref: '#/components/responses/UnexpectedError'
5654 delete:
5655 tags:
garciadeblas77849982020-02-28 15:41:43 +01005656 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005657 - "Admin"
5658 summary: Delete a VIM Account
5659 description: Delete a VIM Account
5660 operationId: deleteVimAccount
5661 responses:
5662 '202':
5663 description: Accepted
5664 '400':
5665 $ref: '#/components/responses/BadRequest'
5666 '401':
5667 $ref: '#/components/responses/Unauthorized'
5668 '403':
5669 $ref: '#/components/responses/Forbidden'
5670 '404':
5671 $ref: '#/components/responses/NotFound'
5672 '405':
5673 $ref: '#/components/responses/MethodNotAllowed'
5674 '406':
5675 $ref: '#/components/responses/NotAcceptable'
5676 '409':
5677 $ref: '#/components/responses/Conflict'
5678 '422':
5679 $ref: '#/components/responses/UnprocessableEntity'
5680 '500':
5681 $ref: '#/components/responses/InternalServerError'
5682 '503':
5683 $ref: '#/components/responses/ServiceUnavailable'
5684 '5XX':
5685 $ref: '#/components/responses/UnexpectedError'
5686 default:
5687 $ref: '#/components/responses/UnexpectedError'
5688 '/admin/v1/wim_accounts':
5689 get:
5690 tags:
garciadeblas77849982020-02-28 15:41:43 +01005691 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005692 - "Admin"
5693 summary: Query information about multiple WIM Accounts
5694 description: Query information about multiple WIM Accounts
5695 operationId: getWimAccounts
5696 responses:
5697 '200':
5698 description: OK
5699 content:
5700 application/json:
5701 schema:
5702 $ref: '#/components/schemas/ArrayOfWimInfo'
5703 application/yaml:
5704 schema:
5705 $ref: '#/components/schemas/ArrayOfWimInfo'
5706 '400':
5707 $ref: '#/components/responses/BadRequest'
5708 '401':
5709 $ref: '#/components/responses/Unauthorized'
5710 '403':
5711 $ref: '#/components/responses/Forbidden'
5712 '404':
5713 $ref: '#/components/responses/NotFound'
5714 '405':
5715 $ref: '#/components/responses/MethodNotAllowed'
5716 '406':
5717 $ref: '#/components/responses/NotAcceptable'
5718 '409':
5719 $ref: '#/components/responses/Conflict'
5720 '422':
5721 $ref: '#/components/responses/UnprocessableEntity'
5722 '500':
5723 $ref: '#/components/responses/InternalServerError'
5724 '503':
5725 $ref: '#/components/responses/ServiceUnavailable'
5726 '5XX':
5727 $ref: '#/components/responses/UnexpectedError'
5728 default:
5729 $ref: '#/components/responses/UnexpectedError'
5730 post:
5731 tags:
garciadeblas77849982020-02-28 15:41:43 +01005732 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005733 - "Admin"
5734 summary: Create a new WIM Account
5735 description: Create a new WIM Account
5736 operationId: createWimAccount
5737 requestBody:
5738 $ref: '#/components/requestBodies/CreateWimRequest'
5739 responses:
5740 '202':
5741 description: Accepted
5742 content:
5743 application/json:
5744 schema:
5745 $ref: '#/components/schemas/ObjectId_plus_OpId'
5746 application/yaml:
5747 schema:
5748 $ref: '#/components/schemas/ObjectId_plus_OpId'
5749 '400':
5750 $ref: '#/components/responses/BadRequest'
5751 '401':
5752 $ref: '#/components/responses/Unauthorized'
5753 '403':
5754 $ref: '#/components/responses/Forbidden'
5755 '404':
5756 $ref: '#/components/responses/NotFound'
5757 '405':
5758 $ref: '#/components/responses/MethodNotAllowed'
5759 '406':
5760 $ref: '#/components/responses/NotAcceptable'
5761 '409':
5762 $ref: '#/components/responses/Conflict'
5763 '422':
5764 $ref: '#/components/responses/UnprocessableEntity'
5765 '500':
5766 $ref: '#/components/responses/InternalServerError'
5767 '503':
5768 $ref: '#/components/responses/ServiceUnavailable'
5769 '5XX':
5770 $ref: '#/components/responses/UnexpectedError'
5771 default:
5772 $ref: '#/components/responses/UnexpectedError'
5773 '/admin/v1/wim_accounts/{wimAccountId}':
5774 parameters:
5775 - name: wimAccountId
5776 in: path
5777 required: true
5778 description: WIM Account ID
5779 schema:
5780 type: string
5781 format: uuid
5782 get:
5783 tags:
garciadeblas77849982020-02-28 15:41:43 +01005784 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005785 - "Admin"
5786 summary: Query information about an individual WIM Account
5787 description: Query information about an individual WIM Account
5788 operationId: getWimAccount
5789 responses:
5790 '200':
5791 description: OK
5792 content:
5793 application/json:
5794 schema:
5795 $ref: '#/components/schemas/WimInfo'
5796 application/yaml:
5797 schema:
5798 $ref: '#/components/schemas/WimInfo'
5799 '400':
5800 $ref: '#/components/responses/BadRequest'
5801 '401':
5802 $ref: '#/components/responses/Unauthorized'
5803 '403':
5804 $ref: '#/components/responses/Forbidden'
5805 '404':
5806 $ref: '#/components/responses/NotFound'
5807 '405':
5808 $ref: '#/components/responses/MethodNotAllowed'
5809 '406':
5810 $ref: '#/components/responses/NotAcceptable'
5811 '409':
5812 $ref: '#/components/responses/Conflict'
5813 '422':
5814 $ref: '#/components/responses/UnprocessableEntity'
5815 '500':
5816 $ref: '#/components/responses/InternalServerError'
5817 '503':
5818 $ref: '#/components/responses/ServiceUnavailable'
5819 '5XX':
5820 $ref: '#/components/responses/UnexpectedError'
5821 default:
5822 $ref: '#/components/responses/UnexpectedError'
5823 patch:
5824 tags:
garciadeblas77849982020-02-28 15:41:43 +01005825 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005826 - "Admin"
5827 summary: Modify a WIM Account
5828 description: Modify a WIM Account
5829 operationId: editWimAccount
5830 requestBody:
5831 $ref: '#/components/requestBodies/EditWimRequest'
5832 responses:
5833 '202':
5834 description: Accepted
5835 content:
5836 application/json:
5837 schema:
5838 $ref: '#/components/schemas/OpId'
5839 application/yaml:
5840 schema:
5841 $ref: '#/components/schemas/OpId'
5842 '400':
5843 $ref: '#/components/responses/BadRequest'
5844 '401':
5845 $ref: '#/components/responses/Unauthorized'
5846 '403':
5847 $ref: '#/components/responses/Forbidden'
5848 '404':
5849 $ref: '#/components/responses/NotFound'
5850 '405':
5851 $ref: '#/components/responses/MethodNotAllowed'
5852 '406':
5853 $ref: '#/components/responses/NotAcceptable'
5854 '409':
5855 $ref: '#/components/responses/Conflict'
5856 '422':
5857 $ref: '#/components/responses/UnprocessableEntity'
5858 '500':
5859 $ref: '#/components/responses/InternalServerError'
5860 '503':
5861 $ref: '#/components/responses/ServiceUnavailable'
5862 '5XX':
5863 $ref: '#/components/responses/UnexpectedError'
5864 default:
5865 $ref: '#/components/responses/UnexpectedError'
5866 delete:
5867 tags:
garciadeblas77849982020-02-28 15:41:43 +01005868 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005869 - "Admin"
5870 summary: Delete a WIM Account
5871 description: Delete a WIM Account
5872 operationId: deleteWimAccount
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 '/admin/v1/sdns':
5901 get:
5902 tags:
garciadeblas77849982020-02-28 15:41:43 +01005903 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005904 - "Admin"
5905 summary: Query information about multiple SDNs
5906 description: Query information about multiple SDNs
5907 operationId: getSDNs
5908 responses:
5909 '200':
5910 description: OK
5911 content:
5912 application/json:
5913 schema:
5914 $ref: '#/components/schemas/ArrayOfSdnInfo'
5915 application/yaml:
5916 schema:
5917 $ref: '#/components/schemas/ArrayOfSdnInfo'
5918 '400':
5919 $ref: '#/components/responses/BadRequest'
5920 '401':
5921 $ref: '#/components/responses/Unauthorized'
5922 '403':
5923 $ref: '#/components/responses/Forbidden'
5924 '404':
5925 $ref: '#/components/responses/NotFound'
5926 '405':
5927 $ref: '#/components/responses/MethodNotAllowed'
5928 '406':
5929 $ref: '#/components/responses/NotAcceptable'
5930 '409':
5931 $ref: '#/components/responses/Conflict'
5932 '422':
5933 $ref: '#/components/responses/UnprocessableEntity'
5934 '500':
5935 $ref: '#/components/responses/InternalServerError'
5936 '503':
5937 $ref: '#/components/responses/ServiceUnavailable'
5938 '5XX':
5939 $ref: '#/components/responses/UnexpectedError'
5940 default:
5941 $ref: '#/components/responses/UnexpectedError'
5942 post:
5943 tags:
garciadeblas77849982020-02-28 15:41:43 +01005944 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005945 - "Admin"
5946 summary: Create a new SDN
5947 description: Create a new SDN
5948 operationId: createSDN
5949 requestBody:
5950 $ref: '#/components/requestBodies/CreateSdnRequest'
5951 responses:
5952 '202':
5953 description: Accepted
5954 content:
5955 application/json:
5956 schema:
5957 $ref: '#/components/schemas/ObjectId_plus_OpId'
5958 application/yaml:
5959 schema:
5960 $ref: '#/components/schemas/ObjectId_plus_OpId'
5961 '400':
5962 $ref: '#/components/responses/BadRequest'
5963 '401':
5964 $ref: '#/components/responses/Unauthorized'
5965 '403':
5966 $ref: '#/components/responses/Forbidden'
5967 '404':
5968 $ref: '#/components/responses/NotFound'
5969 '405':
5970 $ref: '#/components/responses/MethodNotAllowed'
5971 '406':
5972 $ref: '#/components/responses/NotAcceptable'
5973 '409':
5974 $ref: '#/components/responses/Conflict'
5975 '422':
5976 $ref: '#/components/responses/UnprocessableEntity'
5977 '500':
5978 $ref: '#/components/responses/InternalServerError'
5979 '503':
5980 $ref: '#/components/responses/ServiceUnavailable'
5981 '5XX':
5982 $ref: '#/components/responses/UnexpectedError'
5983 default:
5984 $ref: '#/components/responses/UnexpectedError'
5985 '/admin/v1/sdns/{sdnId}':
5986 parameters:
5987 - name: sdnId
5988 in: path
5989 required: true
5990 description: SDN ID
5991 schema:
5992 type: string
5993 format: uuid
5994 get:
5995 tags:
garciadeblas77849982020-02-28 15:41:43 +01005996 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005997 - "Admin"
5998 summary: Query information about an individual SDN
5999 description: Query information about an individual SDN
6000 operationId: getSDN
6001 responses:
6002 '200':
6003 description: OK
6004 content:
6005 application/json:
6006 schema:
6007 $ref: '#/components/schemas/SdnInfo'
6008 application/yaml:
6009 schema:
6010 $ref: '#/components/schemas/SdnInfo'
6011 '400':
6012 $ref: '#/components/responses/BadRequest'
6013 '401':
6014 $ref: '#/components/responses/Unauthorized'
6015 '403':
6016 $ref: '#/components/responses/Forbidden'
6017 '404':
6018 $ref: '#/components/responses/NotFound'
6019 '405':
6020 $ref: '#/components/responses/MethodNotAllowed'
6021 '406':
6022 $ref: '#/components/responses/NotAcceptable'
6023 '409':
6024 $ref: '#/components/responses/Conflict'
6025 '422':
6026 $ref: '#/components/responses/UnprocessableEntity'
6027 '500':
6028 $ref: '#/components/responses/InternalServerError'
6029 '503':
6030 $ref: '#/components/responses/ServiceUnavailable'
6031 '5XX':
6032 $ref: '#/components/responses/UnexpectedError'
6033 default:
6034 $ref: '#/components/responses/UnexpectedError'
6035 patch:
6036 tags:
garciadeblas77849982020-02-28 15:41:43 +01006037 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006038 - "Admin"
6039 summary: Modify a SDN
6040 description: Modify a SDN
6041 operationId: editSDN
6042 requestBody:
6043 $ref: '#/components/requestBodies/EditSdnRequest'
6044 responses:
6045 '202':
6046 description: Accepted
6047 content:
6048 application/json:
6049 schema:
6050 $ref: '#/components/schemas/OpId'
6051 application/yaml:
6052 schema:
6053 $ref: '#/components/schemas/OpId'
6054 '400':
6055 $ref: '#/components/responses/BadRequest'
6056 '401':
6057 $ref: '#/components/responses/Unauthorized'
6058 '403':
6059 $ref: '#/components/responses/Forbidden'
6060 '404':
6061 $ref: '#/components/responses/NotFound'
6062 '405':
6063 $ref: '#/components/responses/MethodNotAllowed'
6064 '406':
6065 $ref: '#/components/responses/NotAcceptable'
6066 '409':
6067 $ref: '#/components/responses/Conflict'
6068 '422':
6069 $ref: '#/components/responses/UnprocessableEntity'
6070 '500':
6071 $ref: '#/components/responses/InternalServerError'
6072 '503':
6073 $ref: '#/components/responses/ServiceUnavailable'
6074 '5XX':
6075 $ref: '#/components/responses/UnexpectedError'
6076 default:
6077 $ref: '#/components/responses/UnexpectedError'
6078 delete:
6079 tags:
garciadeblas77849982020-02-28 15:41:43 +01006080 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006081 - "Admin"
6082 summary: Delete a SDN
6083 description: Delete a SDN
6084 operationId: deleteSDN
6085 responses:
6086 '202':
6087 description: Accepted
6088 '400':
6089 $ref: '#/components/responses/BadRequest'
6090 '401':
6091 $ref: '#/components/responses/Unauthorized'
6092 '403':
6093 $ref: '#/components/responses/Forbidden'
6094 '404':
6095 $ref: '#/components/responses/NotFound'
6096 '405':
6097 $ref: '#/components/responses/MethodNotAllowed'
6098 '406':
6099 $ref: '#/components/responses/NotAcceptable'
6100 '409':
6101 $ref: '#/components/responses/Conflict'
6102 '422':
6103 $ref: '#/components/responses/UnprocessableEntity'
6104 '500':
6105 $ref: '#/components/responses/InternalServerError'
6106 '503':
6107 $ref: '#/components/responses/ServiceUnavailable'
6108 '5XX':
6109 $ref: '#/components/responses/UnexpectedError'
6110 default:
6111 $ref: '#/components/responses/UnexpectedError'
6112 '/admin/v1/k8sclusters':
6113 get:
6114 tags:
garciadeblas77849982020-02-28 15:41:43 +01006115 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006116 - "Admin"
6117 summary: Query information about multiple K8s Clusters
6118 description: Query information about multiple K8s Clusters
6119 operationId: getK8sClusters
6120 responses:
6121 '200':
6122 description: OK
6123 content:
6124 application/json:
6125 schema:
6126 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
6127 application/yaml:
6128 schema:
6129 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
6130 '400':
6131 $ref: '#/components/responses/BadRequest'
6132 '401':
6133 $ref: '#/components/responses/Unauthorized'
6134 '403':
6135 $ref: '#/components/responses/Forbidden'
6136 '404':
6137 $ref: '#/components/responses/NotFound'
6138 '405':
6139 $ref: '#/components/responses/MethodNotAllowed'
6140 '406':
6141 $ref: '#/components/responses/NotAcceptable'
6142 '409':
6143 $ref: '#/components/responses/Conflict'
6144 '422':
6145 $ref: '#/components/responses/UnprocessableEntity'
6146 '500':
6147 $ref: '#/components/responses/InternalServerError'
6148 '503':
6149 $ref: '#/components/responses/ServiceUnavailable'
6150 '5XX':
6151 $ref: '#/components/responses/UnexpectedError'
6152 default:
6153 $ref: '#/components/responses/UnexpectedError'
6154 post:
6155 tags:
garciadeblas77849982020-02-28 15:41:43 +01006156 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006157 - "Admin"
6158 summary: Create a new K8s Cluster
6159 description: Create a new K8s Cluster
6160 operationId: createK8sCluster
6161 requestBody:
6162 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
6163 responses:
6164 '202':
6165 description: Accepted
6166 content:
6167 application/json:
6168 schema:
6169 $ref: '#/components/schemas/ObjectId_plus_OpId'
6170 application/yaml:
6171 schema:
6172 $ref: '#/components/schemas/ObjectId_plus_OpId'
6173 '400':
6174 $ref: '#/components/responses/BadRequest'
6175 '401':
6176 $ref: '#/components/responses/Unauthorized'
6177 '403':
6178 $ref: '#/components/responses/Forbidden'
6179 '404':
6180 $ref: '#/components/responses/NotFound'
6181 '405':
6182 $ref: '#/components/responses/MethodNotAllowed'
6183 '406':
6184 $ref: '#/components/responses/NotAcceptable'
6185 '409':
6186 $ref: '#/components/responses/Conflict'
6187 '422':
6188 $ref: '#/components/responses/UnprocessableEntity'
6189 '500':
6190 $ref: '#/components/responses/InternalServerError'
6191 '503':
6192 $ref: '#/components/responses/ServiceUnavailable'
6193 '5XX':
6194 $ref: '#/components/responses/UnexpectedError'
6195 default:
6196 $ref: '#/components/responses/UnexpectedError'
6197 '/admin/v1/k8sclusters/{k8sClusterId}':
6198 parameters:
6199 - name: k8sClusterId
6200 in: path
6201 required: true
6202 description: K8s Cluster ID
6203 schema:
6204 type: string
6205 format: uuid
6206 get:
6207 tags:
garciadeblas77849982020-02-28 15:41:43 +01006208 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006209 - "Admin"
6210 summary: Query information about an individual K8s Cluster
6211 description: Query information about an individual K8s Cluster
6212 operationId: getK8sCluster
6213 responses:
6214 '200':
6215 description: OK
6216 content:
6217 application/json:
6218 schema:
6219 $ref: '#/components/schemas/K8sClusterInfo'
6220 application/yaml:
6221 schema:
6222 $ref: '#/components/schemas/K8sClusterInfo'
6223 '400':
6224 $ref: '#/components/responses/BadRequest'
6225 '401':
6226 $ref: '#/components/responses/Unauthorized'
6227 '403':
6228 $ref: '#/components/responses/Forbidden'
6229 '404':
6230 $ref: '#/components/responses/NotFound'
6231 '405':
6232 $ref: '#/components/responses/MethodNotAllowed'
6233 '406':
6234 $ref: '#/components/responses/NotAcceptable'
6235 '409':
6236 $ref: '#/components/responses/Conflict'
6237 '422':
6238 $ref: '#/components/responses/UnprocessableEntity'
6239 '500':
6240 $ref: '#/components/responses/InternalServerError'
6241 '503':
6242 $ref: '#/components/responses/ServiceUnavailable'
6243 '5XX':
6244 $ref: '#/components/responses/UnexpectedError'
6245 default:
6246 $ref: '#/components/responses/UnexpectedError'
6247 patch:
6248 tags:
garciadeblas77849982020-02-28 15:41:43 +01006249 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006250 - "Admin"
6251 summary: Modify a K8s Cluster
6252 description: Modify a K8s Cluster
6253 operationId: editK8sCluster
6254 requestBody:
6255 $ref: '#/components/requestBodies/EditK8sClusterRequest'
6256 responses:
6257 '202':
6258 description: Accepted
6259 content:
6260 application/json:
6261 schema:
6262 $ref: '#/components/schemas/OpId'
6263 application/yaml:
6264 schema:
6265 $ref: '#/components/schemas/OpId'
6266 '400':
6267 $ref: '#/components/responses/BadRequest'
6268 '401':
6269 $ref: '#/components/responses/Unauthorized'
6270 '403':
6271 $ref: '#/components/responses/Forbidden'
6272 '404':
6273 $ref: '#/components/responses/NotFound'
6274 '405':
6275 $ref: '#/components/responses/MethodNotAllowed'
6276 '406':
6277 $ref: '#/components/responses/NotAcceptable'
6278 '409':
6279 $ref: '#/components/responses/Conflict'
6280 '422':
6281 $ref: '#/components/responses/UnprocessableEntity'
6282 '500':
6283 $ref: '#/components/responses/InternalServerError'
6284 '503':
6285 $ref: '#/components/responses/ServiceUnavailable'
6286 '5XX':
6287 $ref: '#/components/responses/UnexpectedError'
6288 default:
6289 $ref: '#/components/responses/UnexpectedError'
6290 delete:
6291 tags:
garciadeblas77849982020-02-28 15:41:43 +01006292 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006293 - "Admin"
6294 summary: Delete a K8s Cluster
6295 description: Delete a K8s Cluster
6296 operationId: deleteK8sCluster
6297 responses:
6298 '202':
6299 description: Accepted
6300 '400':
6301 $ref: '#/components/responses/BadRequest'
6302 '401':
6303 $ref: '#/components/responses/Unauthorized'
6304 '403':
6305 $ref: '#/components/responses/Forbidden'
6306 '404':
6307 $ref: '#/components/responses/NotFound'
6308 '405':
6309 $ref: '#/components/responses/MethodNotAllowed'
6310 '406':
6311 $ref: '#/components/responses/NotAcceptable'
6312 '409':
6313 $ref: '#/components/responses/Conflict'
6314 '422':
6315 $ref: '#/components/responses/UnprocessableEntity'
6316 '500':
6317 $ref: '#/components/responses/InternalServerError'
6318 '503':
6319 $ref: '#/components/responses/ServiceUnavailable'
6320 '5XX':
6321 $ref: '#/components/responses/UnexpectedError'
6322 default:
6323 $ref: '#/components/responses/UnexpectedError'
David Garciaaf38fce2021-05-04 12:48:04 +02006324 '/admin/v1/vca':
6325 get:
6326 tags:
6327 - "Infrastructure"
6328 - "Admin"
6329 summary: Query information about multiple VCAs
6330 description: Query information about multiple VCAs
6331 operationId: getVcas
6332 responses:
6333 '200':
6334 description: OK
6335 content:
6336 application/json:
6337 schema:
6338 $ref: '#/components/schemas/ArrayOfVcaInfo'
6339 application/yaml:
6340 schema:
6341 $ref: '#/components/schemas/ArrayOfVcaInfo'
6342 '400':
6343 $ref: '#/components/responses/BadRequest'
6344 '401':
6345 $ref: '#/components/responses/Unauthorized'
6346 '403':
6347 $ref: '#/components/responses/Forbidden'
6348 '404':
6349 $ref: '#/components/responses/NotFound'
6350 '405':
6351 $ref: '#/components/responses/MethodNotAllowed'
6352 '406':
6353 $ref: '#/components/responses/NotAcceptable'
6354 '409':
6355 $ref: '#/components/responses/Conflict'
6356 '422':
6357 $ref: '#/components/responses/UnprocessableEntity'
6358 '500':
6359 $ref: '#/components/responses/InternalServerError'
6360 '503':
6361 $ref: '#/components/responses/ServiceUnavailable'
6362 '5XX':
6363 $ref: '#/components/responses/UnexpectedError'
6364 default:
6365 $ref: '#/components/responses/UnexpectedError'
6366 post:
6367 tags:
6368 - "Infrastructure"
6369 - "Admin"
6370 summary: Create a new VCA
6371 description: Create a new VCA
6372 operationId: createVca
6373 requestBody:
6374 $ref: '#/components/requestBodies/CreateVcaRequest'
6375 responses:
6376 '202':
6377 description: Accepted
6378 content:
6379 application/json:
6380 schema:
6381 $ref: '#/components/schemas/ObjectId_plus_OpId'
6382 application/yaml:
6383 schema:
6384 $ref: '#/components/schemas/ObjectId_plus_OpId'
6385 '400':
6386 $ref: '#/components/responses/BadRequest'
6387 '401':
6388 $ref: '#/components/responses/Unauthorized'
6389 '403':
6390 $ref: '#/components/responses/Forbidden'
6391 '404':
6392 $ref: '#/components/responses/NotFound'
6393 '405':
6394 $ref: '#/components/responses/MethodNotAllowed'
6395 '406':
6396 $ref: '#/components/responses/NotAcceptable'
6397 '409':
6398 $ref: '#/components/responses/Conflict'
6399 '422':
6400 $ref: '#/components/responses/UnprocessableEntity'
6401 '500':
6402 $ref: '#/components/responses/InternalServerError'
6403 '503':
6404 $ref: '#/components/responses/ServiceUnavailable'
6405 '5XX':
6406 $ref: '#/components/responses/UnexpectedError'
6407 default:
6408 $ref: '#/components/responses/UnexpectedError'
6409 '/admin/v1/vca/{vcaId}':
6410 parameters:
6411 - name: vcaId
6412 in: path
6413 required: true
6414 description: VCA ID
6415 schema:
6416 type: string
6417 format: uuid
6418 get:
6419 tags:
6420 - "Infrastructure"
6421 - "Admin"
6422 summary: Query information about an individual VCA
6423 description: Query information about an individual VCA
6424 operationId: getVca
6425 responses:
6426 '200':
6427 description: OK
6428 content:
6429 application/json:
6430 schema:
6431 $ref: '#/components/schemas/VcaInfo'
6432 application/yaml:
6433 schema:
6434 $ref: '#/components/schemas/VcaInfo'
6435 '400':
6436 $ref: '#/components/responses/BadRequest'
6437 '401':
6438 $ref: '#/components/responses/Unauthorized'
6439 '403':
6440 $ref: '#/components/responses/Forbidden'
6441 '404':
6442 $ref: '#/components/responses/NotFound'
6443 '405':
6444 $ref: '#/components/responses/MethodNotAllowed'
6445 '406':
6446 $ref: '#/components/responses/NotAcceptable'
6447 '409':
6448 $ref: '#/components/responses/Conflict'
6449 '422':
6450 $ref: '#/components/responses/UnprocessableEntity'
6451 '500':
6452 $ref: '#/components/responses/InternalServerError'
6453 '503':
6454 $ref: '#/components/responses/ServiceUnavailable'
6455 '5XX':
6456 $ref: '#/components/responses/UnexpectedError'
6457 default:
6458 $ref: '#/components/responses/UnexpectedError'
6459 patch:
6460 tags:
6461 - "Infrastructure"
6462 - "Admin"
6463 summary: Modify a VCA
6464 description: Modify a VCA
6465 operationId: editVca
6466 requestBody:
6467 $ref: '#/components/requestBodies/EditVcaRequest'
6468 responses:
6469 '202':
6470 description: Accepted
6471 content:
6472 application/json:
6473 schema:
6474 $ref: '#/components/schemas/OpId'
6475 application/yaml:
6476 schema:
6477 $ref: '#/components/schemas/OpId'
6478 '400':
6479 $ref: '#/components/responses/BadRequest'
6480 '401':
6481 $ref: '#/components/responses/Unauthorized'
6482 '403':
6483 $ref: '#/components/responses/Forbidden'
6484 '404':
6485 $ref: '#/components/responses/NotFound'
6486 '405':
6487 $ref: '#/components/responses/MethodNotAllowed'
6488 '406':
6489 $ref: '#/components/responses/NotAcceptable'
6490 '409':
6491 $ref: '#/components/responses/Conflict'
6492 '422':
6493 $ref: '#/components/responses/UnprocessableEntity'
6494 '500':
6495 $ref: '#/components/responses/InternalServerError'
6496 '503':
6497 $ref: '#/components/responses/ServiceUnavailable'
6498 '5XX':
6499 $ref: '#/components/responses/UnexpectedError'
6500 default:
6501 $ref: '#/components/responses/UnexpectedError'
6502 delete:
6503 tags:
6504 - "Infrastructure"
6505 - "Admin"
6506 summary: Delete a VCA
6507 description: Delete a VCA
6508 operationId: deleteVca
6509 responses:
6510 '202':
6511 description: Accepted
6512 '400':
6513 $ref: '#/components/responses/BadRequest'
6514 '401':
6515 $ref: '#/components/responses/Unauthorized'
6516 '403':
6517 $ref: '#/components/responses/Forbidden'
6518 '404':
6519 $ref: '#/components/responses/NotFound'
6520 '405':
6521 $ref: '#/components/responses/MethodNotAllowed'
6522 '406':
6523 $ref: '#/components/responses/NotAcceptable'
6524 '409':
6525 $ref: '#/components/responses/Conflict'
6526 '422':
6527 $ref: '#/components/responses/UnprocessableEntity'
6528 '500':
6529 $ref: '#/components/responses/InternalServerError'
6530 '503':
6531 $ref: '#/components/responses/ServiceUnavailable'
6532 '5XX':
6533 $ref: '#/components/responses/UnexpectedError'
6534 default:
6535 $ref: '#/components/responses/UnexpectedError'
delacruzramaf79f3c2019-10-22 13:13:01 +02006536 '/admin/v1/k8srepos':
6537 get:
6538 tags:
garciadeblas77849982020-02-28 15:41:43 +01006539 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006540 - "Admin"
6541 summary: Query information about multiple K8s Repos
6542 description: Query information about multiple K8s Repos
6543 operationId: getK8sRepos
6544 responses:
6545 '200':
6546 description: OK
6547 content:
6548 application/json:
6549 schema:
6550 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6551 application/yaml:
6552 schema:
6553 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6554 '400':
6555 $ref: '#/components/responses/BadRequest'
6556 '401':
6557 $ref: '#/components/responses/Unauthorized'
6558 '403':
6559 $ref: '#/components/responses/Forbidden'
6560 '404':
6561 $ref: '#/components/responses/NotFound'
6562 '405':
6563 $ref: '#/components/responses/MethodNotAllowed'
6564 '406':
6565 $ref: '#/components/responses/NotAcceptable'
6566 '409':
6567 $ref: '#/components/responses/Conflict'
6568 '422':
6569 $ref: '#/components/responses/UnprocessableEntity'
6570 '500':
6571 $ref: '#/components/responses/InternalServerError'
6572 '503':
6573 $ref: '#/components/responses/ServiceUnavailable'
6574 '5XX':
6575 $ref: '#/components/responses/UnexpectedError'
6576 default:
6577 $ref: '#/components/responses/UnexpectedError'
6578 post:
6579 tags:
garciadeblas77849982020-02-28 15:41:43 +01006580 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006581 - "Admin"
6582 summary: Create a new K8s Repo
6583 description: Create a new K8s Repo
6584 operationId: createK8sRepo
6585 requestBody:
6586 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6587 responses:
6588 '202':
6589 description: Accepted
6590 content:
6591 application/json:
6592 schema:
6593 $ref: '#/components/schemas/ObjectId_plus_OpId'
6594 application/yaml:
6595 schema:
6596 $ref: '#/components/schemas/ObjectId_plus_OpId'
6597 '400':
6598 $ref: '#/components/responses/BadRequest'
6599 '401':
6600 $ref: '#/components/responses/Unauthorized'
6601 '403':
6602 $ref: '#/components/responses/Forbidden'
6603 '404':
6604 $ref: '#/components/responses/NotFound'
6605 '405':
6606 $ref: '#/components/responses/MethodNotAllowed'
6607 '406':
6608 $ref: '#/components/responses/NotAcceptable'
6609 '409':
6610 $ref: '#/components/responses/Conflict'
6611 '422':
6612 $ref: '#/components/responses/UnprocessableEntity'
6613 '500':
6614 $ref: '#/components/responses/InternalServerError'
6615 '503':
6616 $ref: '#/components/responses/ServiceUnavailable'
6617 '5XX':
6618 $ref: '#/components/responses/UnexpectedError'
6619 default:
6620 $ref: '#/components/responses/UnexpectedError'
6621 '/admin/v1/k8srepos/{k8sRepoId}':
6622 parameters:
6623 - name: k8sRepoId
6624 in: path
6625 required: true
6626 description: K8s Repo ID
6627 schema:
6628 type: string
6629 format: uuid
6630 get:
6631 tags:
garciadeblas77849982020-02-28 15:41:43 +01006632 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006633 - "Admin"
6634 summary: Query information about an individual K8s Repo
6635 description: Query information about an individual K8s Repo
6636 operationId: getK8sRepo
6637 responses:
6638 '200':
6639 description: OK
6640 content:
6641 application/json:
6642 schema:
6643 $ref: '#/components/schemas/K8sRepoInfo'
6644 application/yaml:
6645 schema:
6646 $ref: '#/components/schemas/K8sRepoInfo'
6647 '400':
6648 $ref: '#/components/responses/BadRequest'
6649 '401':
6650 $ref: '#/components/responses/Unauthorized'
6651 '403':
6652 $ref: '#/components/responses/Forbidden'
6653 '404':
6654 $ref: '#/components/responses/NotFound'
6655 '405':
6656 $ref: '#/components/responses/MethodNotAllowed'
6657 '406':
6658 $ref: '#/components/responses/NotAcceptable'
6659 '409':
6660 $ref: '#/components/responses/Conflict'
6661 '422':
6662 $ref: '#/components/responses/UnprocessableEntity'
6663 '500':
6664 $ref: '#/components/responses/InternalServerError'
6665 '503':
6666 $ref: '#/components/responses/ServiceUnavailable'
6667 '5XX':
6668 $ref: '#/components/responses/UnexpectedError'
6669 default:
6670 $ref: '#/components/responses/UnexpectedError'
6671 delete:
6672 tags:
garciadeblas77849982020-02-28 15:41:43 +01006673 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006674 - "Admin"
6675 summary: Delete a K8s Repo
6676 description: Delete a K8s Repo
6677 operationId: deleteK8sRepo
6678 responses:
6679 '202':
6680 description: Accepted
6681 '400':
6682 $ref: '#/components/responses/BadRequest'
6683 '401':
6684 $ref: '#/components/responses/Unauthorized'
6685 '403':
6686 $ref: '#/components/responses/Forbidden'
6687 '404':
6688 $ref: '#/components/responses/NotFound'
6689 '405':
6690 $ref: '#/components/responses/MethodNotAllowed'
6691 '406':
6692 $ref: '#/components/responses/NotAcceptable'
6693 '409':
6694 $ref: '#/components/responses/Conflict'
6695 '422':
6696 $ref: '#/components/responses/UnprocessableEntity'
6697 '500':
6698 $ref: '#/components/responses/InternalServerError'
6699 '503':
6700 $ref: '#/components/responses/ServiceUnavailable'
6701 '5XX':
6702 $ref: '#/components/responses/UnexpectedError'
6703 default:
6704 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02006705# END Admin
6706
garciadeblas60e2ee92018-02-27 19:09:51 +01006707externalDocs:
delacruzramaf79f3c2019-10-22 13:13:01 +02006708 description: Find out more about OSM
garciadeblas00c2eb92020-02-28 15:24:27 +01006709 url: 'https://osm.etsi.org/docs/user-guide/'
delacruzramfb52ade2019-10-07 16:46:59 +02006710
garciadeblas60e2ee92018-02-27 19:09:51 +01006711components:
6712 responses:
6713 BadRequest:
6714 description: Bad request. The server cannot process the request due to a client error.
6715 content:
6716 application/json:
6717 schema:
6718 $ref: '#/components/schemas/ProblemDetails'
6719 Unauthorized:
6720 description: Authorization information is missing or invalid.
6721 content:
6722 application/json:
6723 schema:
6724 $ref: '#/components/schemas/ProblemDetails'
6725 Forbidden:
6726 description: Not enough permissions to do this operation.
6727 content:
6728 application/json:
6729 schema:
6730 $ref: '#/components/schemas/ProblemDetails'
6731 NotFound:
6732 description: The specified resource was not found.
6733 content:
6734 application/json:
6735 schema:
6736 $ref: '#/components/schemas/ProblemDetails'
6737 MethodNotAllowed:
6738 description: This method is not supported for the requested resource.
6739 content:
6740 application/json:
6741 schema:
6742 $ref: '#/components/schemas/ProblemDetails'
6743 NotAcceptable:
6744 description: The requested resource content cannot match the Accept headers sent in the request.
6745 content:
6746 application/json:
6747 schema:
6748 $ref: '#/components/schemas/ProblemDetails'
6749 Conflict:
6750 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6751 content:
6752 application/json:
6753 schema:
6754 $ref: '#/components/schemas/ProblemDetails'
6755 UnprocessableEntity:
6756 description: The request was well-formed but was unable to be followed due to semantic errors.
6757 content:
6758 application/json:
6759 schema:
6760 $ref: '#/components/schemas/ProblemDetails'
6761 InternalServerError:
6762 description: Internal server error.
6763 content:
6764 application/json:
6765 schema:
6766 $ref: '#/components/schemas/ProblemDetails'
6767 ServiceUnavailable:
6768 description: Service temporarily unavailable.
6769 content:
6770 application/json:
6771 schema:
6772 $ref: '#/components/schemas/ProblemDetails'
6773 UnexpectedError:
6774 description: Unexpected error.
6775 content:
6776 application/json:
6777 schema:
6778 $ref: '#/components/schemas/ProblemDetails'
delacruzramfb52ade2019-10-07 16:46:59 +02006779 VnfDescriptor:
6780 description: VNF Descriptor (plaintext)
6781 content:
6782 text/plain:
6783 schema:
6784 $ref: '#/components/schemas/VnfDescriptor'
6785 VnfPackage:
6786 description: VNF Package (compressed)
6787 content:
6788 application/zip:
6789 schema:
6790 $ref: '#/components/schemas/VnfPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +01006791 NsDescriptor:
delacruzramfb52ade2019-10-07 16:46:59 +02006792 description: NS Descriptor (plaintext)
6793 content:
6794 text/plain:
6795 schema:
6796 $ref: '#/components/schemas/NsDescriptor'
garciadeblas60e2ee92018-02-27 19:09:51 +01006797 NsPackage:
delacruzramfb52ade2019-10-07 16:46:59 +02006798 description: NS Package (compressed)
6799 content:
6800 application/zip:
6801 schema:
6802 $ref: '#/components/schemas/NsPackage'
6803 NetSliceTemplate:
6804 description: NetSlice Template (plaintext)
6805 content:
6806 text/plain:
6807 schema:
6808 $ref: '#/components/schemas/NetSliceTemplate'
6809 NetSlicePackage:
6810 description: NetSlice Package (compressed)
6811 content:
6812 application/zip:
6813 schema:
6814 $ref: '#/components/schemas/NetSlicePackage'
preethika.p31b3a802020-07-28 09:14:01 +00006815 NslcmSubscriptionResponse:
6816 description: NslcmSubscriptionResponse
6817 content:
6818 application/json:
6819 schema:
6820 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6821 application/yaml:
6822 schema:
6823 $ref: '#/components/schemas/NslcmSubscriptionResponse'
delacruzramfb52ade2019-10-07 16:46:59 +02006824 # END RESPONSES
6825
6826 schemas:
6827 ObjectId:
garciadeblas60e2ee92018-02-27 19:09:51 +01006828 type: object
6829 properties:
6830 id:
delacruzramfb52ade2019-10-07 16:46:59 +02006831 type: string
6832 format: uuid
adurtiafd75092024-05-31 14:52:18 +05306833 ObjectIdList:
6834 type: object
6835 properties:
6836 ns_ids:
6837 type: array
6838 items:
6839 type: string
6840 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02006841 KeyValuePairs:
6842 # A free list of key:value pairs
6843 type: object
6844 additionalProperties: true
6845 NsDescriptor:
6846 type: string
6847 format: yaml|json
6848 NsPackage:
6849 type: string
6850 format: binary
6851 CreateNsdInfoRequest:
6852 # A free list of key:value pairs
6853 type: object
6854 additionalProperties: true
6855 NsdInfoModifications:
6856 description: |
6857 NS Descriptor Information
6858 Only generic fields (id, name, description) are described
6859 For a full specification of the NS Descriptor see:
6860 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6861 type: object
6862 properties:
6863 id:
6864 description: NSD Identifier
6865 type: string
6866 name:
6867 description: NSD Name
6868 type: string
6869 description:
6870 description: NSD Description
6871 type: string
Atul Agarwal4cd9e952021-05-20 09:24:26 +00006872 AlarmInfoModifications:
6873 description: |
6874 Alarm Information
6875 type: object
6876 properties:
6877 id:
6878 description: UUID
6879 type: string
6880 is_enable:
6881 description: To enable/disable the alarm.
6882 type: string
6883 threshold:
6884 description: Threshold value of the Alarm
6885 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006886 NsdInfo:
6887 description: |
6888 NS Descriptor Information
6889 Only generic fields (_id, id, name, description) are described
6890 For a full specification of the NS Descriptor see:
6891 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6892 type: object
6893 properties:
6894 _id:
garciadeblas60e2ee92018-02-27 19:09:51 +01006895 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +01006896 Identifier of the onboarded individual NS descriptor
6897 resource. This identifier is allocated by the NFVO.
garciadeblas60e2ee92018-02-27 19:09:51 +01006898 type: string
6899 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02006900 id:
garciadeblas60e2ee92018-02-27 19:09:51 +01006901 description: |
6902 This identifier, which is allocated by the NSD
6903 designer, identifies the NSD in a globally unique
6904 way. It is copied from the NSD content and shall be
6905 present after the NSD content is on-boarded.
6906 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006907 name:
garciadeblas60e2ee92018-02-27 19:09:51 +01006908 description: |
6909 Name of the onboarded NSD. This information is
6910 copied from the NSD content and shall be present
garciadeblas60e2ee92018-02-27 19:09:51 +01006911 after the NSD content is on-boarded.
6912 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006913 description:
garciadeblas60e2ee92018-02-27 19:09:51 +01006914 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02006915 Description of the onboarded NSD.
6916 This information is copied from the NSD content.
garciadeblas60e2ee92018-02-27 19:09:51 +01006917 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +01006918 required:
delacruzramfb52ade2019-10-07 16:46:59 +02006919 - _id
garciadeblas60e2ee92018-02-27 19:09:51 +01006920 - id
6921 ArrayOfNsdInfo:
6922 type: array
6923 items:
6924 $ref: '#/components/schemas/NsdInfo'
garciadeblas60e2ee92018-02-27 19:09:51 +01006925 ProblemDetails:
6926 type: object
6927 properties:
6928 type:
6929 type: string
6930 format: uri
6931 title:
6932 type: string
6933 status:
6934 type: integer
6935 detail:
6936 type: string
6937 instance:
6938 type: string
6939 format: uri
6940 additionalProperties: true
6941 required:
6942 - status
6943 - detail
kayal2001ae8f00a2024-06-24 18:04:47 +05306944 CreateNsConfigTemplateInfoRequest:
6945 type: object
6946 properties:
6947 name:
6948 description: Ns Config Template name
6949 type: string
6950 nsdId:
6951 description: |
6952 ID of NS descriptor to which
6953 template is associated
6954 type: string
6955 config:
6956 description: Instantiation parameters
6957 type: object
6958 additionalProperties: false
6959 required:
6960 - name
6961 - nsdId
6962 - config
6963 additionalProperties: false
6964 NsConfigTemplateInfo:
6965 description: |
6966 Ns Config template information includes NSD ID, name
6967 and instantiation parameters of vld, vnf, additionParamForVnf,
6968 additionalParamsForNs.
6969 type: object
6970 properties:
6971 _id:
6972 description: |
6973 Identifier of the inboarded Ns config template resource.
6974 type: string
6975 format: uuid
6976 name:
6977 description: |
6978 Name of the onboarded Ns config template. This information
6979 is given by the user and it is unique.
6980 type: string
6981 nsdId:
6982 description: |
6983 Identifier of the NS descriptor, which is associated
6984 with Ns config template
6985 type: string
6986 config:
6987 description: |
6988 It includes instantiation parameters such as
6989 vld, vnf, additionalParamforVnf.
6990 type: object
6991 ArrayOfNsConfigTemplateInfo:
6992 type: array
6993 items:
6994 $ref: '#/components/schemas/NsConfigTemplateInfo'
6995 NsConfigTemplateInfoModifications:
6996 description: |
6997 Ns Config Template information
6998 It includes name of the template and instantiation parameters.
6999 Ns descriptor id cannot be edited.
7000 type: object
7001 properties:
7002 name:
7003 description: |
7004 Name of the template
7005 type: string
7006 config:
7007 description: |
7008 Instantiation parameters such as vld, vnf, additionalParamsForVnf
7009 can be edit.
7010 type: object
garciadeblas63fe88c2018-02-28 19:32:41 +01007011 VnfDescriptor:
7012 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007013 format: yaml|json
garciadeblas63fe88c2018-02-28 19:32:41 +01007014 VnfPackage:
7015 type: string
7016 format: binary
7017 CreateVnfPkgInfoRequest:
delacruzramfb52ade2019-10-07 16:46:59 +02007018 # A free list of key:value pairs
garciadeblas63fe88c2018-02-28 19:32:41 +01007019 type: object
7020 additionalProperties: true
7021 VnfPkgInfoModifications:
delacruzramfb52ade2019-10-07 16:46:59 +02007022 description: |
7023 VNF Package Information
7024 Only generic fields (id, name, description) are described
7025 For a full specification of the VNF Descriptor see:
7026 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
garciadeblas63fe88c2018-02-28 19:32:41 +01007027 type: object
7028 properties:
7029 id:
delacruzramfb52ade2019-10-07 16:46:59 +02007030 description: VNF Package Identifier
7031 type: string
7032 name:
7033 description: VNF Package Name
7034 type: string
7035 description:
7036 description: VNF Package description
7037 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007038 VnfPkgInfo:
7039 description: |
7040 VNF Package Information
7041 Only generic fields (_id, id, name, description) are described
7042 For a full specification of the VNF Descriptor see:
7043 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
7044 type: object
7045 properties:
7046 _id:
garciadeblas63fe88c2018-02-28 19:32:41 +01007047 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +01007048 Identifier of the VNF package. This identifier is allocated by the NFVO.
garciadeblas63fe88c2018-02-28 19:32:41 +01007049 type: string
7050 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007051 id:
7052 description: VNF Package Identifier
garciadeblas63fe88c2018-02-28 19:32:41 +01007053 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007054 name:
7055 description: VNF Package Name
garciadeblas63fe88c2018-02-28 19:32:41 +01007056 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007057 description:
7058 description: VNF Package description
garciadeblas63fe88c2018-02-28 19:32:41 +01007059 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01007060 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007061 - _id
garciadeblas63fe88c2018-02-28 19:32:41 +01007062 - id
garciadeblas63fe88c2018-02-28 19:32:41 +01007063 ArrayOfVnfPkgInfo:
7064 type: array
7065 items:
7066 $ref: '#/components/schemas/VnfPkgInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02007067 # CreateNsRequest:
7068 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +01007069 NsInstance:
delacruzramfb52ade2019-10-07 16:46:59 +02007070 description: |
7071 NS Instance Information
7072 Only generic fields (_id, id, name, description) are described
7073 For a full specification of the NS Instance see:
7074 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
garciadeblas12fcc4b2018-03-02 16:12:02 +01007075 type: object
7076 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007077 _id:
7078 description: Identifier of the NS instance.
7079 type: string
7080 format: uuid
garciadeblas12fcc4b2018-03-02 16:12:02 +01007081 id:
7082 description: Identifier of the NS instance.
7083 type: string
7084 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007085 name:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007086 description: Human readable name of the NS instance.
7087 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007088 description:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007089 description: Human readable description of the NS instance.
7090 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01007091 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007092 - _id
garciadeblas12fcc4b2018-03-02 16:12:02 +01007093 - id
delacruzramfb52ade2019-10-07 16:46:59 +02007094 - name
garciadeblas12fcc4b2018-03-02 16:12:02 +01007095 InstantiateNsRequest:
7096 type: object
7097 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007098 nsName:
7099 description: |
7100 Human-readable name of the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01007101 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007102 nsdId:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007103 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02007104 Identifier of the NSD that defines the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01007105 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007106 format: uuid
7107 vimAccountId:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007108 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02007109 Identifier of the VIM Account where the NS instance shall be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01007110 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007111 format: uuid
kayal2001ae8f00a2024-06-24 18:04:47 +05307112 nsConfigTemplateId:
7113 description: |
7114 Identifier of the Ns config template which is selected
7115 while instantiation
7116 type: string
7117 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02007118 lcmOperationType:
7119 type: string
7120 nsInstanceId:
7121 type: string
7122 format: uuid
7123 netsliceInstanceId:
7124 type: string
7125 format: uuid
7126 nsDescription:
7127 type: string
7128 nullable: true
7129 wimAccountId:
7130 oneOf:
7131 - type: string
7132 - type: boolean
7133 nullable: true
7134 additionalParamsForNs:
7135 type: object
7136 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007137 additionalParamsForVnf: &additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +02007138 type: array
7139 items:
7140 type: object
7141 properties:
7142 member-vnf-index:
7143 type: string
7144 additionalParams:
7145 type: object
7146 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007147 k8s-namespace:
7148 type: string
7149 description: |
7150 use this namespace for all the KDU deployed in this VNF
7151 (if any). By default it is used the id of the project
delacruzramaf79f3c2019-10-22 13:13:01 +02007152 additionalParamsForVdu:
7153 type: array
7154 items:
7155 type: object
7156 properties:
7157 vdu_id:
7158 type: string
7159 additionalParams:
7160 type: object
7161 additionalProperties: true
7162 required:
7163 - vdu_id
7164 - additionalParams
7165 additionalProperties: false
7166 additionalParamsForKdu:
7167 type: array
7168 items:
7169 type: object
7170 properties:
7171 kdu_name:
7172 type: string
tiernof2c14402020-04-24 13:55:01 +00007173 k8s-namespace:
7174 type: string
7175 description: use this namespace for this KDU
7176 kdu_model:
7177 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +02007178 additionalParams:
7179 type: object
7180 additionalProperties: true
7181 required:
7182 - kdu_name
tiernof2c14402020-04-24 13:55:01 +00007183 minProperties: 2
delacruzramaf79f3c2019-10-22 13:13:01 +02007184 additionalProperties: false
7185 required:
7186 - member-vnf-index
7187 minProperties: 2
7188 additionalProperties: false
7189 ssh_keys:
7190 type: array
7191 items:
7192 type: string
7193 nsr_id:
7194 type: string
7195 format: uuid
7196 vduImage:
7197 type: string
tiernof2c14402020-04-24 13:55:01 +00007198 placement-engine:
7199 type: string
7200 description: |
7201 To compute automatically the target VIM for each VNF based on
7202 constrains, e.g. latency. Currently only 'PLA' is supported
7203 placement-constraints:
7204 type: object
7205 additionalProperties: true
7206 k8s-namespace:
7207 type: string
7208 timeout_ns_deploy:
7209 type: integer
delacruzramaf79f3c2019-10-22 13:13:01 +02007210 vnf:
7211 type: array
7212 items:
7213 type: object
7214 properties:
7215 member-vnf-index:
7216 type: string
7217 vimAccountId:
7218 type: string
7219 format: uuid
7220 vdu:
7221 type: array
7222 items:
7223 type: object
7224 properties:
7225 id:
7226 type: string
7227 volume:
7228 type: array
7229 items:
7230 type: object
7231 properties:
7232 name:
7233 type: string
7234 vim-volume-id:
7235 type: string
7236 required:
7237 - name
7238 - vim-volume-id
7239 additionalProperties: false
7240 minItems: 1
7241 interface:
7242 type: array
7243 items:
7244 type: object
7245 properties:
7246 name:
7247 type: string
7248 ip-address:
7249 type: string
7250 format: ipv4
7251 mac-address:
7252 type: string
7253 format: mac_address
7254 floating-ip-required:
7255 type: boolean
7256 required:
7257 - name
7258 additionalProperties: false
7259 minItems: 1
7260 required:
7261 - id
7262 additionalProperties: false
7263 minItems: 1
7264 internal-vld:
7265 type: array
7266 items:
7267 type: object
7268 properties:
7269 name:
7270 type: string
7271 vim-network-name:
7272 type: string
7273 vim-network-id:
7274 type: string
7275 ip-profile:
7276 type: object
7277 properties:
7278 ip-version:
7279 type: string
7280 enum:
7281 - ipv4
7282 - ipv6
7283 subnet-address:
7284 type: string
7285 format: ip_prefix
7286 nullable: true
7287 gateway-address:
7288 type: string
7289 format: ipv4
7290 nullable: true
7291 dns-server:
7292 type: array
7293 items:
7294 type: object
7295 properties:
7296 address:
7297 type: string
7298 format: ipv4
7299 required:
7300 - address
7301 additionalProperties: false
7302 minItems: 1
7303 nullable: true
7304 dhcp-params:
7305 type: object
7306 properties:
7307 enabled:
7308 type: boolean
7309 count:
7310 type: integer
7311 minimum: 1
7312 start-address:
7313 type: string
7314 format: ipv4
7315 additionalProperties: false
7316 nullable: true
7317 additionalProperties: false
7318 provider-network:
7319 type: object
7320 properties:
7321 physical-network:
7322 type: string
7323 segmentation-id:
7324 type: string
tiernof2c14402020-04-24 13:55:01 +00007325 network-type:
7326 type: string
7327 sdn-ports:
7328 description: |
7329 connect additional ports to the created underlay SDN connectivity.
7330 Normally for external connectivy.
7331 type: array
7332 items:
7333 type: object
7334 properties:
7335 switch_id:
7336 type: string
7337 switch_port:
7338 type: string
7339 mac_address:
7340 type: string
7341 format: mac_address
7342 vlan:
7343 type: integer
7344 additionalProperties: true
7345 required:
7346 - switch_id
7347 - switch_port
7348 minItems: 1
delacruzramaf79f3c2019-10-22 13:13:01 +02007349 additionalProperties: false
7350 internal-connection-point:
7351 type: array
7352 items:
7353 type: object
7354 properties:
7355 id-ref:
7356 type: string
7357 ip-address:
7358 type: string
7359 format: ipv4
7360 required:
7361 - id-ref
7362 minProperties: 2
7363 additionalProperties: False
7364 minItems: 1
7365 required:
7366 - name
7367 minProperties: 2
7368 additionalProperties: false
7369 minItems: 1
7370 required:
7371 - member-vnf-index
7372 minProperties: 2
7373 additionalProperties: false
7374 minItems: 1
7375 vld:
7376 type: array
7377 items:
7378 type: object
7379 properties:
7380 name:
7381 type: string
7382 vim-network-name:
7383 oneOf:
7384 - type: string
7385 - type: object
7386 vim-network-id:
7387 oneOf:
7388 - type: string
7389 - type: object
7390 ns-net:
7391 type: object
7392 additionalProperties: true
7393 wimAccountId:
7394 oneOf:
7395 - type: string
7396 - type: boolean
7397 nullable: true
7398 ip-profile:
7399 type: object
7400 additionalProperties: true
7401 provider-network:
7402 type: object
7403 properties:
7404 physical-network:
7405 type: string
7406 segmentation-id:
7407 type: string
7408 additionalProperties: false
7409 vnfd-connection-point-ref:
7410 type: array
7411 items:
7412 type: object
7413 properties:
7414 member-vnf-index-ref:
7415 type: string
7416 vnfd-connection-point-ref:
7417 type: string
7418 ip-address:
7419 type: string
7420 format: ipv4
7421 required:
7422 - member-vnf-index-ref
7423 - vnfd-connection-point-ref
7424 minProperties: 3
7425 additionalProperties: false
7426 minItems: 1
7427 required:
7428 - name
7429 additionalProperties: false
7430 minItems: 1
garciadeblas12fcc4b2018-03-02 16:12:02 +01007431 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007432 - nsName
7433 - nsdId
7434 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +02007435 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007436 ScaleNsRequest:
7437 type: object
garciadeblas12fcc4b2018-03-02 16:12:02 +01007438 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007439 scaleType:
7440 type: string
7441 enum:
7442 - SCALE_VNF
tiernof2c14402020-04-24 13:55:01 +00007443 timeout_ns_scale:
7444 description: timeout for the scale operation
7445 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +02007446 scaleVnfData:
7447 type: object
7448 properties:
7449 scaleVnfType:
7450 type: string
7451 enum:
7452 - SCALE_IN
7453 - SCALE_OUT
7454 scaleByStepData:
7455 type: object
7456 properties:
7457 scaling-group-descriptor:
7458 type: string
tiernof2c14402020-04-24 13:55:01 +00007459 scaling-policy:
7460 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007461 member-vnf-index:
7462 type: string
tiernof2c14402020-04-24 13:55:01 +00007463 required:
7464 - scaling-group-descriptor
7465 - member-vnf-index
7466 additionalProperties: false
7467 required:
7468 - scaleVnfType
7469 - scaleByStepData
7470 additionalProperties: false
7471 required:
7472 - scaleType
7473 - scaleVnfData
7474 additionalProperties: false
garciadeblasb5a065f2022-02-11 00:27:47 +01007475 HealNsRequest:
7476 description: >
7477 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
7478 instance by healing one or more of the VNF that are part of this NS.
7479 type: object
7480 properties:
7481 timeout_ns_heal:
7482 description: timeout for the heal operation in seconds
7483 type: integer
7484 healVnfData:
7485 description: >
7486 List of VNF to be healed, together with the information needed to heal each.
7487 type: array
7488 items:
7489 $ref: "#/components/schemas/HealVnfData"
7490 required:
7491 - healVnfData
7492 HealVnfData:
7493 description: >
7494 This type represents the information to heal a VNF that is part of an NS.
7495 type: object
7496 required:
7497 - vnfInstanceId
7498 properties:
7499 vnfInstanceId:
7500 description: >
7501 Identifies the VNF instance, part of the NS, requiring a
7502 healing action.
7503 type: string
7504 format: uuid
7505 cause:
7506 description: >
7507 Indicates the reason why a healing procedure is required.
7508 type: string
7509 additionalParams:
7510 description: >
7511 Additional parameters passed by the NFVO as input to
7512 the healing process, specific to the VNF being healed.
7513 type: object
7514 properties:
7515 run-day1:
7516 description: >
7517 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
7518 type: boolean
7519 default: false
7520 vdu:
7521 description: >
7522 List of VDU to be healed, together with the information needed to heal each.
7523 type: array
7524 items:
7525 $ref: "#/components/schemas/HealVduData"
7526 HealVduData:
7527 description: >
7528 This type represents the information to heal a VDU that is part of a VNF.
7529 type: object
7530 required:
7531 - vdu-id
7532 properties:
7533 vdu-id:
7534 description: >
7535 Identifies the VDU id, part of the VNF, requiring a healing action.
7536 type: string
7537 format: uuid
7538 count-index:
7539 description: >
7540 Indicates the VDU number when the VDU is part of a scale-group.
7541 type: integer
7542 minimum: 0
7543 run-day1:
7544 description: >
7545 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
7546 type: boolean
7547 default: false
elumalai4b120f12022-04-28 16:44:35 +05307548 NSinstanceMigrateRequest:
7549 description: >
7550 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
7551 instance by migrating one or more of the VDUs that are part of this NS.
7552 type: object
7553 properties:
7554 vnfInstanceId:
7555 type: string
7556 migrateToHost:
7557 type: string
7558 vdu:
7559 type: object
7560 properties:
7561 vduId:
7562 type: string
7563 vduCountIndex:
7564 type: integer
7565 required:
7566 - vduId
7567 required:
7568 - vnfInstanceId
7569 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007570 TerminateNsRequest:
7571 type: object
7572 properties:
tiernof2c14402020-04-24 13:55:01 +00007573 timeout_ns_terminate:
7574 description: timeout for terminate operation
7575 type: integer
7576 autoremove:
7577 description: remove network service if termination end without error
7578 type: boolean
7579 skip_terminate_primitives:
7580 description: Do not execute network service termination primitives
7581 type: boolean
7582 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007583 ArrayOfNsInstance:
7584 type: array
7585 items:
7586 $ref: '#/components/schemas/NsInstance'
delacruzramfb52ade2019-10-07 16:46:59 +02007587 NSinstanceActionRequest:
7588 type: object
7589 properties:
7590 primitive:
7591 type: string
tiernof2c14402020-04-24 13:55:01 +00007592 description: |
7593 name of the primitive in the 'config-descriptor'. If the target is
7594 a kdu it can be also 'status', 'rollback' or 'upgrade'
delacruzramfb52ade2019-10-07 16:46:59 +02007595 primitive_params:
tiernof2c14402020-04-24 13:55:01 +00007596 description: parameters of this primitive
delacruzramfb52ade2019-10-07 16:46:59 +02007597 $ref: '#/components/schemas/KeyValuePairs'
delacruzramfb52ade2019-10-07 16:46:59 +02007598 member_vnf_index:
7599 type: string
tiernof2c14402020-04-24 13:55:01 +00007600 description: provide if the target action is for a vnf, vdu or kdu
delacruzramfb52ade2019-10-07 16:46:59 +02007601 vdu_id:
7602 type: string
tiernof2c14402020-04-24 13:55:01 +00007603 description: provide if the target action is for a vdu
7604 kdu_name:
7605 type: string
7606 description: provide if the target action is for a kdu
delacruzramfb52ade2019-10-07 16:46:59 +02007607 vdu_count_index:
7608 type: integer
tiernof2c14402020-04-24 13:55:01 +00007609 timeout_ns_action:
7610 description: timeout for the day 1/2 operation
7611 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +02007612 required:
7613 - primitive
7614 - primitive_params
7615 additionalProperties: false
elumalaif2eb5e72022-03-21 19:44:39 +05307616 UpdateNsRequest:
7617 description: >
7618 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
7619 instance by updating one or more of the VNFs that are part of this NS.
7620 type: object
7621 properties:
7622 updateType:
7623 type: string
7624 enum:
7625 - CHANGE_VNFPKG
7626 - REMOVE_VNF
7627 - MODIFY_VNF_INFORMATION
k4.rahul66c884c2022-06-21 06:38:49 +00007628 - OPERATE_VNF
rahulkumarr7b6daf52024-06-20 05:23:01 +00007629 - VERTICAL_SCALE
elumalaif2eb5e72022-03-21 19:44:39 +05307630 changeVnfPackageData:
7631 type: object
7632 properties:
7633 vnfInstanceId:
7634 type: string
7635 vnfdId:
7636 type: string
7637 required:
7638 - vnfInstanceId
7639 - vnfdId
7640 removeVnfInstanceId:
7641 type: string
7642 modifyVnfInfoData:
7643 type: object
7644 properties:
7645 vnfInstanceId:
7646 type: string
7647 vnfdId:
7648 type: string
7649 required:
7650 - vnfInstanceId
7651 - vnfdId
k4.rahul66c884c2022-06-21 06:38:49 +00007652 operateVnfData:
7653 type: object
7654 properties:
7655 vnfInstanceId:
7656 type: string
7657 changeStateTo:
7658 type: string
7659 additionalParam:
7660 type: object
7661 properties:
7662 run-day1:
7663 type: boolean
7664 vdu_id:
7665 type: string
7666 count-index:
7667 type: number
7668 required:
7669 - vdu_id
7670 - count-index
7671 required:
7672 - vnfInstanceId
7673 - changeStateTo
7674 additionalProperties: false
rahulkumarr7b6daf52024-06-20 05:23:01 +00007675 verticalScaleVnf:
govindarajul36a93312022-06-21 13:36:22 +05307676 type: object
7677 properties:
7678 vnfInstanceId:
7679 type: string
rahulkumarr7b6daf52024-06-20 05:23:01 +00007680 vnfdId:
7681 type: string
7682 vduId:
7683 type: string
7684 countIndex:
7685 type: number
govindarajul36a93312022-06-21 13:36:22 +05307686 required:
7687 - vnfInstanceId
rahulkumarr7b6daf52024-06-20 05:23:01 +00007688 - vnfdId
7689 - vduId
govindarajul36a93312022-06-21 13:36:22 +05307690 required:
rahulkumarr7b6daf52024-06-20 05:23:01 +00007691 - updateType
govindarajul36a93312022-06-21 13:36:22 +05307692 additionalProperties: false
adurtiafd75092024-05-31 14:52:18 +05307693 MultiNsTerminateRequest:
7694 type: object
7695 properties:
7696 ns_ids:
7697 description: List of Ns instance Ids to be deleted
7698 type: array
7699 items:
7700 type: string
7701 format: uuid
7702 autoremove:
7703 description: remove network service if termination end without error
7704 type: boolean
7705 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02007706 # CreateNSinstanceContentRequest:
7707 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007708 CreateNSinstanceContentResponse:
7709 type: object
7710 properties:
7711 id:
7712 type: string
7713 format: uuid
7714 nslcmop_id:
7715 type: string
7716 format: uuid
7717 NsLcmOpOcc:
7718 type: object
7719 properties:
7720 _id:
7721 type: string
7722 format: uuid
7723 id:
7724 type: string
7725 format: uuid
7726 lcmOperationType:
7727 type: string
7728 nsInstanceId:
7729 type: string
7730 format: uuid
7731 isAutomaticInvocation:
7732 type: boolean
7733 isCancelPending:
7734 type: boolean
7735 startTime:
7736 type: number
7737 format: float
7738 statusEnteredTime:
7739 type: number
7740 format: float
7741 operationParams:
7742 type: object
7743 properties:
7744 nsName:
7745 type: string
7746 nsdId:
7747 type: string
7748 format: uuid
7749 vimAccountId:
7750 type: string
7751 format: uuid
7752 nsInstanceId:
7753 type: string
7754 format: uuid
7755 lcmOperationType:
7756 type: string
7757 operationState:
7758 type: string
7759 detailed-status:
7760 type: string
7761 links:
7762 type: object
7763 properties:
7764 self:
7765 type: string
7766 format: path # uri?
7767 nsInstance:
7768 type: string
7769 format: path # uri?
7770 ArrayOfNsLcmOpOcc:
7771 type: array
7772 items:
7773 $ref: '#/components/schemas/NsLcmOpOcc'
7774 VnfInstanceInfo:
7775 description: |
7776 VNF Instance Information
7777 Only generic fields (_id, id) are described
7778 For a full specification of the VNF Instance see:
7779 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7780 type: object
7781 properties:
7782 _id:
7783 type: string
7784 format: uuid
7785 id:
7786 type: string
7787 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007788 ArrayOfVnfInstanceInfo:
7789 type: array
7790 items:
7791 $ref: '#/components/schemas/VnfInstanceInfo'
7792 NstInfo:
7793 description: |
7794 NetSlice Template Information
7795 Only generic fields (_id, id, name) are described
7796 For a full specification of the NetSlice Template see:
7797 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7798 type: object
7799 properties:
7800 _id:
7801 description: NetSlice Template Identifier
7802 type: string
7803 format: uuid
7804 id:
7805 description: Human readable NetSlice Template Identifier
7806 type: string
7807 name:
7808 description: Human readable name of the NetSlice Template
7809 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007810 ArrayOfNstInfo:
7811 type: array
7812 items:
7813 $ref: '#/components/schemas/NstInfo'
7814 CreateNstInfoRequest:
7815 # A free list of key:value pairs
7816 type: object
7817 additionalProperties: true
7818 NetSliceTemplate:
7819 type: string
7820 format: yaml|json
7821 NetSlicePackage:
7822 type: string
7823 format: binary
7824 NstInfoModifications:
7825 description: |
7826 NetSlice Template Information
7827 Only generic fields (id, name) are described
7828 For a full specification of the NetSlice Template see:
7829 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7830 type: object
7831 properties:
7832 id:
7833 description: NST Identifier
7834 type: string
7835 name:
7836 description: NST Name
7837 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007838 NetSliceInstance:
7839 description: |
7840 NetSlice Instance Information
7841 Only generic fields (_id, id, name, description) are described
7842 For a full specification of the NetSlice Instance see:
7843 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7844 type: object
7845 properties:
7846 _id:
7847 description: Identifier of the NetSlice instance.
7848 type: string
7849 format: uuid
7850 id:
7851 description: Identifier of the NetSlice instance.
7852 type: string
7853 format: uuid
7854 name:
7855 description: Human readable name of the NetSlice instance.
7856 type: string
7857 description:
7858 description: Human readable description of the NetSlice instance.
7859 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007860 required:
7861 - _id
7862 - id
7863 - name
7864 ArrayOfNetSliceInstance:
7865 type: array
7866 items:
7867 $ref: '#/components/schemas/NetSliceInstance'
Atul Agarwal4cd9e952021-05-20 09:24:26 +00007868 Alarm:
7869 description: |
7870 Alarm Information
7871 type: object
7872 properties:
7873 _id:
7874 description: Identifier of the Alarm.
7875 type: string
7876 format: uuid
7877 id:
7878 description: Identifier of the Alarm.
7879 type: string
7880 format: uuid
7881 metric:
7882 description: Alarm metric.
7883 type: string
7884 threshold:
7885 description: Threshold value of the Alarm.
7886 type: number
7887 format: float
7888 operation:
7889 description: Operation to be applied.
7890 type: string
7891 action:
7892 description: Action to be taken.
7893 type: string
7894 status:
7895 description: Current status of the alarm.
7896 type: string
7897 required:
7898 - _id
7899 - id
7900 - metric
7901 - threshold
7902 - operation
7903 ArrayOfAlarm:
7904 type: array
7905 items:
7906 $ref: '#/components/schemas/Alarm'
delacruzramaf79f3c2019-10-22 13:13:01 +02007907 # CreateNsiRequest:
7908 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007909 InstantiateNsiRequest:
7910 type: object
7911 properties:
7912 nsiName:
7913 description: |
7914 Human-readable name of the NetSlice instance to be created.
7915 type: string
7916 nstId:
7917 description: |
7918 Identifier of the NST that defines the NetSlice instance to be created.
7919 type: string
7920 format: uuid
7921 vimAccountId:
7922 description: |
7923 Identifier of the VIM Account where the NetSlice instance shall be created.
7924 type: string
7925 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02007926 lcmOperationType:
7927 type: string
7928 netsliceInstanceId:
7929 type: string
7930 format: uuid
7931 nsiDescription:
7932 type: string
7933 nullable: true
7934 ssh_keys:
7935 type: string
7936 nsi_id:
7937 type: string
7938 format: uuid
7939 additionalParamsForNsi:
7940 type: object
7941 additionalProperties: true
7942 netslice-subnet:
7943 type: array
7944 items:
7945 type: object
7946 properties:
7947 id:
7948 type: string
7949 nsName:
7950 type: string
7951 nsdId:
7952 type: string
7953 format: uuid
7954 vimAccountId:
7955 type: string
7956 format: uuid
7957 lcmOperationType:
7958 type: string
7959 nsInstanceId:
7960 type: string
7961 format: uuid
7962 netsliceInstanceId:
7963 type: string
7964 format: uuid
7965 nsDescription:
7966 type: string
7967 nullable: true
7968 wimAccountId:
7969 oneOf:
7970 - type: string
7971 - type: boolean
7972 nullable: true
7973 additionalParamsForNs:
7974 type: object
7975 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007976 additionalParamsForVnf: *additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +02007977 ssh_keys:
7978 type: array
7979 items:
7980 type: string
7981 nsr_id:
7982 type: string
7983 format: uuid
7984 vduImage:
7985 type: string
7986 vnf:
7987 type: array
7988 items:
7989 type: object
7990 properties:
7991 member-vnf-index:
7992 type: string
7993 vimAccountId:
7994 type: string
7995 format: uuid
7996 vdu:
7997 type: array
7998 items:
7999 type: object
8000 properties:
8001 id:
8002 type: string
8003 volume:
8004 type: array
8005 items:
8006 type: object
8007 properties:
8008 name:
8009 type: string
8010 vim-volume-id:
8011 type: string
8012 required:
8013 - name
8014 - vim-volume-id
8015 additionalProperties: false
8016 minItems: 1
8017 interface:
8018 type: array
8019 items:
8020 type: object
8021 properties:
8022 name:
8023 type: string
8024 ip-address:
8025 type: string
8026 format: ipv4
8027 mac-address:
8028 type: string
8029 format: mac_address
8030 floating-ip-required:
8031 type: boolean
8032 required:
8033 - name
8034 additionalProperties: false
8035 minItems: 1
8036 required:
8037 - id
8038 additionalProperties: false
8039 minItems: 1
8040 internal-vld:
8041 type: array
8042 items:
8043 type: object
8044 properties:
8045 name:
8046 type: string
8047 vim-network-name:
8048 type: string
8049 vim-network-id:
8050 type: string
8051 ip-profile:
8052 type: object
8053 properties:
8054 ip-version:
8055 type: string
8056 enum:
8057 - ipv4
8058 - ipv6
8059 subnet-address:
8060 type: string
8061 format: ip_prefix
8062 nullable: true
8063 gateway-address:
8064 type: string
8065 format: ipv4
8066 nullable: true
8067 dns-server:
8068 type: array
8069 items:
8070 type: object
8071 properties:
8072 address:
8073 type: string
8074 format: ipv4
8075 required:
8076 - address
8077 additionalProperties: false
8078 minItems: 1
8079 nullable: true
8080 dhcp-params:
8081 type: object
8082 properties:
8083 enabled:
8084 type: boolean
8085 count:
8086 type: integer
8087 minimum: 1
8088 start-address:
8089 type: string
8090 format: ipv4
8091 additionalProperties: false
8092 nullable: true
8093 additionalProperties: false
8094 provider-network:
8095 type: object
8096 properties:
8097 physical-network:
8098 type: string
8099 segmentation-id:
8100 type: string
8101 additionalProperties: false
8102 internal-connection-point:
8103 type: array
8104 items:
8105 type: object
8106 properties:
8107 id-ref:
8108 type: string
8109 ip-address:
8110 type: string
8111 format: ipv4
8112 required:
8113 - id-ref
8114 minProperties: 2
8115 additionalProperties: False
8116 minItems: 1
8117 required:
8118 - name
8119 minProperties: 2
8120 additionalProperties: false
8121 minItems: 1
8122 required:
8123 - member-vnf-index
8124 minProperties: 2
8125 additionalProperties: false
8126 minItems: 1
8127 vld:
8128 type: array
8129 items:
8130 type: object
8131 properties:
8132 name:
8133 type: string
8134 vim-network-name:
8135 oneOf:
8136 - type: string
8137 - type: object
8138 vim-network-id:
8139 oneOf:
8140 - type: string
8141 - type: object
8142 ns-net:
8143 type: object
8144 additionalProperties: true
8145 wimAccountId:
8146 oneOf:
8147 - type: string
8148 - type: boolean
8149 nullable: true
8150 ip-profile:
8151 type: object
8152 additionalProperties: true
8153 provider-network:
8154 type: object
8155 properties:
8156 physical-network:
8157 type: string
8158 segmentation-id:
8159 type: string
8160 additionalProperties: false
8161 vnfd-connection-point-ref:
8162 type: array
8163 items:
8164 type: object
8165 properties:
8166 member-vnf-index-ref:
8167 type: string
8168 vnfd-connection-point-ref:
8169 type: string
8170 ip-address:
8171 type: string
8172 format: ipv4
8173 required:
8174 - member-vnf-index-ref
8175 - vnfd-connection-point-ref
8176 minProperties: 3
8177 additionalProperties: false
8178 minItems: 1
8179 required:
8180 - name
8181 additionalProperties: false
8182 minItems: 1
8183 additionalProperties: false
8184 minItems: 1
8185 netslice-vld:
8186 type: array
8187 items:
8188 type: object
8189 properties:
8190 name:
8191 type: string
8192 vim-network-name:
8193 oneOf:
8194 - type: string
8195 - type: object
8196 vim-network-id:
8197 oneOf:
8198 - type: string
8199 - type: object
8200 ip-profile:
8201 type: object
8202 additionalProperties: true
8203 required:
8204 - name
8205 additionalProperties: false
8206 minItems: 1
delacruzramfb52ade2019-10-07 16:46:59 +02008207 required:
8208 - nsiName
8209 - nstId
8210 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +02008211 additionalProperties: false
delacruzramfb52ade2019-10-07 16:46:59 +02008212 TerminateNsiRequest:
8213 type: object
8214 properties:
8215 terminationTime:
8216 description: |
8217 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
8218 automatically at this timestamp. Cardinality "0" indicates the NSI termination
8219 takes place immediately.
8220 type: string
8221 format: date-time
8222 NsiActionRequest:
8223 type: object
8224 properties:
8225 primitive:
8226 type: string
8227 primitive_params:
8228 $ref: '#/components/schemas/KeyValuePairs'
8229 lcmOperationType:
8230 type: string
8231 netsliceInstanceId:
8232 type: string
8233 format: uuid
8234 required:
8235 - primitive
8236 - primitive_params
delacruzramaf79f3c2019-10-22 13:13:01 +02008237 # CreateNsiContentRequest:
8238 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02008239 CreateNsiContentResponse:
8240 type: object
8241 properties:
8242 id:
8243 type: string
8244 format: uuid
8245 nsilcmop_id:
8246 type: string
8247 format: uuid
8248 NsiLcmOpOcc:
8249 type: object
8250 properties:
8251 _id:
8252 type: string
8253 format: uuid
8254 id:
8255 type: string
8256 format: uuid
8257 lcmOperationType:
8258 type: string
8259 netsliceInstanceId:
8260 type: string
8261 format: uuid
8262 isAutomaticInvocation:
8263 type: boolean
8264 isCancelPending:
8265 type: boolean
8266 startTime:
8267 type: number
8268 format: float
8269 statusEnteredTime:
8270 type: number
8271 format: float
8272 operationParams:
8273 type: object
8274 properties:
8275 nsiName:
8276 type: string
8277 nstId:
8278 type: string
8279 format: uuid
8280 vimAccountId:
8281 type: string
8282 format: uuid
8283 netsliceInstanceId:
8284 type: string
8285 format: uuid
8286 lcmOperationType:
8287 type: string
8288 nslcmops_ids:
8289 type: array
8290 items:
8291 type: string
8292 format: uuid
8293 operationState:
8294 type: string
8295 detailed-status:
8296 type: string
8297 links:
8298 type: object
8299 properties:
8300 self:
8301 type: string
8302 format: path # uri?
8303 netsliceInstanceId:
8304 type: string
8305 format: path # uri?
8306 ArrayOfNsiLcmOpOcc:
8307 type: array
8308 items:
8309 $ref: '#/components/schemas/NsiLcmOpOcc'
delacruzramaf79f3c2019-10-22 13:13:01 +02008310 TokenInfo:
8311 type: object
8312 properties:
8313 _id:
8314 type: string
8315 id:
8316 type: string
8317 admin:
8318 type: boolean
selvi.j9058fd92023-04-18 14:58:14 +00008319 admin_show:
8320 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +02008321 project_id:
8322 type: string
8323 format: uuid
8324 user_id:
8325 type: string
8326 format: uuid
8327 project_name:
8328 type: string
8329 username:
8330 type: string
8331 issued_at:
8332 type: number
8333 format: float
selvi.j9058fd92023-04-18 14:58:14 +00008334 user_show:
8335 type: boolean
8336 last_login:
8337 type: number
8338 format: float
8339 login_count:
8340 type: number
delacruzramaf79f3c2019-10-22 13:13:01 +02008341 expires:
8342 type: number
8343 format: float
8344 remote_host:
8345 type: string
8346 format: ipv4
8347 remote_port:
8348 type: integer
8349 roles:
8350 type: array
8351 items:
8352 type: object
8353 properties:
8354 id:
8355 type: string
8356 format: uuid
8357 name:
8358 type: string
selvi.ja6f638b2022-03-23 12:27:35 +00008359 PasswordExpiryInfo:
8360 type: object
8361 properties:
8362 id:
8363 type: string
8364 message:
8365 type: string
8366 user_id:
8367 type: string
8368 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008369 ArrayOfTokenInfo:
8370 type: array
8371 items:
8372 $ref: '#/components/schemas/TokenInfo'
8373 CreateTokenRequest:
8374 type: object
8375 properties:
8376 username:
8377 type: string
8378 password:
8379 type: string
8380 project_id:
8381 type: string
8382 required:
8383 - username
8384 - password
8385 UserInfo:
8386 type: object
8387 properties:
8388 _id:
8389 type: string
8390 format: uuid
8391 username:
8392 type: string
8393 password:
8394 type: string
8395 project_role_mappings:
8396 type: array
8397 items:
8398 type: object
8399 properties:
8400 project:
8401 type: string
8402 format: uuid
8403 role:
8404 type: string
8405 format: uuid
8406 project_name:
8407 type: string
8408 role_name:
8409 type: string
8410 projects:
8411 type: array
8412 items:
8413 type: string
8414 ArrayOfUserInfo:
8415 type: array
8416 items:
8417 $ref: '#/components/schemas/UserInfo'
8418 ProjectRoleMappings:
8419 type: array
8420 items:
8421 type: object
8422 properties:
8423 project:
8424 type: string
8425 role:
8426 type: string
8427 required:
8428 - project
8429 - role
8430 additionalProperties: false
8431 ProjectRoleMappingsOpt:
8432 type: array
8433 items:
8434 type: object
8435 properties:
8436 project:
8437 type: string
8438 role:
8439 type: string
8440 required:
8441 - project
8442 additionalProperties: false
8443 CreateUserRequest:
8444 type: object
8445 properties:
8446 username:
8447 type: string
8448 password:
8449 type: string
8450 projects:
8451 type: array
8452 items:
8453 type: string
8454 project_role_mappings:
8455 $ref: '#/components/schemas/ProjectRoleMappings'
8456 required:
8457 - username
8458 - password
8459 additionalProperties: false
8460 ShortNameList:
8461 type: array
8462 items:
8463 type: string
8464 ArrayEditionSchema:
8465 type: object
8466 additionalProperties: true
8467 minProperties: 1
8468 description: |
8469 Array edition keys must start with '$'
8470 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
8471 EditUserRequest:
8472 type: object
8473 properties:
8474 username:
8475 type: string
8476 password:
8477 type: string
selvi.j9058fd92023-04-18 14:58:14 +00008478 old_password:
8479 type: string
8480 system_admin_id:
8481 type: string
8482 format: uuid
8483 unlock:
8484 type: boolean
8485 renew:
8486 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +02008487 projects:
8488 oneOf:
8489 - $ref: '#/components/schemas/ShortNameList'
8490 - $ref: '#/components/schemas/ArrayEditionSchema'
8491 project_role_mappings:
8492 $ref: '#/components/schemas/ProjectRoleMappings'
8493 add_project_role_mappings:
8494 $ref: '#/components/schemas/ProjectRoleMappings'
8495 remove_project_role_mappings:
8496 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
8497 QuotasInfo:
8498 type: object
8499 properties:
8500 vnfds:
8501 type: integer
8502 minimum: 0
8503 nullable: false
8504 nsds:
8505 type: integer
8506 minimum: 0
8507 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008508 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +02008509 type: integer
8510 minimum: 0
8511 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008512 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +02008513 type: integer
8514 minimum: 0
8515 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008516 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008517 type: integer
8518 minimum: 0
8519 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008520 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008521 type: integer
8522 minimum: 0
8523 nullable: false
8524 vim_accounts:
8525 type: integer
8526 minimum: 0
8527 nullable: false
8528 wim_accounts:
8529 type: integer
8530 minimum: 0
8531 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008532 sdn_controllers:
8533 type: integer
8534 minimum: 0
8535 nullable: false
8536 k8sclusters:
8537 type: integer
8538 minimum: 0
8539 nullable: false
David Garciaaf38fce2021-05-04 12:48:04 +02008540 vca:
8541 type: integer
8542 minimum: 0
8543 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008544 k8srepos:
8545 type: integer
8546 minimum: 0
8547 nullable: false
8548 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +02008549 type: integer
8550 minimum: 0
8551 nullable: false
8552 additionalProperties: false
8553 EditQuotasInfo:
8554 type: object
8555 properties:
8556 vnfds:
8557 type: integer
8558 minimum: 0
8559 nullable: true
8560 nsds:
8561 type: integer
8562 minimum: 0
8563 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008564 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +02008565 type: integer
8566 minimum: 0
8567 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008568 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +02008569 type: integer
8570 minimum: 0
8571 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008572 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008573 type: integer
8574 minimum: 0
8575 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008576 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008577 type: integer
8578 minimum: 0
8579 nullable: true
8580 vim_accounts:
8581 type: integer
8582 minimum: 0
8583 nullable: true
8584 wim_accounts:
8585 type: integer
8586 minimum: 0
8587 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008588 sdn_controllers:
8589 type: integer
8590 minimum: 0
8591 nullable: true
8592 k8sclusters:
8593 type: integer
8594 minimum: 0
8595 nullable: true
David Garciaaf38fce2021-05-04 12:48:04 +02008596 vca:
8597 type: integer
8598 minimum: 0
8599 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008600 k8srepos:
8601 type: integer
8602 minimum: 0
8603 nullable: true
8604 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +02008605 type: integer
8606 minimum: 0
8607 nullable: true
8608 additionalProperties: false
8609 ProjectInfo:
8610 type: object
8611 properties:
8612 _id:
8613 type: string
8614 format: uuid
8615 name:
8616 type: string
8617 quotas:
8618 $ref: '#/components/schemas/QuotasInfo'
8619 ArrayOfProjectInfo:
8620 type: array
8621 items:
8622 $ref: '#/components/schemas/ProjectInfo'
8623 CreateProjectRequest:
8624 type: object
8625 properties:
8626 name:
8627 type: string
8628 admin:
8629 type: boolean
8630 quotas:
8631 $ref: '#/components/schemas/QuotasInfo'
8632 required:
8633 - name
8634 additionalProperties: false
8635 EditProjectRequest:
8636 type: object
8637 properties:
8638 name:
8639 type: string
8640 admin:
8641 type: boolean
8642 quotas:
8643 $ref: '#/components/schemas/EditQuotasInfo'
8644 additionalProperties: false
8645 PermissionsInfo:
8646 type: object
8647 additionalProperties:
8648 type: boolean
8649 nullable: false
8650 description: |
8651 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8652 Permission values are either true or false
8653 EditPermissionsInfo:
8654 type: object
8655 additionalProperties:
8656 type: boolean
8657 nullable: true
8658 description: |
8659 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8660 Permission values are either true, false, or null
8661 RoleInfo:
8662 type: object
8663 properties:
8664 _id:
8665 type: string
8666 format: uuid
8667 name:
8668 type: string
8669 permissions:
8670 $ref: '#/components/schemas/PermissionsInfo'
8671 ArrayOfRoleInfo:
8672 type: array
8673 items:
8674 $ref: '#/components/schemas/RoleInfo'
8675 CreateRoleRequest:
8676 type: object
8677 properties:
8678 name:
8679 type: string
8680 permissions:
8681 $ref: '#/components/schemas/PermissionsInfo'
8682 required:
8683 - name
8684 additionalProperties: false
8685 EditRoleRequest:
8686 type: object
8687 properties:
8688 name:
8689 type: string
8690 permissions:
8691 $ref: '#/components/schemas/EditPermissionsInfo'
8692 additionalProperties: false
8693 VimType:
8694 type: string
8695 enum:
8696 - openvim
8697 - openstack
8698 - vmware
8699 - opennebula
8700 - aws
8701 - azure
8702 - fos
8703 VimInfo:
8704 type: object
8705 properties:
8706 _id:
8707 type: string
8708 format: uuid
8709 schema_version:
8710 type: string
8711 format: X.Y[.Z]
8712 schema_type:
8713 type: string
8714 name:
8715 type: string
8716 description:
8717 type: string
8718 vim:
8719 type: string
8720 datacenter:
8721 type: string
8722 vim_type:
8723 $ref: '#/components/schemas/VimType'
8724 vim_url:
8725 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008726 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008727 vim_tenant_name:
8728 type: string
8729 vim_user:
8730 type: string
8731 vim_password:
8732 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008733 vca:
8734 type: string
8735 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008736 config:
8737 type: object
8738 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +00008739 resources:
8740 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +02008741 ArrayOfVimInfo:
8742 type: array
8743 items:
8744 $ref: '#/components/schemas/VimInfo'
8745 CreateVimRequest:
8746 type: object
8747 properties:
8748 schema_version:
8749 type: string
8750 format: X.Y[.Z]
8751 schema_type:
8752 type: string
8753 name:
8754 type: string
8755 description:
8756 type: string
8757 vim:
8758 type: string
8759 datacenter:
8760 type: string
8761 vim_type:
8762 $ref: '#/components/schemas/VimType'
8763 vim_url:
8764 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008765 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008766 vim_tenant_name:
8767 type: string
8768 vim_user:
8769 type: string
8770 vim_password:
8771 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008772 vca:
8773 type: string
8774 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008775 config:
8776 type: object
8777 additionalProperties: true
garciadeblas6229f2f2022-11-24 15:03:56 +01008778 prometheus-config:
8779 type: object
8780 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +00008781 resources:
8782 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +02008783 required:
8784 - name
8785 - vim_url
8786 - vim_type
8787 - vim_user
8788 - vim_password
8789 - vim_tenant_name
8790 additionalProperties: false
8791 EditVimRequest:
8792 type: object
8793 properties:
8794 name:
8795 type: string
8796 description:
8797 type: string
8798 vim:
8799 type: string
8800 datacenter:
8801 type: string
8802 vim_type:
8803 $ref: '#/components/schemas/VimType'
8804 vim_url:
8805 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008806 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008807 vim_tenant_name:
8808 type: string
8809 vim_user:
8810 type: string
8811 vim_password:
8812 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008813 vca:
8814 type: string
8815 format: uuid
garciadeblas6229f2f2022-11-24 15:03:56 +01008816 prometheus-config:
8817 type: object
8818 additionalProperties: true
delacruzramaf79f3c2019-10-22 13:13:01 +02008819 config:
8820 type: object
8821 additionalProperties: true
8822 additionalProperties: false
8823 ObjectId_plus_OpId:
8824 type: object
8825 properties:
8826 id:
8827 type: string
8828 format: uuid
8829 op_id:
8830 type: string
8831 format: uuid
8832 OpId:
8833 type: object
8834 properties:
8835 op_id:
8836 type: string
8837 format: uuid
8838 WimType:
8839 type: string
8840 enum:
8841 - onos
8842 - odl
8843 - tapi
8844 - dynpac
8845 - fake
8846 WimInfo:
8847 type: object
8848 properties:
8849 _id:
8850 type: string
8851 format: uuid
8852 schema_version:
8853 type: string
8854 format: X.Y[.Z]
8855 schema_type:
8856 type: string
8857 name:
8858 type: string
8859 description:
8860 type: string
8861 wim:
8862 type: string
8863 wim_type:
8864 $ref: '#/components/schemas/WimType'
8865 wim_url:
8866 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008867 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008868 user:
8869 type: string
8870 password:
8871 type: string
8872 config:
8873 type: object
8874 additionalProperties: true
8875 ArrayOfWimInfo:
8876 type: array
8877 items:
8878 $ref: '#/components/schemas/WimInfo'
8879 CreateWimRequest:
8880 type: object
8881 properties:
8882 schema_version:
8883 type: string
8884 format: X.Y[.Z]
8885 schema_type:
8886 type: string
8887 name:
8888 type: string
8889 description:
8890 type: string
8891 wim:
8892 type: string
8893 wim_type:
8894 $ref: '#/components/schemas/WimType'
8895 wim_url:
8896 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008897 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008898 user:
8899 type: string
8900 password:
8901 type: string
8902 config:
8903 type: object
8904 additionalProperties: true
8905 required:
8906 - name
8907 - wim_url
8908 - wim_type
8909 additionalProperties: false
8910 EditWimRequest:
8911 type: object
8912 properties:
8913 name:
8914 type: string
8915 description:
8916 type: string
8917 wim:
8918 type: string
8919 wim_type:
8920 type: string
8921 wim_url:
8922 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008923 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008924 user:
8925 type: string
8926 password:
8927 type: string
8928 config:
8929 type: object
8930 additionalProperties: true
8931 additionalProperties: false
8932 SdnBasicProperties:
8933 type: object
8934 properties:
8935 name:
8936 type: string
8937 description:
8938 type: string
8939 dpid:
8940 type: string
8941 format: mac_address
8942 ip:
8943 type: string
8944 format: ipv4
8945 port:
8946 type: integer
8947 type:
8948 type: string
8949 enum:
8950 - floodlight
8951 - opendaylight
8952 - onos
8953 version:
8954 type: string
8955 user:
8956 type: string
8957 password:
8958 type: string
8959 SdnExtraProperties:
8960 type: object
8961 properties:
8962 _id:
8963 type: string
8964 format: uuid
8965 schema_version:
8966 type: string
8967 format: X.Y[.Z]
8968 SdnInfo:
8969 allOf:
8970 - $ref: '#/components/schemas/SdnExtraProperties'
8971 - $ref: '#/components/schemas/SdnBasicProperties'
8972 ArrayOfSdnInfo:
8973 type: array
8974 items:
8975 $ref: '#/components/schemas/SdnInfo'
8976 CreateSdnRequest:
8977 allOf:
8978 - $ref: '#/components/schemas/SdnBasicProperties'
8979 required:
8980 - name
8981 - type
8982 - ip
8983 - port
8984 - dpid
8985 additionalProperties: false
8986 EditSdnRequest:
8987 allOf:
8988 - $ref: '#/components/schemas/SdnBasicProperties'
8989 additionalProperties: false
8990 NsPmJobReportInfo:
8991 type: object
8992 properties:
8993 entries:
8994 type: array
8995 items:
8996 type: object
8997 properties:
8998 objectInstanceId:
8999 type: string
9000 format: uuid
9001 performanceMetric:
9002 type: string
9003 performanceValue:
9004 type: object
9005 properties:
9006 performanceValue:
9007 type: object
9008 properties:
9009 performanceValue:
9010 type: number
9011 vnfMemberIndex:
9012 type: string
9013 vduName:
9014 type: string
9015 timestamp:
9016 type: number
9017 PduInterfaces:
9018 type: array
9019 items:
9020 type: object
9021 properties:
9022 name:
9023 type: string
9024 mgmt:
9025 type: boolean
9026 type:
9027 type: string
9028 enum:
9029 - overlay
9030 - underlay
9031 ip-address:
9032 type: string
9033 format: ipv4
9034 mac-address:
9035 type: string
9036 format: mac_address
9037 vim-network-name:
9038 type: string
9039 vim-network-id:
9040 type: string
9041 required:
9042 - name
9043 - mgmt
9044 - ip-address
9045 additionalProperties: false
9046 PduInfo:
9047 type: object
9048 properties:
9049 _id:
9050 type: string
9051 format: uuid
9052 name:
9053 type: string
9054 type:
9055 type: string
9056 description:
9057 type: string
9058 shared:
9059 type: boolean
9060 vims:
9061 type: array
9062 items:
9063 type: string
9064 vim_accounts:
9065 type: array
9066 items:
9067 type: string
9068 interfaces:
9069 $ref: '#/components/schemas/PduInterfaces'
9070 ArrayOfPduInfo:
9071 type: array
9072 items:
9073 $ref: '#/components/schemas/PduInfo'
9074 CreatePduRequest:
9075 type: object
9076 properties:
9077 name:
9078 type: string
9079 type:
9080 type: string
9081 description:
9082 type: string
9083 shared:
9084 type: boolean
9085 vims:
9086 type: array
9087 items:
9088 type: string
9089 vim_accounts:
9090 type: array
9091 items:
9092 type: string
9093 interfaces:
9094 $ref: '#/components/schemas/PduInterfaces'
9095 required:
9096 - name
9097 - type
9098 - interfaces
9099 additionalProperties: false
9100 EditPduRequest:
9101 type: object
9102 properties:
9103 name:
9104 type: string
9105 type:
9106 type: string
9107 description:
9108 type: string
9109 shared:
9110 type: boolean
9111 vims:
9112 type: array
9113 items:
9114 type: string
9115 vim_accounts:
9116 type: array
9117 items:
9118 type: string
9119 interfaces:
9120 $ref: '#/components/schemas/PduInterfaces'
9121 additionalProperties: false
9122 K8sClusterNetList:
9123 type: array
9124 items:
9125 type: object
Gabriel Cubab77d0df2022-03-22 14:43:11 -05009126 additionalProperties: false
9127 K8sClusterDeploymentMethods:
9128 type: object
9129 properties:
Gabriel Cubab77d0df2022-03-22 14:43:11 -05009130 juju-bundle:
9131 type: boolean
9132 helm-chart-v3:
9133 type: boolean
9134 additionalProperties: false
9135 minProperties: 3
delacruzramaf79f3c2019-10-22 13:13:01 +02009136 K8sClusterInfo:
9137 type: object
9138 properties:
9139 _id:
9140 type: string
9141 format: uuid
9142 schema_version:
9143 type: string
9144 format: X.Y[.Z]
9145 schema_type:
9146 type: string
9147 name:
9148 type: string
9149 description:
9150 type: string
9151 credentials:
9152 type: object
9153 additionalProperties: true
9154 vim_account:
9155 type: string
9156 format: uuid
9157 k8s_version:
9158 type: string
9159 nets:
9160 $ref: '#/components/schemas/K8sClusterNetList'
Gabriel Cubab77d0df2022-03-22 14:43:11 -05009161 deployment_methods:
9162 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
delacruzramaf79f3c2019-10-22 13:13:01 +02009163 namespace:
9164 type: string
9165 cni:
9166 type: array
9167 items:
9168 type: string
9169 ArrayOfK8sClusterInfo:
9170 type: array
9171 items:
9172 $ref: '#/components/schemas/K8sClusterInfo'
9173 CreateK8sClusterRequest:
9174 type: object
9175 properties:
9176 schema_version:
9177 type: string
9178 format: X.Y[.Z]
9179 schema_type:
9180 type: string
9181 name:
9182 type: string
9183 description:
9184 type: string
9185 credentials:
9186 type: object
9187 additionalProperties: true
9188 vim_account:
9189 type: string
9190 format: uuid
9191 k8s_version:
9192 type: string
9193 nets:
9194 $ref: '#/components/schemas/K8sClusterNetList'
9195 namespace:
9196 type: string
9197 cni:
9198 type: array
9199 items:
9200 type: string
9201 required:
9202 - name
9203 - credentials
9204 - vim_account
9205 - k8s_version
9206 - nets
9207 additionalProperties: false
9208 EditK8sClusterRequest:
9209 type: object
9210 properties:
9211 name:
9212 type: string
9213 description:
9214 type: string
9215 credentials:
9216 type: object
9217 additionalProperties: true
9218 vim_account:
9219 type: string
9220 format: uuid
9221 k8s_version:
9222 type: string
9223 nets:
9224 $ref: '#/components/schemas/K8sClusterNetList'
9225 namespace:
9226 type: string
9227 cni:
9228 type: array
9229 items:
9230 type: string
9231 additionalProperties: false
David Garciaaf38fce2021-05-04 12:48:04 +02009232 VcaInfo:
9233 type: object
9234 properties:
9235 _id:
9236 type: string
9237 format: uuid
9238 schema_version:
9239 type: string
9240 format: X.Y[.Z]
9241 schema_type:
9242 type: string
9243 name:
9244 type: string
9245 description:
9246 type: string
9247 endpoints:
9248 type: string
9249 user:
9250 type: string
9251 secret:
9252 type: string
9253 cacert:
9254 type: string
9255 lxd-cloud:
9256 type: string
9257 lxd-credentials:
9258 type: string
9259 k8s-cloud:
9260 type: string
9261 k8s-credentials:
9262 type: string
9263 model-config:
9264 type: object
9265 additionalProperties: true
9266 ArrayOfVcaInfo:
9267 type: array
9268 items:
9269 $ref: '#/components/schemas/VcaInfo'
9270 CreateVcaRequest:
9271 type: object
9272 properties:
9273 schema_version:
9274 type: string
9275 format: X.Y[.Z]
9276 schema_type:
9277 type: string
9278 name:
9279 type: string
9280 description:
9281 type: string
9282 endpoints:
9283 type: string
9284 user:
9285 type: string
9286 secret:
9287 type: string
9288 cacert:
9289 type: string
9290 lxd-cloud:
9291 type: string
9292 lxd-credentials:
9293 type: string
9294 k8s-cloud:
9295 type: string
9296 k8s-credentials:
9297 type: string
9298 model-config:
9299 type: object
9300 additionalProperties: true
9301 required:
9302 - name
9303 - endpoints
9304 - user
9305 - secret
9306 - cacert
9307 - lxd-cloud
9308 - lxd-credentials
9309 - k8s-cloud
9310 - k8s-credentials
9311 additionalProperties: false
9312 EditVcaRequest:
9313 type: object
9314 properties:
9315 name:
9316 type: string
9317 description:
9318 type: string
9319 endpoints:
9320 type: string
9321 user:
9322 type: string
9323 secret:
9324 type: string
9325 cacert:
9326 type: string
9327 lxd-cloud:
9328 type: string
9329 lxd-credentials:
9330 type: string
9331 k8s-cloud:
9332 type: string
9333 k8s-credentials:
9334 type: string
9335 model-config:
9336 type: object
9337 additionalProperties: true
9338 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02009339 K8sRepoType:
9340 type: string
9341 enum:
9342 - chart
9343 - bundle
9344 K8sRepoInfo:
9345 type: object
9346 properties:
9347 _id:
9348 type: string
9349 format: uuid
9350 name:
9351 type: string
9352 description:
9353 type: string
9354 type:
9355 $ref: '#/components/schemas/K8sRepoType'
9356 url:
9357 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01009358 format: uri
garciadeblas8bb3cce2022-02-11 00:41:18 +01009359 username:
9360 type: string
9361 description: repository username
9362 password:
9363 type: string
9364 description: repository password
9365 ca-file:
9366 type: string
9367 description: verify certificates of HTTPS-enabled servers using this CA bundle
9368 cert-file:
9369 type: string
9370 description: identify HTTPS client using this SSL certificate file
9371 skip-tls-verify:
9372 type: boolean
9373 description: skip tls certificate checks for the repository
9374 key-file:
9375 type: string
9376 description: identify HTTPS client using this SSL key file
garciadeblas0881dcf2023-10-20 12:00:08 +02009377 oci:
9378 type: boolean
9379 default: false
9380 description: >
9381 Flag to indicate whether or not it is an OCI-enabled repo (default: false)
9382 required:
9383 - name
9384 - type
9385 - url
9386 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02009387 ArrayOfK8sRepoInfo:
9388 type: array
9389 items:
9390 $ref: '#/components/schemas/K8sRepoInfo'
9391 CreateK8sRepoRequest:
9392 type: object
9393 properties:
9394 name:
9395 type: string
9396 description:
9397 type: string
9398 type:
9399 $ref: '#/components/schemas/K8sRepoType'
9400 url:
9401 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01009402 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02009403 required:
9404 - name
9405 - type
9406 - url
9407 additionalProperties: false
preethika.p31b3a802020-07-28 09:14:01 +00009408 NslcmSubscriptionResponse:
9409 type: object
9410 properties:
9411 id:
9412 type: string
9413 format: uuid
9414 filter:
9415 type: object
9416 CallbackUri:
9417 type: string
9418 format: uri
9419 _links:
9420 type: object
9421 NslcmSubscriptionInfo:
9422 type: object
9423 properties:
9424 _id:
9425 type: string
9426 format: uuid
9427 _admin:
9428 type: object
9429 schema_version:
9430 type: string
9431 format: 'X.Y[.Z]'
9432 CallbackUri:
9433 type: string
9434 format: uri
9435 filter:
9436 type: object
9437 authentication:
9438 $ref: '#/components/schemas/Authenticationschema'
9439 ArrayOfNslcmSubscriptionInfo:
9440 type: array
9441 items:
9442 $ref: '#/components/schemas/NslcmSubscriptionInfo'
9443 NsInstanceSubscriptionFilter:
9444 description: |
9445 used to identify the network service
9446 type: object
9447 oneOf:
9448 - $ref: '#/components/schemas/nsdIds'
9449 - $ref: '#/components/schemas/vnfdIds'
9450 - $ref: '#/components/schemas/pnfdIds'
9451 - $ref: '#/components/schemas/nsInstanceIds'
9452 - $ref: '#/components/schemas/nsInstanceNames'
9453 nsdIds:
9454 type: array
9455 items:
9456 type: string
9457 vnfdIds:
9458 type: array
9459 items:
9460 type: string
9461 pnfdIds:
9462 type: array
9463 items:
9464 type: string
9465 nsInstanceIds:
9466 type: array
9467 items:
9468 type: string
9469 nsInstanceNames:
9470 type: array
9471 items:
9472 type: string
9473 Nslcmsubschema:
9474 type: object
9475 properties:
9476 nsInstanceSubscriptionFilter:
9477 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
9478 notificationTypes:
9479 description: |
9480 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
9481 type: array
9482 items:
9483 type: string
9484 enum:
9485 - NsIdentifierCreationNotification
9486 - NsIdentifierDeletionNotification
9487 - NsLcmOperationOccurrenceNotification
9488 - NsChangeNotification
9489 operationTypes:
9490 type: array
9491 items:
9492 type: string
9493 enum:
9494 - INSTANTIATE
9495 - SCALE
9496 - TERMINATE
9497 - UPDATE
9498 - HEAL
9499 operationStates:
9500 type: array
9501 items:
9502 type: string
9503 enum:
9504 - PROCESSING
9505 - COMPLETED
9506 - PARTIALLY_COMPLETED
9507 - FAILED
9508 - FAILED_TEMP
9509 - ROLLING_BACK
9510 - ROLLED_BACK
9511 nsComponentTypes:
9512 type: array
9513 items:
9514 type: string
9515 enum:
9516 - VNF
9517 - NS
9518 - PNF
9519 lcmOpNameImpactingNsComponent:
9520 type: array
9521 items:
9522 type: string
9523 enum:
9524 - VNF_INSTANTIATE
9525 - VNF_SCALE
9526 - VNF_SCALE_TO_LEVEL
9527 - VNF_CHANGE_FLAVOUR
9528 - VNF_TERMINATE
9529 - VNF_HEAL
9530 - VNF_OPERATE
9531 - VNF_CHANGE_EXT_CONN
9532 - VNF_MODIFY_INFO
9533 - NS_INSTANTIATE
9534 - NS_SCALE
9535 - NS_UPDATE
9536 - NS_TERMINATE
9537 - NS_HEAL
9538 lcmOpOccStatusImpactingNsComponent:
9539 type: array
9540 items:
9541 type: string
9542 enum:
9543 - START
9544 - COMPLETED
9545 - PARTIALLY_COMPLETED
9546 - FAILED
9547 - ROLLED_BACK
9548 Authenticationschema:
9549 type: object
9550 properties:
9551 authType:
9552 type: string
9553 enum:
9554 - basic
9555 paramsBasic:
9556 type: object
9557 properties:
9558 userName:
9559 type: string
9560 password:
9561 type: string
9562 NslcmSubscriptionRequest:
9563 type: object
9564 properties:
9565 filter:
9566 $ref: '#/components/schemas/Nslcmsubschema'
9567 CallbackUri:
9568 type: string
9569 format: uri
9570 authentication:
9571 $ref: '#/components/schemas/Authenticationschema'
9572 required:
9573 - CallbackUri
Gabriel Cuba2c8be082023-11-14 16:52:01 -05009574 CancelNSLCMOpOccRequest:
9575 type: object
9576 properties:
9577 cancelMode:
9578 type: string
9579 enum:
9580 - GRACEFUL
9581 - FORCEFUL
delacruzramfb52ade2019-10-07 16:46:59 +02009582 # END SCHEMAS
9583
garciadeblas60e2ee92018-02-27 19:09:51 +01009584 requestBodies:
9585 CreateNsdInfoRequest:
9586 content:
9587 application/json:
9588 schema:
9589 $ref: '#/components/schemas/CreateNsdInfoRequest'
9590 application/yaml:
9591 schema:
9592 $ref: '#/components/schemas/CreateNsdInfoRequest'
9593 NsdInfoModifications:
9594 content:
9595 application/json:
9596 schema:
9597 $ref: '#/components/schemas/NsdInfoModifications'
9598 application/yaml:
9599 schema:
9600 $ref: '#/components/schemas/NsdInfoModifications'
Atul Agarwal4cd9e952021-05-20 09:24:26 +00009601 AlarmInfoModifications:
9602 content:
9603 application/json:
9604 schema:
9605 $ref: '#/components/schemas/AlarmInfoModifications'
9606 application/yaml:
9607 schema:
9608 $ref: '#/components/schemas/AlarmInfoModifications'
delacruzramfb52ade2019-10-07 16:46:59 +02009609 NsDescriptor:
garciadeblas60e2ee92018-02-27 19:09:51 +01009610 content:
9611 text/plain:
9612 schema:
9613 $ref: '#/components/schemas/NsDescriptor'
delacruzramfb52ade2019-10-07 16:46:59 +02009614 NsPackage:
9615 content:
garciadeblas60e2ee92018-02-27 19:09:51 +01009616 application/zip:
9617 schema:
9618 $ref: '#/components/schemas/NsPackage'
kayal2001ae8f00a2024-06-24 18:04:47 +05309619 CreateNsConfigTemplateInfoRequest:
9620 content:
9621 application/json:
9622 schema:
9623 $ref: '#/components/schemas/CreateNsdInfoRequest'
9624 application/yaml:
9625 schema:
9626 $ref: '#/components/schemas/CreateNsdInfoRequest'
9627 NsConfigTemplateInfoModifications:
9628 content:
9629 application/json:
9630 schema:
9631 $ref: '#/components/schemas/NsdInfoModifications'
9632 application/yaml:
9633 schema:
9634 $ref: '#/components/schemas/NsdInfoModifications'
garciadeblas63fe88c2018-02-28 19:32:41 +01009635 CreateVnfPkgInfoRequest:
9636 content:
9637 application/json:
9638 schema:
9639 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9640 application/yaml:
9641 schema:
9642 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9643 VnfPkgInfoModifications:
9644 content:
9645 application/json:
9646 schema:
9647 $ref: '#/components/schemas/VnfPkgInfoModifications'
9648 application/yaml:
9649 schema:
9650 $ref: '#/components/schemas/VnfPkgInfoModifications'
9651 VnfPackage:
9652 content:
9653 application/zip:
9654 schema:
9655 $ref: '#/components/schemas/VnfPackage'
delacruzramfb52ade2019-10-07 16:46:59 +02009656 VnfDescriptor:
garciadeblas63fe88c2018-02-28 19:32:41 +01009657 content:
delacruzramfb52ade2019-10-07 16:46:59 +02009658 text/plain:
garciadeblas63fe88c2018-02-28 19:32:41 +01009659 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02009660 $ref: '#/components/schemas/VnfDescriptor'
delacruzramaf79f3c2019-10-22 13:13:01 +02009661 # CreateNsRequest:
9662 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +01009663 InstantiateNsRequest:
9664 content:
9665 application/json:
9666 schema:
9667 $ref: '#/components/schemas/InstantiateNsRequest'
9668 application/yaml:
9669 schema:
9670 $ref: '#/components/schemas/InstantiateNsRequest'
garciadeblasb5a065f2022-02-11 00:27:47 +01009671 HealNsRequest:
9672 content:
9673 application/json:
9674 schema:
9675 $ref: '#/components/schemas/HealNsRequest'
9676 application/yaml:
9677 schema:
9678 $ref: '#/components/schemas/HealNsRequest'
elumalai4b120f12022-04-28 16:44:35 +05309679 NSinstanceMigrateRequest:
9680 content:
9681 application/json:
9682 schema:
9683 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9684 application/yaml:
9685 schema:
9686 $ref: '#/components/schemas/NSinstanceMigrateRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01009687 ScaleNsRequest:
9688 content:
9689 application/json:
9690 schema:
9691 $ref: '#/components/schemas/ScaleNsRequest'
9692 application/yaml:
9693 schema:
9694 $ref: '#/components/schemas/ScaleNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01009695 TerminateNsRequest:
9696 content:
9697 application/json:
9698 schema:
9699 $ref: '#/components/schemas/TerminateNsRequest'
9700 application/yaml:
9701 schema:
9702 $ref: '#/components/schemas/TerminateNsRequest'
elumalaif2eb5e72022-03-21 19:44:39 +05309703 UpdateNsRequest:
9704 content:
9705 application/json:
9706 schema:
9707 $ref: '#/components/schemas/UpdateNsRequest'
9708 application/yaml:
9709 schema:
9710 $ref: '#/components/schemas/UpdateNsRequest'
adurtiafd75092024-05-31 14:52:18 +05309711 MultiNsTerminateRequest:
9712 content:
9713 application/json:
9714 schema:
9715 $ref: '#/components/schemas/MultiNsTerminateRequest'
9716 application/yaml:
9717 schema:
9718 $ref: '#/components/schemas/MultiNsTerminateRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009719 # CreateNSinstanceContentRequest:
9720 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +02009721 CreateNstInfoRequest:
9722 content:
9723 application/json:
9724 schema:
9725 $ref: '#/components/schemas/CreateNstInfoRequest'
9726 application/yaml:
9727 schema:
9728 $ref: '#/components/schemas/CreateNstInfoRequest'
9729 NetSliceTemplate:
9730 content:
9731 text/plain:
9732 schema:
9733 $ref: '#/components/schemas/NetSliceTemplate'
9734 NetSlicePackage:
9735 content:
9736 application/zip:
9737 schema:
9738 $ref: '#/components/schemas/NetSlicePackage'
9739 NstInfoModifications:
9740 content:
9741 application/json:
9742 schema:
9743 $ref: '#/components/schemas/NstInfoModifications'
9744 application/yaml:
9745 schema:
9746 $ref: '#/components/schemas/NstInfoModifications'
delacruzramaf79f3c2019-10-22 13:13:01 +02009747 # CreateNsiRequest:
9748 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02009749 InstantiateNsiRequest:
9750 content:
9751 application/json:
9752 schema:
9753 $ref: '#/components/schemas/InstantiateNsiRequest'
9754 application/yaml:
9755 schema:
9756 $ref: '#/components/schemas/InstantiateNsiRequest'
9757 TerminateNsiRequest:
9758 content:
9759 application/json:
9760 schema:
9761 $ref: '#/components/schemas/TerminateNsiRequest'
9762 application/yaml:
9763 schema:
9764 $ref: '#/components/schemas/TerminateNsiRequest'
9765 NsiActionRequest:
9766 content:
9767 application/json:
9768 schema:
9769 $ref: '#/components/schemas/NsiActionRequest'
9770 application/yaml:
9771 schema:
9772 $ref: '#/components/schemas/NsiActionRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009773 # CreateNsiContentRequest:
9774 # Substituted by InstantiateNsiRequest
9775 CreateTokenRequest:
delacruzramfb52ade2019-10-07 16:46:59 +02009776 content:
9777 application/json:
9778 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02009779 $ref: '#/components/schemas/CreateTokenRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02009780 application/yaml:
9781 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02009782 $ref: '#/components/schemas/CreateTokenRequest'
9783 CreateUserRequest:
9784 content:
9785 application/json:
9786 schema:
9787 $ref: '#/components/schemas/CreateUserRequest'
9788 application/yaml:
9789 schema:
9790 $ref: '#/components/schemas/CreateUserRequest'
9791 EditUserRequest:
9792 content:
9793 application/json:
9794 schema:
9795 $ref: '#/components/schemas/EditUserRequest'
9796 application/yaml:
9797 schema:
9798 $ref: '#/components/schemas/EditUserRequest'
9799 CreateProjectRequest:
9800 content:
9801 application/json:
9802 schema:
9803 $ref: '#/components/schemas/CreateProjectRequest'
9804 application/yaml:
9805 schema:
9806 $ref: '#/components/schemas/CreateProjectRequest'
9807 EditProjectRequest:
9808 content:
9809 application/json:
9810 schema:
9811 $ref: '#/components/schemas/EditProjectRequest'
9812 application/yaml:
9813 schema:
9814 $ref: '#/components/schemas/EditProjectRequest'
9815 CreateRoleRequest:
9816 content:
9817 application/json:
9818 schema:
9819 $ref: '#/components/schemas/CreateRoleRequest'
9820 application/yaml:
9821 schema:
9822 $ref: '#/components/schemas/CreateRoleRequest'
9823 EditRoleRequest:
9824 content:
9825 application/json:
9826 schema:
9827 $ref: '#/components/schemas/EditRoleRequest'
9828 application/yaml:
9829 schema:
9830 $ref: '#/components/schemas/EditRoleRequest'
9831 CreateVimRequest:
9832 content:
9833 application/json:
9834 schema:
9835 $ref: '#/components/schemas/CreateVimRequest'
9836 application/yaml:
9837 schema:
9838 $ref: '#/components/schemas/CreateVimRequest'
9839 EditVimRequest:
9840 content:
9841 application/json:
9842 schema:
9843 $ref: '#/components/schemas/EditVimRequest'
9844 application/yaml:
9845 schema:
9846 $ref: '#/components/schemas/EditVimRequest'
9847 CreateWimRequest:
9848 content:
9849 application/json:
9850 schema:
9851 $ref: '#/components/schemas/CreateWimRequest'
9852 application/yaml:
9853 schema:
9854 $ref: '#/components/schemas/CreateWimRequest'
9855 EditWimRequest:
9856 content:
9857 application/json:
9858 schema:
9859 $ref: '#/components/schemas/EditWimRequest'
9860 application/yaml:
9861 schema:
9862 $ref: '#/components/schemas/EditWimRequest'
9863 CreateSdnRequest:
9864 content:
9865 application/json:
9866 schema:
9867 $ref: '#/components/schemas/CreateSdnRequest'
9868 application/yaml:
9869 schema:
9870 $ref: '#/components/schemas/CreateSdnRequest'
9871 EditSdnRequest:
9872 content:
9873 application/json:
9874 schema:
9875 $ref: '#/components/schemas/EditSdnRequest'
9876 application/yaml:
9877 schema:
9878 $ref: '#/components/schemas/EditSdnRequest'
9879 CreatePduRequest:
9880 content:
9881 application/json:
9882 schema:
9883 $ref: '#/components/schemas/CreatePduRequest'
9884 application/yaml:
9885 schema:
9886 $ref: '#/components/schemas/CreatePduRequest'
9887 EditPduRequest:
9888 content:
9889 application/json:
9890 schema:
9891 $ref: '#/components/schemas/EditPduRequest'
9892 application/yaml:
9893 schema:
9894 $ref: '#/components/schemas/EditPduRequest'
9895 CreateK8sClusterRequest:
9896 content:
9897 application/json:
9898 schema:
9899 $ref: '#/components/schemas/CreateK8sClusterRequest'
9900 application/yaml:
9901 schema:
9902 $ref: '#/components/schemas/CreateK8sClusterRequest'
9903 EditK8sClusterRequest:
9904 content:
9905 application/json:
9906 schema:
9907 $ref: '#/components/schemas/EditK8sClusterRequest'
9908 application/yaml:
9909 schema:
9910 $ref: '#/components/schemas/EditK8sClusterRequest'
David Garciaaf38fce2021-05-04 12:48:04 +02009911 CreateVcaRequest:
9912 content:
9913 application/json:
9914 schema:
9915 $ref: '#/components/schemas/CreateVcaRequest'
9916 application/yaml:
9917 schema:
9918 $ref: '#/components/schemas/CreateVcaRequest'
9919 EditVcaRequest:
9920 content:
9921 application/json:
9922 schema:
9923 $ref: '#/components/schemas/EditVcaRequest'
9924 application/yaml:
9925 schema:
9926 $ref: '#/components/schemas/EditVcaRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009927 CreateK8sRepoRequest:
9928 content:
9929 application/json:
9930 schema:
9931 $ref: '#/components/schemas/CreateK8sRepoRequest'
9932 application/yaml:
9933 schema:
9934 $ref: '#/components/schemas/CreateK8sRepoRequest'
preethika.p31b3a802020-07-28 09:14:01 +00009935 NslcmSubscriptionRequest:
9936 content:
9937 application/json:
9938 schema:
9939 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9940 application/yaml:
9941 schema:
9942 $ref: '#/components/schemas/NslcmSubscriptionRequest'
Gabriel Cuba2c8be082023-11-14 16:52:01 -05009943 CancelNSLCMOpOccRequest:
9944 content:
9945 application/json:
9946 schema:
9947 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
9948 application/yaml:
9949 schema:
9950 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02009951 # END REQUEST BODIES
9952
garciadeblas60e2ee92018-02-27 19:09:51 +01009953 securitySchemes:
9954 bearerAuth:
9955 type: http
9956 scheme: bearer