blob: b9dc2dbd6026dede645862e6b5396d5ff0d31a84 [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'
delacruzramfb52ade2019-10-07 16:46:59 +02002182 '/nslcm/v1/ns_instances_content':
2183 get:
2184 tags:
2185 - "NS instances"
2186 summary: Query information about multiple NS instances
2187 description: Query information about multiple NS isntances
2188 operationId: getNSinstancesContent
2189 responses:
2190 '200':
2191 description: OK
2192 content:
2193 application/json:
2194 schema:
2195 $ref: '#/components/schemas/ArrayOfNsInstance'
2196 application/yaml:
2197 schema:
2198 $ref: '#/components/schemas/ArrayOfNsInstance'
2199 '400':
2200 $ref: '#/components/responses/BadRequest'
2201 '401':
2202 $ref: '#/components/responses/Unauthorized'
2203 '403':
2204 $ref: '#/components/responses/Forbidden'
2205 '404':
2206 $ref: '#/components/responses/NotFound'
2207 '405':
2208 $ref: '#/components/responses/MethodNotAllowed'
2209 '406':
2210 $ref: '#/components/responses/NotAcceptable'
2211 '409':
2212 $ref: '#/components/responses/Conflict'
2213 '422':
2214 $ref: '#/components/responses/UnprocessableEntity'
2215 '500':
2216 $ref: '#/components/responses/InternalServerError'
2217 '503':
2218 $ref: '#/components/responses/ServiceUnavailable'
2219 '5XX':
2220 $ref: '#/components/responses/UnexpectedError'
2221 default:
2222 $ref: '#/components/responses/UnexpectedError'
2223 post:
2224 tags:
2225 - "NS instances"
2226 summary: Create a new NS instance
2227 description: Create a new NS instance
2228 operationId: createNSinstanceContent
2229 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02002230 $ref: '#/components/requestBodies/InstantiateNsRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02002231 responses:
2232 '201':
2233 description: Created
2234 headers:
2235 Location:
2236 schema:
2237 type: string
2238 format: uri
2239 content:
2240 application/json:
2241 schema:
2242 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2243 application/yaml:
2244 schema:
2245 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2246 '400':
2247 $ref: '#/components/responses/BadRequest'
2248 '401':
2249 $ref: '#/components/responses/Unauthorized'
2250 '403':
2251 $ref: '#/components/responses/Forbidden'
2252 '404':
2253 $ref: '#/components/responses/NotFound'
2254 '405':
2255 $ref: '#/components/responses/MethodNotAllowed'
2256 '406':
2257 $ref: '#/components/responses/NotAcceptable'
2258 '409':
2259 $ref: '#/components/responses/Conflict'
2260 '422':
2261 $ref: '#/components/responses/UnprocessableEntity'
2262 '500':
2263 $ref: '#/components/responses/InternalServerError'
2264 '503':
2265 $ref: '#/components/responses/ServiceUnavailable'
2266 '5XX':
2267 $ref: '#/components/responses/UnexpectedError'
2268 default:
2269 $ref: '#/components/responses/UnexpectedError'
2270 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
2271 parameters:
2272 - name: nsInstanceContentId
2273 in: path
2274 required: true
2275 description: NS Instance Content ID
2276 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002277 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002278 get:
2279 tags:
2280 - "NS instances"
2281 summary: Read an individual NS instance resource
2282 description: Read an individual NS instance resource
2283 operationId: getNSinstanceContent
2284 responses:
2285 '200':
2286 description: OK
2287 content:
2288 application/json:
2289 schema:
2290 $ref: '#/components/schemas/NsInstance'
2291 application/yaml:
2292 schema:
2293 $ref: '#/components/schemas/NsInstance'
2294 '400':
2295 $ref: '#/components/responses/BadRequest'
2296 '401':
2297 $ref: '#/components/responses/Unauthorized'
2298 '403':
2299 $ref: '#/components/responses/Forbidden'
2300 '404':
2301 $ref: '#/components/responses/NotFound'
2302 '405':
2303 $ref: '#/components/responses/MethodNotAllowed'
2304 '406':
2305 $ref: '#/components/responses/NotAcceptable'
2306 '409':
2307 $ref: '#/components/responses/Conflict'
2308 '422':
2309 $ref: '#/components/responses/UnprocessableEntity'
2310 '500':
2311 $ref: '#/components/responses/InternalServerError'
2312 '503':
2313 $ref: '#/components/responses/ServiceUnavailable'
2314 '5XX':
2315 $ref: '#/components/responses/UnexpectedError'
2316 default:
2317 $ref: '#/components/responses/UnexpectedError'
2318 delete:
2319 tags:
2320 - "NS instances"
2321 summary: Delete an individual NS instance resource
2322 description: Delete an individual NS instance resource
2323 operationId: deleteNSinstanceContent
2324 responses:
2325 '202':
2326 description: Accepted
2327 content:
2328 application/json:
2329 schema:
2330 $ref: '#/components/schemas/ObjectId'
2331 application/yaml:
2332 schema:
2333 $ref: '#/components/schemas/ObjectId'
2334 '204':
2335 description: No Content
2336 '400':
2337 $ref: '#/components/responses/BadRequest'
2338 '401':
2339 $ref: '#/components/responses/Unauthorized'
2340 '403':
2341 $ref: '#/components/responses/Forbidden'
2342 '404':
2343 $ref: '#/components/responses/NotFound'
2344 '405':
2345 $ref: '#/components/responses/MethodNotAllowed'
2346 '406':
2347 $ref: '#/components/responses/NotAcceptable'
2348 '409':
2349 $ref: '#/components/responses/Conflict'
2350 '422':
2351 $ref: '#/components/responses/UnprocessableEntity'
2352 '500':
2353 $ref: '#/components/responses/InternalServerError'
2354 '503':
2355 $ref: '#/components/responses/ServiceUnavailable'
2356 '5XX':
2357 $ref: '#/components/responses/UnexpectedError'
2358 default:
2359 $ref: '#/components/responses/UnexpectedError'
2360 '/nslcm/v1/ns_lcm_op_occs':
2361 get:
2362 tags:
2363 - "NS instances"
2364 summary: Query information about multiple NS LCM Operation Occurrences
2365 description: Query information about multiple NS LCM Operation Occurrences
2366 operationId: getNSLCMOpOccs
2367 responses:
2368 '200':
2369 description: OK
2370 content:
2371 application/json:
2372 schema:
2373 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2374 application/yaml:
2375 schema:
2376 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2377 '400':
2378 $ref: '#/components/responses/BadRequest'
2379 '401':
2380 $ref: '#/components/responses/Unauthorized'
2381 '403':
2382 $ref: '#/components/responses/Forbidden'
2383 '404':
2384 $ref: '#/components/responses/NotFound'
2385 '405':
2386 $ref: '#/components/responses/MethodNotAllowed'
2387 '406':
2388 $ref: '#/components/responses/NotAcceptable'
2389 '409':
2390 $ref: '#/components/responses/Conflict'
2391 '422':
2392 $ref: '#/components/responses/UnprocessableEntity'
2393 '500':
2394 $ref: '#/components/responses/InternalServerError'
2395 '503':
2396 $ref: '#/components/responses/ServiceUnavailable'
2397 '5XX':
2398 $ref: '#/components/responses/UnexpectedError'
2399 default:
2400 $ref: '#/components/responses/UnexpectedError'
2401 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2402 parameters:
2403 - name: nsLcmOpOccId
2404 in: path
2405 required: true
2406 description: NS LCM Operation Occurrence ID
2407 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002408 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002409 get:
2410 tags:
2411 - "NS instances"
2412 summary: Query information about an individual NS LCM Operation Occurrence
2413 description: Query information about an individual NS LCM Operation Occurrence
2414 operationId: getNSLCMOpOcc
2415 responses:
2416 '200':
2417 description: OK
2418 content:
2419 application/json:
2420 schema:
2421 $ref: '#/components/schemas/NsLcmOpOcc'
2422 application/yaml:
2423 schema:
2424 $ref: '#/components/schemas/NsLcmOpOcc'
2425 '400':
2426 $ref: '#/components/responses/BadRequest'
2427 '401':
2428 $ref: '#/components/responses/Unauthorized'
2429 '403':
2430 $ref: '#/components/responses/Forbidden'
2431 '404':
2432 $ref: '#/components/responses/NotFound'
2433 '405':
2434 $ref: '#/components/responses/MethodNotAllowed'
2435 '406':
2436 $ref: '#/components/responses/NotAcceptable'
2437 '409':
2438 $ref: '#/components/responses/Conflict'
2439 '422':
2440 $ref: '#/components/responses/UnprocessableEntity'
2441 '500':
2442 $ref: '#/components/responses/InternalServerError'
2443 '503':
2444 $ref: '#/components/responses/ServiceUnavailable'
2445 '5XX':
2446 $ref: '#/components/responses/UnexpectedError'
2447 default:
2448 $ref: '#/components/responses/UnexpectedError'
Gabriel Cuba2c8be082023-11-14 16:52:01 -05002449 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
2450 parameters:
2451 - name: nsLcmOpOccId
2452 in: path
2453 required: true
2454 description: NS LCM Operation Occurrence ID
2455 schema:
2456 type: string
2457 post:
2458 tags:
2459 - "NS instances"
2460 summary: Cancel an ongoing NS lifecycle management operation
2461 description: Cancel an ongoing NS lifecycle management operation while it is being executed or rolled back
2462 operationId: cancelNSLCMOpOcc
2463 requestBody:
2464 $ref: '#/components/requestBodies/CancelNSLCMOpOccRequest'
2465 responses:
2466 '202':
2467 description: Accepted
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'
delacruzramfb52ade2019-10-07 16:46:59 +02002492 '/nslcm/v1/vnf_instances':
2493 get:
2494 tags:
2495 - "NS instances"
2496 summary: Query information about multiple VNF Instances
2497 description: Query information about multiple VNF Instances
2498 operationId: getVnfInstances
2499 responses:
2500 '200':
2501 description: OK
2502 content:
2503 application/json:
2504 schema:
2505 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2506 application/yaml:
2507 schema:
2508 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2509 '400':
2510 $ref: '#/components/responses/BadRequest'
2511 '401':
2512 $ref: '#/components/responses/Unauthorized'
2513 '403':
2514 $ref: '#/components/responses/Forbidden'
2515 '404':
2516 $ref: '#/components/responses/NotFound'
2517 '405':
2518 $ref: '#/components/responses/MethodNotAllowed'
2519 '406':
2520 $ref: '#/components/responses/NotAcceptable'
2521 '409':
2522 $ref: '#/components/responses/Conflict'
2523 '422':
2524 $ref: '#/components/responses/UnprocessableEntity'
2525 '500':
2526 $ref: '#/components/responses/InternalServerError'
2527 '503':
2528 $ref: '#/components/responses/ServiceUnavailable'
2529 '5XX':
2530 $ref: '#/components/responses/UnexpectedError'
2531 default:
2532 $ref: '#/components/responses/UnexpectedError'
2533 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2534 parameters:
2535 - name: vnfInstanceId
2536 in: path
2537 required: true
2538 description: VNF Instance ID
2539 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002540 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002541 get:
2542 tags:
2543 - "NS instances"
2544 summary: Query information about an individual VNF Instance
2545 description: Query information about an individual VNF Instance
2546 operationId: getVnfInstance
2547 responses:
2548 '200':
2549 description: OK
2550 content:
2551 application/json:
2552 schema:
2553 $ref: '#/components/schemas/VnfInstanceInfo'
2554 application/yaml:
2555 schema:
2556 $ref: '#/components/schemas/VnfInstanceInfo'
2557 '400':
2558 $ref: '#/components/responses/BadRequest'
2559 '401':
2560 $ref: '#/components/responses/Unauthorized'
2561 '403':
2562 $ref: '#/components/responses/Forbidden'
2563 '404':
2564 $ref: '#/components/responses/NotFound'
2565 '405':
2566 $ref: '#/components/responses/MethodNotAllowed'
2567 '406':
2568 $ref: '#/components/responses/NotAcceptable'
2569 '409':
2570 $ref: '#/components/responses/Conflict'
2571 '422':
2572 $ref: '#/components/responses/UnprocessableEntity'
2573 '500':
2574 $ref: '#/components/responses/InternalServerError'
2575 '503':
2576 $ref: '#/components/responses/ServiceUnavailable'
2577 '5XX':
2578 $ref: '#/components/responses/UnexpectedError'
2579 default:
2580 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +01002581 '/nslcm/v1/subscriptions':
preethika.p31b3a802020-07-28 09:14:01 +00002582 get:
2583 tags:
2584 - NS instances
2585 summary: Query information about multiple NS instance subscription
2586 description: Query information about multiple NS instance subscription
2587 operationId: getNsSubcriptions
2588 responses:
2589 '200':
2590 description: OK
2591 content:
2592 application/json:
2593 schema:
2594 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2595 application/yaml:
2596 schema:
2597 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2598 '400':
2599 $ref: '#/components/responses/BadRequest'
2600 '401':
2601 $ref: '#/components/responses/Unauthorized'
2602 '403':
2603 $ref: '#/components/responses/Forbidden'
2604 '404':
2605 $ref: '#/components/responses/NotFound'
2606 '405':
2607 $ref: '#/components/responses/MethodNotAllowed'
2608 '406':
2609 $ref: '#/components/responses/NotAcceptable'
2610 '409':
2611 $ref: '#/components/responses/Conflict'
2612 '422':
2613 $ref: '#/components/responses/UnprocessableEntity'
2614 '500':
2615 $ref: '#/components/responses/InternalServerError'
2616 '503':
2617 $ref: '#/components/responses/ServiceUnavailable'
2618 5XX:
2619 $ref: '#/components/responses/UnexpectedError'
2620 default:
2621 $ref: '#/components/responses/UnexpectedError'
2622 post:
2623 tags:
2624 - NS instances
2625 summary: Create a new subscription for the Network service
2626 description: Create a new subscription for the Network service
2627 operationId: addNsSubcriptions
2628 requestBody:
2629 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2630 responses:
2631 '201':
2632 description: Created
2633 headers:
2634 Location:
2635 schema:
2636 type: object
2637 content:
2638 application/json:
2639 schema:
2640 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2641 application/yaml:
2642 schema:
2643 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2644 '400':
2645 $ref: '#/components/responses/BadRequest'
2646 '401':
2647 $ref: '#/components/responses/Unauthorized'
2648 '403':
2649 $ref: '#/components/responses/Forbidden'
2650 '404':
2651 $ref: '#/components/responses/NotFound'
2652 '405':
2653 $ref: '#/components/responses/MethodNotAllowed'
2654 '406':
2655 $ref: '#/components/responses/NotAcceptable'
2656 '409':
2657 $ref: '#/components/responses/Conflict'
2658 '422':
2659 $ref: '#/components/responses/UnprocessableEntity'
2660 '500':
2661 $ref: '#/components/responses/InternalServerError'
2662 '503':
2663 $ref: '#/components/responses/ServiceUnavailable'
2664 5XX:
2665 $ref: '#/components/responses/UnexpectedError'
2666 default:
2667 $ref: '#/components/responses/UnexpectedError'
2668 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2669 parameters:
2670 - name: nsSubscriptionsId
2671 in: path
2672 required: true
2673 description: Network Service Subscription ID
2674 schema:
2675 type: string
2676 get:
2677 tags:
2678 - NS instances
2679 summary: Read information about an individual Network Service Subscription
2680 description: Read information about an individual Network Service Subscription
2681 operationId: getNsSubcriptionId
2682 responses:
2683 '200':
2684 description: OK
2685 content:
2686 application/json:
2687 schema:
2688 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2689 application/yaml:
2690 schema:
2691 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2692 '400':
2693 $ref: '#/components/responses/BadRequest'
2694 '401':
2695 $ref: '#/components/responses/Unauthorized'
2696 '403':
2697 $ref: '#/components/responses/Forbidden'
2698 '404':
2699 $ref: '#/components/responses/NotFound'
2700 '405':
2701 $ref: '#/components/responses/MethodNotAllowed'
2702 '406':
2703 $ref: '#/components/responses/NotAcceptable'
2704 '409':
2705 $ref: '#/components/responses/Conflict'
2706 '422':
2707 $ref: '#/components/responses/UnprocessableEntity'
2708 '500':
2709 $ref: '#/components/responses/InternalServerError'
2710 '503':
2711 $ref: '#/components/responses/ServiceUnavailable'
2712 5XX:
2713 $ref: '#/components/responses/UnexpectedError'
2714 default:
2715 $ref: '#/components/responses/UnexpectedError'
2716 delete:
2717 tags:
2718 - NS instances
2719 summary: Delete an individual Network Service Subscription
2720 description: Delete an individual Network Service Subscription
2721 operationId: deleteNsSubcriptionId
2722 responses:
2723 '204':
2724 description: No Content
2725 '400':
2726 $ref: '#/components/responses/BadRequest'
2727 '401':
2728 $ref: '#/components/responses/Unauthorized'
2729 '403':
2730 $ref: '#/components/responses/Forbidden'
2731 '404':
2732 $ref: '#/components/responses/NotFound'
2733 '405':
2734 $ref: '#/components/responses/MethodNotAllowed'
2735 '406':
2736 $ref: '#/components/responses/NotAcceptable'
2737 '409':
2738 $ref: '#/components/responses/Conflict'
2739 '422':
2740 $ref: '#/components/responses/UnprocessableEntity'
2741 '500':
2742 $ref: '#/components/responses/InternalServerError'
2743 '503':
2744 $ref: '#/components/responses/ServiceUnavailable'
2745 5XX:
2746 $ref: '#/components/responses/UnexpectedError'
2747 default:
2748 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002749# END NS Instances
2750
Atul Agarwal4cd9e952021-05-20 09:24:26 +00002751# BEGIN Alarms
2752 '/nsfm/v1/alarms':
2753 get:
2754 tags:
2755 - "Alarms"
2756 summary: Query information about multiple alarms
2757 description: Query information about multiple alarms
2758 operationId: getAlarms
2759 responses:
2760 '200':
2761 description: OK
2762 content:
2763 application/json:
2764 schema:
2765 $ref: '#/components/schemas/ArrayOfAlarm'
2766 application/yaml:
2767 schema:
2768 $ref: '#/components/schemas/ArrayOfAlarm'
2769 '400':
2770 $ref: '#/components/responses/BadRequest'
2771 '401':
2772 $ref: '#/components/responses/Unauthorized'
2773 '403':
2774 $ref: '#/components/responses/Forbidden'
2775 '404':
2776 $ref: '#/components/responses/NotFound'
2777 '405':
2778 $ref: '#/components/responses/MethodNotAllowed'
2779 '406':
2780 $ref: '#/components/responses/NotAcceptable'
2781 '409':
2782 $ref: '#/components/responses/Conflict'
2783 '422':
2784 $ref: '#/components/responses/UnprocessableEntity'
2785 '500':
2786 $ref: '#/components/responses/InternalServerError'
2787 '503':
2788 $ref: '#/components/responses/ServiceUnavailable'
2789 '5XX':
2790 $ref: '#/components/responses/UnexpectedError'
2791 default:
2792 $ref: '#/components/responses/UnexpectedError'
2793 '/nsfm/v1/alarms/{uuid}':
2794 parameters:
2795 - name: uuid
2796 in: path
2797 required: true
2798 description: Alarm UUID
2799 schema:
2800 type: string
2801 get:
2802 tags:
2803 - "Alarms"
2804 summary: Read an individual Alarm
2805 description: Read an individual Alarm
2806 operationId: getAlarm
2807 responses:
2808 '200':
2809 description: OK
2810 content:
2811 application/json:
2812 schema:
2813 $ref: '#/components/schemas/Alarm'
2814 application/yaml:
2815 schema:
2816 $ref: '#/components/schemas/Alarm'
2817 '400':
2818 $ref: '#/components/responses/BadRequest'
2819 '401':
2820 $ref: '#/components/responses/Unauthorized'
2821 '403':
2822 $ref: '#/components/responses/Forbidden'
2823 '404':
2824 $ref: '#/components/responses/NotFound'
2825 '405':
2826 $ref: '#/components/responses/MethodNotAllowed'
2827 '406':
2828 $ref: '#/components/responses/NotAcceptable'
2829 '409':
2830 $ref: '#/components/responses/Conflict'
2831 '422':
2832 $ref: '#/components/responses/UnprocessableEntity'
2833 '500':
2834 $ref: '#/components/responses/InternalServerError'
2835 '503':
2836 $ref: '#/components/responses/ServiceUnavailable'
2837 '5XX':
2838 $ref: '#/components/responses/UnexpectedError'
2839 default:
2840 $ref: '#/components/responses/UnexpectedError'
2841 patch:
2842 tags:
2843 - "Alarms"
2844 summary: Modify the data of an individual Alarm
2845 description: Modify the data of an individual Alarm
2846 operationId: updateAlarm
2847 requestBody:
2848 $ref: '#/components/requestBodies/AlarmInfoModifications'
2849 responses:
2850 '204':
2851 description: No Content
2852 '400':
2853 $ref: '#/components/responses/BadRequest'
2854 '401':
2855 $ref: '#/components/responses/Unauthorized'
2856 '403':
2857 $ref: '#/components/responses/Forbidden'
2858 '404':
2859 $ref: '#/components/responses/NotFound'
2860 '405':
2861 $ref: '#/components/responses/MethodNotAllowed'
2862 '406':
2863 $ref: '#/components/responses/NotAcceptable'
2864 '409':
2865 $ref: '#/components/responses/Conflict'
2866 '422':
2867 $ref: '#/components/responses/UnprocessableEntity'
2868 '500':
2869 $ref: '#/components/responses/InternalServerError'
2870 '503':
2871 $ref: '#/components/responses/ServiceUnavailable'
2872 '5XX':
2873 $ref: '#/components/responses/UnexpectedError'
2874 default:
2875 $ref: '#/components/responses/UnexpectedError'
2876# END Alarms
2877
delacruzramfb52ade2019-10-07 16:46:59 +02002878# BEGIN NetSlice Templates
2879 '/nst/v1/netslice_templates':
2880 get:
2881 tags:
2882 - "NetSlice templates"
2883 summary: Query information about multiple NetSlice template resources
2884 description: Query information about multiple NetSlice template resources
2885 operationId: getNSTs
2886 responses:
2887 '200':
2888 description: OK
2889 content:
2890 application/json:
2891 schema:
2892 $ref: '#/components/schemas/ArrayOfNstInfo'
2893 application/yaml:
2894 schema:
2895 $ref: '#/components/schemas/ArrayOfNstInfo'
2896 '400':
2897 $ref: '#/components/responses/BadRequest'
2898 '401':
2899 $ref: '#/components/responses/Unauthorized'
2900 '403':
2901 $ref: '#/components/responses/Forbidden'
2902 '404':
2903 $ref: '#/components/responses/NotFound'
2904 '405':
2905 $ref: '#/components/responses/MethodNotAllowed'
2906 '406':
2907 $ref: '#/components/responses/NotAcceptable'
2908 '409':
2909 $ref: '#/components/responses/Conflict'
2910 '422':
2911 $ref: '#/components/responses/UnprocessableEntity'
2912 '500':
2913 $ref: '#/components/responses/InternalServerError'
2914 '503':
2915 $ref: '#/components/responses/ServiceUnavailable'
2916 '5XX':
2917 $ref: '#/components/responses/UnexpectedError'
2918 default:
2919 $ref: '#/components/responses/UnexpectedError'
2920 post:
2921 tags:
2922 - "NetSlice templates"
2923 summary: Create a new NetSlice template resource
2924 description: Create a new NetSlice template resource
2925 operationId: addNST
2926 requestBody:
2927 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2928 responses:
2929 '201':
2930 description: Created
2931 headers:
2932 Location:
2933 schema:
2934 type: string
2935 format: uri
2936 content:
2937 application/json:
2938 schema:
2939 $ref: '#/components/schemas/ObjectId'
2940 application/yaml:
2941 schema:
2942 $ref: '#/components/schemas/ObjectId'
2943 '400':
2944 $ref: '#/components/responses/BadRequest'
2945 '401':
2946 $ref: '#/components/responses/Unauthorized'
2947 '403':
2948 $ref: '#/components/responses/Forbidden'
2949 '404':
2950 $ref: '#/components/responses/NotFound'
2951 '405':
2952 $ref: '#/components/responses/MethodNotAllowed'
2953 '406':
2954 $ref: '#/components/responses/NotAcceptable'
2955 '409':
2956 $ref: '#/components/responses/Conflict'
2957 '422':
2958 $ref: '#/components/responses/UnprocessableEntity'
2959 '500':
2960 $ref: '#/components/responses/InternalServerError'
2961 '503':
2962 $ref: '#/components/responses/ServiceUnavailable'
2963 '5XX':
2964 $ref: '#/components/responses/UnexpectedError'
2965 default:
2966 $ref: '#/components/responses/UnexpectedError'
2967 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2968 parameters:
2969 - name: netsliceTemplateId
2970 in: path
2971 required: true
2972 description: NetSlice Template ID
2973 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002974 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002975 get:
2976 tags:
2977 - "NetSlice templates"
2978 summary: Read information about an individual NetSlice template resource
2979 description: Read information about an individual NetSlice template resource
2980 operationId: getNST
2981 responses:
2982 '200':
2983 description: OK
2984 content:
2985 application/json:
2986 schema:
2987 $ref: '#/components/schemas/NstInfo'
2988 application/yaml:
2989 schema:
2990 $ref: '#/components/schemas/NstInfo'
2991 '400':
2992 $ref: '#/components/responses/BadRequest'
2993 '401':
2994 $ref: '#/components/responses/Unauthorized'
2995 '403':
2996 $ref: '#/components/responses/Forbidden'
2997 '404':
2998 $ref: '#/components/responses/NotFound'
2999 '405':
3000 $ref: '#/components/responses/MethodNotAllowed'
3001 '406':
3002 $ref: '#/components/responses/NotAcceptable'
3003 '409':
3004 $ref: '#/components/responses/Conflict'
3005 '422':
3006 $ref: '#/components/responses/UnprocessableEntity'
3007 '500':
3008 $ref: '#/components/responses/InternalServerError'
3009 '503':
3010 $ref: '#/components/responses/ServiceUnavailable'
3011 '5XX':
3012 $ref: '#/components/responses/UnexpectedError'
3013 default:
3014 $ref: '#/components/responses/UnexpectedError'
3015 delete:
3016 tags:
3017 - "NetSlice templates"
3018 summary: Delete an individual NetSlice template resource
3019 description: Delete an individual NetSlice template resource
3020 operationId: deleteNST
3021 responses:
3022 '204':
3023 description: No Content
3024 '400':
3025 $ref: '#/components/responses/BadRequest'
3026 '401':
3027 $ref: '#/components/responses/Unauthorized'
3028 '403':
3029 $ref: '#/components/responses/Forbidden'
3030 '404':
3031 $ref: '#/components/responses/NotFound'
3032 '405':
3033 $ref: '#/components/responses/MethodNotAllowed'
3034 '406':
3035 $ref: '#/components/responses/NotAcceptable'
3036 '409':
3037 $ref: '#/components/responses/Conflict'
3038 '422':
3039 $ref: '#/components/responses/UnprocessableEntity'
3040 '500':
3041 $ref: '#/components/responses/InternalServerError'
3042 '503':
3043 $ref: '#/components/responses/ServiceUnavailable'
3044 '5XX':
3045 $ref: '#/components/responses/UnexpectedError'
3046 default:
3047 $ref: '#/components/responses/UnexpectedError'
3048 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
3049 parameters:
3050 - name: netsliceTemplateId
3051 in: path
3052 required: true
3053 description: NetSlice Template ID
3054 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003055 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003056 - name: artifactPath
3057 in: path
3058 required: true
3059 description: Artifact Path
3060 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003061 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003062 get:
3063 tags:
3064 - "NetSlice templates"
3065 summary: Fetch individual NetSlice Template artifact
3066 description: Fetch individual NetSlice Template artifact
3067 operationId: getNstArtifact
3068 responses:
3069 '200':
3070 description: OK
3071 content:
3072 application/octet-stream:
3073 schema:
3074 type: string
3075 format: binary
3076 '206':
3077 description: Partial Content
3078 headers:
3079 Content-Range:
3080 schema:
3081 type: string
3082 content:
3083 application/octet-stream:
3084 schema:
3085 type: string
3086 format: binary
3087 '400':
3088 $ref: '#/components/responses/BadRequest'
3089 '401':
3090 $ref: '#/components/responses/Unauthorized'
3091 '403':
3092 $ref: '#/components/responses/Forbidden'
3093 '404':
3094 $ref: '#/components/responses/NotFound'
3095 '405':
3096 $ref: '#/components/responses/MethodNotAllowed'
3097 '406':
3098 $ref: '#/components/responses/NotAcceptable'
3099 '409':
3100 $ref: '#/components/responses/Conflict'
3101 '422':
3102 $ref: '#/components/responses/UnprocessableEntity'
3103 '500':
3104 $ref: '#/components/responses/InternalServerError'
3105 '503':
3106 $ref: '#/components/responses/ServiceUnavailable'
3107 '5XX':
3108 $ref: '#/components/responses/UnexpectedError'
3109 default:
3110 $ref: '#/components/responses/UnexpectedError'
3111 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
3112 parameters:
3113 - name: netsliceTemplateId
3114 in: path
3115 required: true
3116 description: NetSlice Template ID
3117 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003118 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003119 get:
3120 tags:
3121 - "NetSlice templates"
3122 summary: Read NST of an on-boarded NetSlice Template
3123 description: Read NST of an on-boarded NetSlice Template
3124 operationId: getNstNst
3125 responses:
3126 '200':
3127 description: OK
3128 content:
3129 text/plain:
3130 schema:
3131 $ref: '#/components/schemas/NetSliceTemplate'
3132 '400':
3133 $ref: '#/components/responses/BadRequest'
3134 '401':
3135 $ref: '#/components/responses/Unauthorized'
3136 '403':
3137 $ref: '#/components/responses/Forbidden'
3138 '404':
3139 $ref: '#/components/responses/NotFound'
3140 '405':
3141 $ref: '#/components/responses/MethodNotAllowed'
3142 '406':
3143 $ref: '#/components/responses/NotAcceptable'
3144 '409':
3145 $ref: '#/components/responses/Conflict'
3146 '422':
3147 $ref: '#/components/responses/UnprocessableEntity'
3148 '500':
3149 $ref: '#/components/responses/InternalServerError'
3150 '503':
3151 $ref: '#/components/responses/ServiceUnavailable'
3152 '5XX':
3153 $ref: '#/components/responses/UnexpectedError'
3154 default:
3155 $ref: '#/components/responses/UnexpectedError'
3156 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
3157 parameters:
3158 - name: netsliceTemplateId
3159 in: path
3160 required: true
3161 description: NetSlice Template ID
3162 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003163 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003164 get:
3165 tags:
3166 - "NetSlice templates"
3167 summary: Fetch the content of a NST
3168 description: Fetch the content of a NST
3169 operationId: getNSTcontent
3170 responses:
3171 '200':
3172 description: OK
3173 content:
3174 application/zip:
3175 schema:
3176 $ref: '#/components/schemas/NetSlicePackage'
3177 '206':
3178 description: Partial Content
3179 headers:
3180 Content-Range:
3181 schema:
3182 type: string
3183 content:
3184 application/zip:
3185 schema:
3186 $ref: '#/components/schemas/NetSlicePackage'
3187 '400':
3188 $ref: '#/components/responses/BadRequest'
3189 '401':
3190 $ref: '#/components/responses/Unauthorized'
3191 '403':
3192 $ref: '#/components/responses/Forbidden'
3193 '404':
3194 $ref: '#/components/responses/NotFound'
3195 '405':
3196 $ref: '#/components/responses/MethodNotAllowed'
3197 '406':
3198 $ref: '#/components/responses/NotAcceptable'
3199 '409':
3200 $ref: '#/components/responses/Conflict'
3201 '422':
3202 $ref: '#/components/responses/UnprocessableEntity'
3203 '500':
3204 $ref: '#/components/responses/InternalServerError'
3205 '503':
3206 $ref: '#/components/responses/ServiceUnavailable'
3207 '5XX':
3208 $ref: '#/components/responses/UnexpectedError'
3209 default:
3210 $ref: '#/components/responses/UnexpectedError'
3211 put:
3212 tags:
3213 - "NetSlice templates"
3214 summary: Upload the content of a NST
3215 description: Upload the content of a NST
3216 operationId: updateNSTcontent
3217 requestBody:
3218 $ref: '#/components/requestBodies/NetSlicePackage'
3219 responses:
3220 '202':
3221 description: Accepted
3222 '204':
3223 description: No Content
3224 '400':
3225 $ref: '#/components/responses/BadRequest'
3226 '401':
3227 $ref: '#/components/responses/Unauthorized'
3228 '403':
3229 $ref: '#/components/responses/Forbidden'
3230 '404':
3231 $ref: '#/components/responses/NotFound'
3232 '405':
3233 $ref: '#/components/responses/MethodNotAllowed'
3234 '406':
3235 $ref: '#/components/responses/NotAcceptable'
3236 '409':
3237 $ref: '#/components/responses/Conflict'
3238 '422':
3239 $ref: '#/components/responses/UnprocessableEntity'
3240 '500':
3241 $ref: '#/components/responses/InternalServerError'
3242 '503':
3243 $ref: '#/components/responses/ServiceUnavailable'
3244 '5XX':
3245 $ref: '#/components/responses/UnexpectedError'
3246 default:
3247 $ref: '#/components/responses/UnexpectedError'
3248 '/nst/v1/netslice_templates_content':
3249 post:
3250 tags:
3251 - "NetSlice templates"
3252 summary: Upload a NetSlice package by providing the content of the NetSlice package
3253 description: Upload a NetSlice package by providing the content of the NetSlice package
3254 operationId: uploadNstContent
3255 requestBody:
3256 content:
3257 application/zip:
3258 schema:
3259 $ref: '#/components/schemas/NetSlicePackage'
3260 responses:
3261 '201':
3262 description: Created
3263 headers:
3264 Location:
3265 schema:
3266 type: string
3267 format: uri
3268 content:
3269 application/json:
3270 schema:
3271 $ref: '#/components/schemas/ObjectId'
3272 application/yaml:
3273 schema:
3274 $ref: '#/components/schemas/ObjectId'
3275 '202':
3276 description: Accepted
3277 '204':
3278 description: No Content
3279 '400':
3280 $ref: '#/components/responses/BadRequest'
3281 '401':
3282 $ref: '#/components/responses/Unauthorized'
3283 '403':
3284 $ref: '#/components/responses/Forbidden'
3285 '404':
3286 $ref: '#/components/responses/NotFound'
3287 '405':
3288 $ref: '#/components/responses/MethodNotAllowed'
3289 '406':
3290 $ref: '#/components/responses/NotAcceptable'
3291 '409':
3292 $ref: '#/components/responses/Conflict'
3293 '422':
3294 $ref: '#/components/responses/UnprocessableEntity'
3295 '500':
3296 $ref: '#/components/responses/InternalServerError'
3297 '503':
3298 $ref: '#/components/responses/ServiceUnavailable'
3299 '5XX':
3300 $ref: '#/components/responses/UnexpectedError'
3301 default:
3302 $ref: '#/components/responses/UnexpectedError'
3303 get:
3304 tags:
3305 - "NetSlice templates"
3306 summary: Query information about multiple NetSlice Template resources
3307 description: Query information about multiple NetSlice Template resources
3308 operationId: getNstContent
3309 responses:
3310 '200':
3311 description: OK
3312 content:
3313 application/json:
3314 schema:
3315 $ref: '#/components/schemas/ArrayOfNstInfo'
3316 application/yaml:
3317 schema:
3318 $ref: '#/components/schemas/ArrayOfNstInfo'
3319 '206':
3320 description: Partial Content
3321 headers:
3322 Content-Range:
3323 schema:
3324 type: string
3325 content:
3326 application/octet-stream:
3327 schema:
3328 type: string
3329 format: binary
3330 '400':
3331 $ref: '#/components/responses/BadRequest'
3332 '401':
3333 $ref: '#/components/responses/Unauthorized'
3334 '403':
3335 $ref: '#/components/responses/Forbidden'
3336 '404':
3337 $ref: '#/components/responses/NotFound'
3338 '405':
3339 $ref: '#/components/responses/MethodNotAllowed'
3340 '406':
3341 $ref: '#/components/responses/NotAcceptable'
3342 '409':
3343 $ref: '#/components/responses/Conflict'
3344 '422':
3345 $ref: '#/components/responses/UnprocessableEntity'
3346 '500':
3347 $ref: '#/components/responses/InternalServerError'
3348 '503':
3349 $ref: '#/components/responses/ServiceUnavailable'
3350 '5XX':
3351 $ref: '#/components/responses/UnexpectedError'
3352 default:
3353 $ref: '#/components/responses/UnexpectedError'
3354 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
3355 parameters:
3356 - name: netsliceTemplateContentId
3357 in: path
3358 required: true
3359 description: NetSlice Template ID
3360 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003361 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003362 get:
3363 tags:
3364 - "NetSlice templates"
3365 summary: Read information about an individual NetSlice Template resource
3366 description: Read information about an individual NetSlice Template resource
3367 operationId: getNstIdContent
3368 responses:
3369 '200':
3370 description: OK
3371 content:
3372 application/json:
3373 schema:
3374 $ref: '#/components/schemas/NstInfo'
3375 application/yaml:
3376 schema:
3377 $ref: '#/components/schemas/NstInfo'
3378 '400':
3379 $ref: '#/components/responses/BadRequest'
3380 '401':
3381 $ref: '#/components/responses/Unauthorized'
3382 '403':
3383 $ref: '#/components/responses/Forbidden'
3384 '404':
3385 $ref: '#/components/responses/NotFound'
3386 '405':
3387 $ref: '#/components/responses/MethodNotAllowed'
3388 '406':
3389 $ref: '#/components/responses/NotAcceptable'
3390 '409':
3391 $ref: '#/components/responses/Conflict'
3392 '422':
3393 $ref: '#/components/responses/UnprocessableEntity'
3394 '500':
3395 $ref: '#/components/responses/InternalServerError'
3396 '503':
3397 $ref: '#/components/responses/ServiceUnavailable'
3398 '5XX':
3399 $ref: '#/components/responses/UnexpectedError'
3400 default:
3401 $ref: '#/components/responses/UnexpectedError'
3402 put:
3403 tags:
3404 - "NetSlice templates"
3405 summary: Modify an individual NetSlice Template resource
3406 description: Modify an individual NetSlice Template resource
3407 operationId: updateNstIdContent
3408 requestBody:
3409 $ref: '#/components/requestBodies/NstInfoModifications'
3410 responses:
3411 '204':
3412 description: No Content
3413 '400':
3414 $ref: '#/components/responses/BadRequest'
3415 '401':
3416 $ref: '#/components/responses/Unauthorized'
3417 '403':
3418 $ref: '#/components/responses/Forbidden'
3419 '404':
3420 $ref: '#/components/responses/NotFound'
3421 '405':
3422 $ref: '#/components/responses/MethodNotAllowed'
3423 '406':
3424 $ref: '#/components/responses/NotAcceptable'
3425 '409':
3426 $ref: '#/components/responses/Conflict'
3427 '422':
3428 $ref: '#/components/responses/UnprocessableEntity'
3429 '500':
3430 $ref: '#/components/responses/InternalServerError'
3431 '503':
3432 $ref: '#/components/responses/ServiceUnavailable'
3433 '5XX':
3434 $ref: '#/components/responses/UnexpectedError'
3435 default:
3436 $ref: '#/components/responses/UnexpectedError'
3437 delete:
3438 tags:
3439 - "NetSlice templates"
3440 summary: Delete an individual NetSlice Template resource
3441 description: Delete an individual NetSlice Template resource
3442 operationId: deleteNstIdContent
3443 responses:
3444 '204':
3445 description: No Content
3446 '400':
3447 $ref: '#/components/responses/BadRequest'
3448 '401':
3449 $ref: '#/components/responses/Unauthorized'
3450 '403':
3451 $ref: '#/components/responses/Forbidden'
3452 '404':
3453 $ref: '#/components/responses/NotFound'
3454 '405':
3455 $ref: '#/components/responses/MethodNotAllowed'
3456 '406':
3457 $ref: '#/components/responses/NotAcceptable'
3458 '409':
3459 $ref: '#/components/responses/Conflict'
3460 '422':
3461 $ref: '#/components/responses/UnprocessableEntity'
3462 '500':
3463 $ref: '#/components/responses/InternalServerError'
3464 '503':
3465 $ref: '#/components/responses/ServiceUnavailable'
3466 '5XX':
3467 $ref: '#/components/responses/UnexpectedError'
3468 default:
3469 $ref: '#/components/responses/UnexpectedError'
3470# END NetSlice Templates
3471
3472# BEGIN NetSlice Instances
3473 '/nsilcm/v1/netslice_instances':
3474 get:
3475 tags:
3476 - "NetSlice instances"
3477 summary: Query information about multiple NetSlice instances
3478 description: Query information about multiple NetSlice isntances
3479 operationId: getNSIs
3480 responses:
3481 '200':
3482 description: OK
3483 content:
3484 application/json:
3485 schema:
3486 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3487 application/yaml:
3488 schema:
3489 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3490 '400':
3491 $ref: '#/components/responses/BadRequest'
3492 '401':
3493 $ref: '#/components/responses/Unauthorized'
3494 '403':
3495 $ref: '#/components/responses/Forbidden'
3496 '404':
3497 $ref: '#/components/responses/NotFound'
3498 '405':
3499 $ref: '#/components/responses/MethodNotAllowed'
3500 '406':
3501 $ref: '#/components/responses/NotAcceptable'
3502 '409':
3503 $ref: '#/components/responses/Conflict'
3504 '422':
3505 $ref: '#/components/responses/UnprocessableEntity'
3506 '500':
3507 $ref: '#/components/responses/InternalServerError'
3508 '503':
3509 $ref: '#/components/responses/ServiceUnavailable'
3510 '5XX':
3511 $ref: '#/components/responses/UnexpectedError'
3512 default:
3513 $ref: '#/components/responses/UnexpectedError'
3514 post:
3515 tags:
3516 - "NetSlice instances"
3517 summary: Create a new NetSlice instance resource
3518 description: Create a new NetSlice instance resource
3519 operationId: addNSI
3520 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02003521 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02003522 responses:
3523 '201':
3524 description: Created
3525 headers:
3526 Location:
3527 schema:
3528 type: string
3529 format: uri
3530 content:
3531 application/json:
3532 schema:
3533 $ref: '#/components/schemas/ObjectId'
3534 application/yaml:
3535 schema:
3536 $ref: '#/components/schemas/ObjectId'
3537 '400':
3538 $ref: '#/components/responses/BadRequest'
3539 '401':
3540 $ref: '#/components/responses/Unauthorized'
3541 '403':
3542 $ref: '#/components/responses/Forbidden'
3543 '404':
3544 $ref: '#/components/responses/NotFound'
3545 '405':
3546 $ref: '#/components/responses/MethodNotAllowed'
3547 '406':
3548 $ref: '#/components/responses/NotAcceptable'
3549 '409':
3550 $ref: '#/components/responses/Conflict'
3551 '422':
3552 $ref: '#/components/responses/UnprocessableEntity'
3553 '500':
3554 $ref: '#/components/responses/InternalServerError'
3555 '503':
3556 $ref: '#/components/responses/ServiceUnavailable'
3557 '5XX':
3558 $ref: '#/components/responses/UnexpectedError'
3559 default:
3560 $ref: '#/components/responses/UnexpectedError'
3561 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3562 parameters:
3563 - name: netsliceInstanceId
3564 in: path
3565 required: true
3566 description: NetSlice Instance ID
3567 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003568 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003569 get:
3570 tags:
3571 - "NetSlice instances"
3572 summary: Read an individual NetSlice instance resource
3573 description: Read an individual NetSlice instance resource
3574 operationId: getNSI
3575 responses:
3576 '200':
3577 description: OK
3578 content:
3579 application/json:
3580 schema:
3581 $ref: '#/components/schemas/NetSliceInstance'
3582 application/yaml:
3583 schema:
3584 $ref: '#/components/schemas/NetSliceInstance'
3585 '400':
3586 $ref: '#/components/responses/BadRequest'
3587 '401':
3588 $ref: '#/components/responses/Unauthorized'
3589 '403':
3590 $ref: '#/components/responses/Forbidden'
3591 '404':
3592 $ref: '#/components/responses/NotFound'
3593 '405':
3594 $ref: '#/components/responses/MethodNotAllowed'
3595 '406':
3596 $ref: '#/components/responses/NotAcceptable'
3597 '409':
3598 $ref: '#/components/responses/Conflict'
3599 '422':
3600 $ref: '#/components/responses/UnprocessableEntity'
3601 '500':
3602 $ref: '#/components/responses/InternalServerError'
3603 '503':
3604 $ref: '#/components/responses/ServiceUnavailable'
3605 '5XX':
3606 $ref: '#/components/responses/UnexpectedError'
3607 default:
3608 $ref: '#/components/responses/UnexpectedError'
3609 delete:
3610 tags:
3611 - "NetSlice instances"
3612 summary: Delete an individual NetSlice instance resource
3613 description: Delete an individual NetSlice instance resource
3614 operationId: deleteNSI
3615 responses:
3616 '204':
3617 description: No Content
3618 '400':
3619 $ref: '#/components/responses/BadRequest'
3620 '401':
3621 $ref: '#/components/responses/Unauthorized'
3622 '403':
3623 $ref: '#/components/responses/Forbidden'
3624 '404':
3625 $ref: '#/components/responses/NotFound'
3626 '405':
3627 $ref: '#/components/responses/MethodNotAllowed'
3628 '406':
3629 $ref: '#/components/responses/NotAcceptable'
3630 '409':
3631 $ref: '#/components/responses/Conflict'
3632 '422':
3633 $ref: '#/components/responses/UnprocessableEntity'
3634 '500':
3635 $ref: '#/components/responses/InternalServerError'
3636 '503':
3637 $ref: '#/components/responses/ServiceUnavailable'
3638 '5XX':
3639 $ref: '#/components/responses/UnexpectedError'
3640 default:
3641 $ref: '#/components/responses/UnexpectedError'
3642 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3643 parameters:
3644 - name: netsliceInstanceId
3645 in: path
3646 required: true
3647 description: NetSlice Instance ID
3648 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003649 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003650 post:
3651 tags:
3652 - "NetSlice instances"
3653 summary: Instantiate a NetSlice
3654 description: |
3655 Instantiate a NetSlice. The precondition is that the NetSlice instance
3656 must have been created and must be in NOT_INSTANTIATED state. As a result
3657 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3658 Operation Occurrence" resource for the request, and the NS instance state
3659 becomes INSTANTIATED.
3660 operationId: instantiateNSI
3661 requestBody:
3662 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3663 responses:
3664 '202':
3665 description: Accepted
3666 headers:
3667 Location:
3668 description: |
3669 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3670 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3671 schema:
3672 type: string
3673 format: uri
3674 content:
3675 application/json:
3676 schema:
3677 $ref: '#/components/schemas/ObjectId'
3678 application/yaml:
3679 schema:
3680 $ref: '#/components/schemas/ObjectId'
3681 '400':
3682 $ref: '#/components/responses/BadRequest'
3683 '401':
3684 $ref: '#/components/responses/Unauthorized'
3685 '403':
3686 $ref: '#/components/responses/Forbidden'
3687 '404':
3688 $ref: '#/components/responses/NotFound'
3689 '405':
3690 $ref: '#/components/responses/MethodNotAllowed'
3691 '406':
3692 $ref: '#/components/responses/NotAcceptable'
3693 '409':
3694 $ref: '#/components/responses/Conflict'
3695 '422':
3696 $ref: '#/components/responses/UnprocessableEntity'
3697 '500':
3698 $ref: '#/components/responses/InternalServerError'
3699 '503':
3700 $ref: '#/components/responses/ServiceUnavailable'
3701 '5XX':
3702 $ref: '#/components/responses/UnexpectedError'
3703 default:
3704 $ref: '#/components/responses/UnexpectedError'
3705 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3706 parameters:
3707 - name: netsliceInstanceId
3708 in: path
3709 required: true
3710 description: NetSlice Instance ID
3711 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003712 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003713 post:
3714 tags:
3715 - "NetSlice instances"
3716 summary: Terminate a NetSlice instance
3717 description: |
3718 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3719 must have been created and must be in INSTANTIATED state. As a result of the
3720 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3721 Occurrence" resource for the request, and the NetSlice instance state becomes
3722 NOT_INSTANTIATED.
3723 operationId: terminateNSI
3724 requestBody:
3725 # Request data is not required
3726 $ref: '#/components/requestBodies/TerminateNsiRequest'
3727 responses:
3728 '202':
3729 description: Accepted
3730 headers:
3731 Location:
3732 description: |
3733 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3734 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3735 schema:
3736 type: string
3737 format: uri
3738 content:
3739 application/json:
3740 schema:
3741 $ref: '#/components/schemas/ObjectId'
3742 application/yaml:
3743 schema:
3744 $ref: '#/components/schemas/ObjectId'
3745 '400':
3746 $ref: '#/components/responses/BadRequest'
3747 '401':
3748 $ref: '#/components/responses/Unauthorized'
3749 '403':
3750 $ref: '#/components/responses/Forbidden'
3751 '404':
3752 $ref: '#/components/responses/NotFound'
3753 '405':
3754 $ref: '#/components/responses/MethodNotAllowed'
3755 '406':
3756 $ref: '#/components/responses/NotAcceptable'
3757 '409':
3758 $ref: '#/components/responses/Conflict'
3759 '422':
3760 $ref: '#/components/responses/UnprocessableEntity'
3761 '500':
3762 $ref: '#/components/responses/InternalServerError'
3763 '503':
3764 $ref: '#/components/responses/ServiceUnavailable'
3765 '5XX':
3766 $ref: '#/components/responses/UnexpectedError'
3767 default:
3768 $ref: '#/components/responses/UnexpectedError'
3769 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3770 parameters:
3771 - name: netsliceInstanceId
3772 in: path
3773 required: true
3774 description: NetSlice Instance ID
3775 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003776 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003777 post:
3778 tags:
3779 - "NetSlice instances"
3780 summary: Execute an action on a NetSlice instance
3781 description: |
3782 Execute an action on a NetSlice instance.
3783 The NetSlice instance must have been created and must be in INSTANTIATED state.
3784 operationId: actionOnNSI
3785 requestBody:
3786 content:
3787 application/json:
3788 schema:
3789 $ref: '#/components/schemas/NsiActionRequest'
3790 application/yaml:
3791 schema:
3792 $ref: '#/components/schemas/NsiActionRequest'
3793 responses:
3794 '202':
3795 description: Accepted
3796 headers:
3797 Location:
3798 description: |
3799 It must point to the new "NS Lifecycle Operation Occurrence"
3800 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3801 schema:
3802 type: string
3803 format: uri
3804 content:
3805 application/json:
3806 schema:
3807 $ref: '#/components/schemas/ObjectId'
3808 application/yaml:
3809 schema:
3810 $ref: '#/components/schemas/ObjectId'
3811 '400':
3812 $ref: '#/components/responses/BadRequest'
3813 '401':
3814 $ref: '#/components/responses/Unauthorized'
3815 '403':
3816 $ref: '#/components/responses/Forbidden'
3817 '404':
3818 $ref: '#/components/responses/NotFound'
3819 '405':
3820 $ref: '#/components/responses/MethodNotAllowed'
3821 '406':
3822 $ref: '#/components/responses/NotAcceptable'
3823 '409':
3824 $ref: '#/components/responses/Conflict'
3825 '422':
3826 $ref: '#/components/responses/UnprocessableEntity'
3827 '500':
3828 $ref: '#/components/responses/InternalServerError'
3829 '503':
3830 $ref: '#/components/responses/ServiceUnavailable'
3831 '5XX':
3832 $ref: '#/components/responses/UnexpectedError'
3833 default:
3834 $ref: '#/components/responses/UnexpectedError'
3835 '/nsilcm/v1/netslice_instances_content':
3836 get:
3837 tags:
3838 - "NetSlice instances"
3839 summary: Query information about multiple NetSlice instances
3840 description: Query information about multiple NetSlice isntances
3841 operationId: getNSIsContent
3842 responses:
3843 '200':
3844 description: OK
3845 content:
3846 application/json:
3847 schema:
3848 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3849 application/yaml:
3850 schema:
3851 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3852 '400':
3853 $ref: '#/components/responses/BadRequest'
3854 '401':
3855 $ref: '#/components/responses/Unauthorized'
3856 '403':
3857 $ref: '#/components/responses/Forbidden'
3858 '404':
3859 $ref: '#/components/responses/NotFound'
3860 '405':
3861 $ref: '#/components/responses/MethodNotAllowed'
3862 '406':
3863 $ref: '#/components/responses/NotAcceptable'
3864 '409':
3865 $ref: '#/components/responses/Conflict'
3866 '422':
3867 $ref: '#/components/responses/UnprocessableEntity'
3868 '500':
3869 $ref: '#/components/responses/InternalServerError'
3870 '503':
3871 $ref: '#/components/responses/ServiceUnavailable'
3872 '5XX':
3873 $ref: '#/components/responses/UnexpectedError'
3874 default:
3875 $ref: '#/components/responses/UnexpectedError'
3876 post:
3877 tags:
3878 - "NetSlice instances"
3879 summary: Create a new NetSlice instance
3880 description: Create a new NetSlice instance
3881 operationId: createNSIContent
3882 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02003883 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02003884 responses:
3885 '201':
3886 description: Created
3887 headers:
3888 Location:
3889 schema:
3890 type: string
3891 format: uri
3892 content:
3893 application/json:
3894 schema:
3895 $ref: '#/components/schemas/CreateNsiContentResponse'
3896 application/yaml:
3897 schema:
3898 $ref: '#/components/schemas/CreateNsiContentResponse'
3899 '400':
3900 $ref: '#/components/responses/BadRequest'
3901 '401':
3902 $ref: '#/components/responses/Unauthorized'
3903 '403':
3904 $ref: '#/components/responses/Forbidden'
3905 '404':
3906 $ref: '#/components/responses/NotFound'
3907 '405':
3908 $ref: '#/components/responses/MethodNotAllowed'
3909 '406':
3910 $ref: '#/components/responses/NotAcceptable'
3911 '409':
3912 $ref: '#/components/responses/Conflict'
3913 '422':
3914 $ref: '#/components/responses/UnprocessableEntity'
3915 '500':
3916 $ref: '#/components/responses/InternalServerError'
3917 '503':
3918 $ref: '#/components/responses/ServiceUnavailable'
3919 '5XX':
3920 $ref: '#/components/responses/UnexpectedError'
3921 default:
3922 $ref: '#/components/responses/UnexpectedError'
3923 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3924 parameters:
3925 - name: netsliceInstanceContentId
3926 in: path
3927 required: true
3928 description: NetSlice Instance Content ID
3929 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003930 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003931 get:
3932 tags:
3933 - "NetSlice instances"
3934 summary: Read an individual NetSlice instance resource
3935 description: Read an individual NetSlice instance resource
3936 operationId: getNSIContent
3937 responses:
3938 '200':
3939 description: OK
3940 content:
3941 application/json:
3942 schema:
3943 $ref: '#/components/schemas/NetSliceInstance'
3944 application/yaml:
3945 schema:
3946 $ref: '#/components/schemas/NetSliceInstance'
3947 '400':
3948 $ref: '#/components/responses/BadRequest'
3949 '401':
3950 $ref: '#/components/responses/Unauthorized'
3951 '403':
3952 $ref: '#/components/responses/Forbidden'
3953 '404':
3954 $ref: '#/components/responses/NotFound'
3955 '405':
3956 $ref: '#/components/responses/MethodNotAllowed'
3957 '406':
3958 $ref: '#/components/responses/NotAcceptable'
3959 '409':
3960 $ref: '#/components/responses/Conflict'
3961 '422':
3962 $ref: '#/components/responses/UnprocessableEntity'
3963 '500':
3964 $ref: '#/components/responses/InternalServerError'
3965 '503':
3966 $ref: '#/components/responses/ServiceUnavailable'
3967 '5XX':
3968 $ref: '#/components/responses/UnexpectedError'
3969 default:
3970 $ref: '#/components/responses/UnexpectedError'
3971 delete:
3972 tags:
3973 - "NetSlice instances"
3974 summary: Delete an individual NS instance resource
3975 description: Delete an individual NS instance resource
3976 operationId: deleteNSIContent
3977 responses:
3978 '202':
3979 description: Accepted
3980 content:
3981 application/json:
3982 schema:
3983 $ref: '#/components/schemas/ObjectId'
3984 application/yaml:
3985 schema:
3986 $ref: '#/components/schemas/ObjectId'
3987 '204':
3988 description: No Content
3989 '400':
3990 $ref: '#/components/responses/BadRequest'
3991 '401':
3992 $ref: '#/components/responses/Unauthorized'
3993 '403':
3994 $ref: '#/components/responses/Forbidden'
3995 '404':
3996 $ref: '#/components/responses/NotFound'
3997 '405':
3998 $ref: '#/components/responses/MethodNotAllowed'
3999 '406':
4000 $ref: '#/components/responses/NotAcceptable'
4001 '409':
4002 $ref: '#/components/responses/Conflict'
4003 '422':
4004 $ref: '#/components/responses/UnprocessableEntity'
4005 '500':
4006 $ref: '#/components/responses/InternalServerError'
4007 '503':
4008 $ref: '#/components/responses/ServiceUnavailable'
4009 '5XX':
4010 $ref: '#/components/responses/UnexpectedError'
4011 default:
4012 $ref: '#/components/responses/UnexpectedError'
4013 '/nsilcm/v1/nsi_lcm_op_occs':
4014 get:
4015 tags:
4016 - "NetSlice instances"
4017 summary: Query information about multiple NetSlice LCM Operation Occurrences
4018 description: Query information about multiple NetSlice LCM Operation Occurrences
4019 operationId: getNsiLcmOpOccs
4020 responses:
4021 '200':
4022 description: OK
4023 content:
4024 application/json:
4025 schema:
4026 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
4027 application/yaml:
4028 schema:
4029 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
4030 '400':
4031 $ref: '#/components/responses/BadRequest'
4032 '401':
4033 $ref: '#/components/responses/Unauthorized'
4034 '403':
4035 $ref: '#/components/responses/Forbidden'
4036 '404':
4037 $ref: '#/components/responses/NotFound'
4038 '405':
4039 $ref: '#/components/responses/MethodNotAllowed'
4040 '406':
4041 $ref: '#/components/responses/NotAcceptable'
4042 '409':
4043 $ref: '#/components/responses/Conflict'
4044 '422':
4045 $ref: '#/components/responses/UnprocessableEntity'
4046 '500':
4047 $ref: '#/components/responses/InternalServerError'
4048 '503':
4049 $ref: '#/components/responses/ServiceUnavailable'
4050 '5XX':
4051 $ref: '#/components/responses/UnexpectedError'
4052 default:
4053 $ref: '#/components/responses/UnexpectedError'
4054 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
4055 parameters:
4056 - name: nsiLcmOpOccId
4057 in: path
4058 required: true
4059 description: NetSlice LCM Operation Occurrence ID
4060 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02004061 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02004062 get:
4063 tags:
4064 - "NetSlice instances"
4065 summary: Query information about an individual NetSlice LCM Operation Occurrence
4066 description: Query information about an individual NetSlice LCM Operation Occurrence
4067 operationId: getNsiLcmOpOcc
4068 responses:
4069 '200':
4070 description: OK
4071 content:
4072 application/json:
4073 schema:
4074 $ref: '#/components/schemas/NsiLcmOpOcc'
4075 application/yaml:
4076 schema:
4077 $ref: '#/components/schemas/NsiLcmOpOcc'
4078 '400':
4079 $ref: '#/components/responses/BadRequest'
4080 '401':
4081 $ref: '#/components/responses/Unauthorized'
4082 '403':
4083 $ref: '#/components/responses/Forbidden'
4084 '404':
4085 $ref: '#/components/responses/NotFound'
4086 '405':
4087 $ref: '#/components/responses/MethodNotAllowed'
4088 '406':
4089 $ref: '#/components/responses/NotAcceptable'
4090 '409':
4091 $ref: '#/components/responses/Conflict'
4092 '422':
4093 $ref: '#/components/responses/UnprocessableEntity'
4094 '500':
4095 $ref: '#/components/responses/InternalServerError'
4096 '503':
4097 $ref: '#/components/responses/ServiceUnavailable'
4098 '5XX':
4099 $ref: '#/components/responses/UnexpectedError'
4100 default:
4101 $ref: '#/components/responses/UnexpectedError'
4102# END NetSlice Instances
4103
4104# BEGIN NSPM
delacruzramaf79f3c2019-10-22 13:13:01 +02004105 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
4106 parameters:
4107 - name: pmJobId
4108 in: path
4109 required: true
4110 description: NS PM Job ID
4111 schema:
4112 type: string
4113 - name: nsId
4114 in: path
4115 required: true
4116 description: NS ID
4117 schema:
4118 type: string
4119 get:
4120 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004121 - "NS Performance Management"
delacruzramaf79f3c2019-10-22 13:13:01 +02004122 summary: Query information about an individual NS PM Job Report
4123 description: Query information about an individual NS PM Job Report
4124 operationId: getNsPmJobReport
4125 responses:
4126 '200':
4127 description: OK
4128 content:
4129 application/json:
4130 schema:
4131 $ref: '#/components/schemas/NsPmJobReportInfo'
4132 application/yaml:
4133 schema:
4134 $ref: '#/components/schemas/NsPmJobReportInfo'
4135 '400':
4136 $ref: '#/components/responses/BadRequest'
4137 '401':
4138 $ref: '#/components/responses/Unauthorized'
4139 '403':
4140 $ref: '#/components/responses/Forbidden'
4141 '404':
4142 $ref: '#/components/responses/NotFound'
4143 '405':
4144 $ref: '#/components/responses/MethodNotAllowed'
4145 '406':
4146 $ref: '#/components/responses/NotAcceptable'
4147 '409':
4148 $ref: '#/components/responses/Conflict'
4149 '422':
4150 $ref: '#/components/responses/UnprocessableEntity'
4151 '500':
4152 $ref: '#/components/responses/InternalServerError'
4153 '503':
4154 $ref: '#/components/responses/ServiceUnavailable'
4155 '5XX':
4156 $ref: '#/components/responses/UnexpectedError'
4157 default:
4158 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02004159# END NSPM
4160
4161# BEGIN PDU
delacruzramaf79f3c2019-10-22 13:13:01 +02004162 '/pdu/v1/pdu_descriptors':
4163 get:
4164 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004165 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004166 summary: Query information about multiple PDU Descriptors
4167 description: Query information about multiple PDU Descriptors
4168 operationId: getPDUs
4169 responses:
4170 '200':
4171 description: OK
4172 content:
4173 application/json:
4174 schema:
4175 $ref: '#/components/schemas/ArrayOfPduInfo'
4176 application/yaml:
4177 schema:
4178 $ref: '#/components/schemas/ArrayOfPduInfo'
4179 '400':
4180 $ref: '#/components/responses/BadRequest'
4181 '401':
4182 $ref: '#/components/responses/Unauthorized'
4183 '403':
4184 $ref: '#/components/responses/Forbidden'
4185 '404':
4186 $ref: '#/components/responses/NotFound'
4187 '405':
4188 $ref: '#/components/responses/MethodNotAllowed'
4189 '406':
4190 $ref: '#/components/responses/NotAcceptable'
4191 '409':
4192 $ref: '#/components/responses/Conflict'
4193 '422':
4194 $ref: '#/components/responses/UnprocessableEntity'
4195 '500':
4196 $ref: '#/components/responses/InternalServerError'
4197 '503':
4198 $ref: '#/components/responses/ServiceUnavailable'
4199 '5XX':
4200 $ref: '#/components/responses/UnexpectedError'
4201 default:
4202 $ref: '#/components/responses/UnexpectedError'
4203 post:
4204 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004205 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004206 summary: Create a new PDU
4207 description: Create a new PDU Descriptor
4208 operationId: createPDU
4209 requestBody:
4210 $ref: '#/components/requestBodies/CreatePduRequest'
4211 responses:
4212 '200':
4213 description: OK
4214 headers:
4215 Location:
4216 schema:
4217 type: string
4218 format: uri
4219 content:
4220 application/json:
4221 schema:
4222 $ref: '#/components/schemas/ObjectId'
4223 application/yaml:
4224 schema:
4225 $ref: '#/components/schemas/ObjectId'
4226 '400':
4227 $ref: '#/components/responses/BadRequest'
4228 '401':
4229 $ref: '#/components/responses/Unauthorized'
4230 '403':
4231 $ref: '#/components/responses/Forbidden'
4232 '404':
4233 $ref: '#/components/responses/NotFound'
4234 '405':
4235 $ref: '#/components/responses/MethodNotAllowed'
4236 '406':
4237 $ref: '#/components/responses/NotAcceptable'
4238 '409':
4239 $ref: '#/components/responses/Conflict'
4240 '422':
4241 $ref: '#/components/responses/UnprocessableEntity'
4242 '500':
4243 $ref: '#/components/responses/InternalServerError'
4244 '503':
4245 $ref: '#/components/responses/ServiceUnavailable'
4246 '5XX':
4247 $ref: '#/components/responses/UnexpectedError'
4248 default:
4249 $ref: '#/components/responses/UnexpectedError'
4250 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
4251 parameters:
4252 - name: pduDescriptorId
4253 in: path
4254 required: true
4255 description: PDU Descriptor ID
4256 schema:
4257 type: string
4258 get:
4259 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004260 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004261 summary: Query information about an individual PDU Descriptor
4262 description: Query information about an individual PDU Descriptor
4263 operationId: getPDU
4264 responses:
4265 '200':
4266 description: OK
4267 content:
4268 application/json:
4269 schema:
4270 $ref: '#/components/schemas/PduInfo'
4271 application/yaml:
4272 schema:
4273 $ref: '#/components/schemas/PduInfo'
4274 '400':
4275 $ref: '#/components/responses/BadRequest'
4276 '401':
4277 $ref: '#/components/responses/Unauthorized'
4278 '403':
4279 $ref: '#/components/responses/Forbidden'
4280 '404':
4281 $ref: '#/components/responses/NotFound'
4282 '405':
4283 $ref: '#/components/responses/MethodNotAllowed'
4284 '406':
4285 $ref: '#/components/responses/NotAcceptable'
4286 '409':
4287 $ref: '#/components/responses/Conflict'
4288 '422':
4289 $ref: '#/components/responses/UnprocessableEntity'
4290 '500':
4291 $ref: '#/components/responses/InternalServerError'
4292 '503':
4293 $ref: '#/components/responses/ServiceUnavailable'
4294 '5XX':
4295 $ref: '#/components/responses/UnexpectedError'
4296 default:
4297 $ref: '#/components/responses/UnexpectedError'
4298 patch:
4299 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004300 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004301 summary: Modify an individual PDU Descriptor
4302 description: Modify an individual PDU Descriptor
4303 operationId: editPDU
4304 requestBody:
4305 $ref: '#/components/requestBodies/EditPduRequest'
4306 responses:
4307 '204':
4308 description: No Content
4309 '400':
4310 $ref: '#/components/responses/BadRequest'
4311 '401':
4312 $ref: '#/components/responses/Unauthorized'
4313 '403':
4314 $ref: '#/components/responses/Forbidden'
4315 '404':
4316 $ref: '#/components/responses/NotFound'
4317 '405':
4318 $ref: '#/components/responses/MethodNotAllowed'
4319 '406':
4320 $ref: '#/components/responses/NotAcceptable'
4321 '409':
4322 $ref: '#/components/responses/Conflict'
4323 '422':
4324 $ref: '#/components/responses/UnprocessableEntity'
4325 '500':
4326 $ref: '#/components/responses/InternalServerError'
4327 '503':
4328 $ref: '#/components/responses/ServiceUnavailable'
4329 '5XX':
4330 $ref: '#/components/responses/UnexpectedError'
4331 default:
4332 $ref: '#/components/responses/UnexpectedError'
4333 delete:
4334 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004335 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004336 summary: Delete an individual PDU Descriptor
4337 description: Delete an individual PDU Descriptor
4338 operationId: deletePDU
4339 responses:
4340 '204':
4341 description: No Content
4342 '400':
4343 $ref: '#/components/responses/BadRequest'
4344 '401':
4345 $ref: '#/components/responses/Unauthorized'
4346 '403':
4347 $ref: '#/components/responses/Forbidden'
4348 '404':
4349 $ref: '#/components/responses/NotFound'
4350 '405':
4351 $ref: '#/components/responses/MethodNotAllowed'
4352 '406':
4353 $ref: '#/components/responses/NotAcceptable'
4354 '409':
4355 $ref: '#/components/responses/Conflict'
4356 '422':
4357 $ref: '#/components/responses/UnprocessableEntity'
4358 '500':
4359 $ref: '#/components/responses/InternalServerError'
4360 '503':
4361 $ref: '#/components/responses/ServiceUnavailable'
4362 '5XX':
4363 $ref: '#/components/responses/UnexpectedError'
4364 default:
4365 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02004366# END PDU
4367
4368# BEGIN Admin
delacruzramaf79f3c2019-10-22 13:13:01 +02004369 '/admin/v1/tokens':
4370 get:
4371 tags:
garciadeblas77849982020-02-28 15:41:43 +01004372 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004373 - "Admin"
4374 summary: Query information about multiple Tokens
4375 description: Query information about multiple Tokens
4376 operationId: getTokens
4377 responses:
4378 '200':
4379 description: OK
4380 content:
4381 application/json:
4382 schema:
4383 $ref: '#/components/schemas/ArrayOfTokenInfo'
4384 application/yaml:
4385 schema:
4386 $ref: '#/components/schemas/ArrayOfTokenInfo'
4387 '400':
4388 $ref: '#/components/responses/BadRequest'
4389 '401':
4390 $ref: '#/components/responses/Unauthorized'
4391 '403':
4392 $ref: '#/components/responses/Forbidden'
4393 '404':
4394 $ref: '#/components/responses/NotFound'
4395 '405':
4396 $ref: '#/components/responses/MethodNotAllowed'
4397 '406':
4398 $ref: '#/components/responses/NotAcceptable'
4399 '409':
4400 $ref: '#/components/responses/Conflict'
4401 '422':
4402 $ref: '#/components/responses/UnprocessableEntity'
4403 '500':
4404 $ref: '#/components/responses/InternalServerError'
4405 '503':
4406 $ref: '#/components/responses/ServiceUnavailable'
4407 '5XX':
4408 $ref: '#/components/responses/UnexpectedError'
4409 default:
4410 $ref: '#/components/responses/UnexpectedError'
4411 post:
4412 tags:
garciadeblas77849982020-02-28 15:41:43 +01004413 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004414 - "Admin"
4415 summary: Request a new Token
4416 description: Request a new Token
4417 operationId: createToken
4418 requestBody:
4419 $ref: '#/components/requestBodies/CreateTokenRequest'
4420 responses:
4421 '200':
4422 description: OK
4423 headers:
4424 Location:
4425 schema:
4426 type: string
4427 format: uri
4428 content:
4429 application/json:
4430 schema:
selvi.ja6f638b2022-03-23 12:27:35 +00004431 oneOf:
4432 - $ref: '#/components/schemas/TokenInfo'
4433 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02004434 application/yaml:
4435 schema:
selvi.ja6f638b2022-03-23 12:27:35 +00004436 oneOf:
4437 - $ref: '#/components/schemas/TokenInfo'
4438 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02004439 '400':
4440 $ref: '#/components/responses/BadRequest'
4441 '401':
4442 $ref: '#/components/responses/Unauthorized'
4443 '403':
4444 $ref: '#/components/responses/Forbidden'
4445 '404':
4446 $ref: '#/components/responses/NotFound'
4447 '405':
4448 $ref: '#/components/responses/MethodNotAllowed'
4449 '406':
4450 $ref: '#/components/responses/NotAcceptable'
4451 '409':
4452 $ref: '#/components/responses/Conflict'
4453 '422':
4454 $ref: '#/components/responses/UnprocessableEntity'
4455 '500':
4456 $ref: '#/components/responses/InternalServerError'
4457 '503':
4458 $ref: '#/components/responses/ServiceUnavailable'
4459 '5XX':
4460 $ref: '#/components/responses/UnexpectedError'
4461 default:
4462 $ref: '#/components/responses/UnexpectedError'
4463 delete:
4464 tags:
garciadeblas77849982020-02-28 15:41:43 +01004465 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004466 - "Admin"
4467 summary: Delete the Token indicated in the Authorization Header
4468 description: Delete the Token indicated in the Authorization Header
4469 operationId: deleteAuthToken
4470 responses:
4471 '200':
4472 description: OK
4473 content:
4474 application/json:
4475 schema:
4476 type: string
4477 application/yaml:
4478 schema:
4479 type: string
4480 '400':
4481 $ref: '#/components/responses/BadRequest'
4482 '401':
4483 $ref: '#/components/responses/Unauthorized'
4484 '403':
4485 $ref: '#/components/responses/Forbidden'
4486 '404':
4487 $ref: '#/components/responses/NotFound'
4488 '405':
4489 $ref: '#/components/responses/MethodNotAllowed'
4490 '406':
4491 $ref: '#/components/responses/NotAcceptable'
4492 '409':
4493 $ref: '#/components/responses/Conflict'
4494 '422':
4495 $ref: '#/components/responses/UnprocessableEntity'
4496 '500':
4497 $ref: '#/components/responses/InternalServerError'
4498 '503':
4499 $ref: '#/components/responses/ServiceUnavailable'
4500 '5XX':
4501 $ref: '#/components/responses/UnexpectedError'
4502 default:
4503 $ref: '#/components/responses/UnexpectedError'
4504 '/admin/v1/tokens/{tokenId}':
4505 parameters:
4506 - name: tokenId
4507 in: path
4508 required: true
4509 description: Token ID
4510 schema:
4511 type: string
4512 get:
4513 tags:
garciadeblas77849982020-02-28 15:41:43 +01004514 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004515 - "Admin"
4516 summary: Query information about an individual Token
4517 description: Query information about an individual Token
4518 operationId: getToken
4519 responses:
4520 '200':
4521 description: OK
4522 content:
4523 application/json:
4524 schema:
4525 $ref: '#/components/schemas/TokenInfo'
4526 application/yaml:
4527 schema:
4528 $ref: '#/components/schemas/TokenInfo'
4529 '400':
4530 $ref: '#/components/responses/BadRequest'
4531 '401':
4532 $ref: '#/components/responses/Unauthorized'
4533 '403':
4534 $ref: '#/components/responses/Forbidden'
4535 '404':
4536 $ref: '#/components/responses/NotFound'
4537 '405':
4538 $ref: '#/components/responses/MethodNotAllowed'
4539 '406':
4540 $ref: '#/components/responses/NotAcceptable'
4541 '409':
4542 $ref: '#/components/responses/Conflict'
4543 '422':
4544 $ref: '#/components/responses/UnprocessableEntity'
4545 '500':
4546 $ref: '#/components/responses/InternalServerError'
4547 '503':
4548 $ref: '#/components/responses/ServiceUnavailable'
4549 '5XX':
4550 $ref: '#/components/responses/UnexpectedError'
4551 default:
4552 $ref: '#/components/responses/UnexpectedError'
4553 delete:
4554 tags:
garciadeblas77849982020-02-28 15:41:43 +01004555 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004556 - "Admin"
4557 summary: Delete the Token indicated as parameter
4558 description: Delete the Token indicated as parameter
4559 operationId: deleteToken
4560 responses:
4561 '200':
4562 description: OK
4563 content:
4564 application/json:
4565 schema:
4566 type: string
4567 application/yaml:
4568 schema:
4569 type: string
4570 '400':
4571 $ref: '#/components/responses/BadRequest'
4572 '401':
4573 $ref: '#/components/responses/Unauthorized'
4574 '403':
4575 $ref: '#/components/responses/Forbidden'
4576 '404':
4577 $ref: '#/components/responses/NotFound'
4578 '405':
4579 $ref: '#/components/responses/MethodNotAllowed'
4580 '406':
4581 $ref: '#/components/responses/NotAcceptable'
4582 '409':
4583 $ref: '#/components/responses/Conflict'
4584 '422':
4585 $ref: '#/components/responses/UnprocessableEntity'
4586 '500':
4587 $ref: '#/components/responses/InternalServerError'
4588 '503':
4589 $ref: '#/components/responses/ServiceUnavailable'
4590 '5XX':
4591 $ref: '#/components/responses/UnexpectedError'
4592 default:
4593 $ref: '#/components/responses/UnexpectedError'
4594 '/admin/v1/users':
4595 get:
4596 tags:
garciadeblas77849982020-02-28 15:41:43 +01004597 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004598 - "Admin"
4599 summary: Query information about multiple Users
4600 description: Query information about multiple Users
4601 operationId: getUsers
4602 responses:
4603 '200':
4604 description: OK
4605 content:
4606 application/json:
4607 schema:
4608 $ref: '#/components/schemas/ArrayOfUserInfo'
4609 application/yaml:
4610 schema:
4611 $ref: '#/components/schemas/ArrayOfUserInfo'
4612 '400':
4613 $ref: '#/components/responses/BadRequest'
4614 '401':
4615 $ref: '#/components/responses/Unauthorized'
4616 '403':
4617 $ref: '#/components/responses/Forbidden'
4618 '404':
4619 $ref: '#/components/responses/NotFound'
4620 '405':
4621 $ref: '#/components/responses/MethodNotAllowed'
4622 '406':
4623 $ref: '#/components/responses/NotAcceptable'
4624 '409':
4625 $ref: '#/components/responses/Conflict'
4626 '422':
4627 $ref: '#/components/responses/UnprocessableEntity'
4628 '500':
4629 $ref: '#/components/responses/InternalServerError'
4630 '503':
4631 $ref: '#/components/responses/ServiceUnavailable'
4632 '5XX':
4633 $ref: '#/components/responses/UnexpectedError'
4634 default:
4635 $ref: '#/components/responses/UnexpectedError'
4636 post:
4637 tags:
garciadeblas77849982020-02-28 15:41:43 +01004638 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004639 - "Admin"
4640 summary: Create a new User
4641 description: Create a new User
4642 operationId: createUser
4643 requestBody:
4644 $ref: '#/components/requestBodies/CreateUserRequest'
4645 responses:
4646 '201':
4647 description: Created
4648 headers:
4649 Location:
4650 schema:
4651 type: string
4652 format: uri
4653 content:
4654 application/json:
4655 schema:
4656 $ref: '#/components/schemas/ObjectId'
4657 application/yaml:
4658 schema:
4659 $ref: '#/components/schemas/ObjectId'
4660 '400':
4661 $ref: '#/components/responses/BadRequest'
4662 '401':
4663 $ref: '#/components/responses/Unauthorized'
4664 '403':
4665 $ref: '#/components/responses/Forbidden'
4666 '404':
4667 $ref: '#/components/responses/NotFound'
4668 '405':
4669 $ref: '#/components/responses/MethodNotAllowed'
4670 '406':
4671 $ref: '#/components/responses/NotAcceptable'
4672 '409':
4673 $ref: '#/components/responses/Conflict'
4674 '422':
4675 $ref: '#/components/responses/UnprocessableEntity'
4676 '500':
4677 $ref: '#/components/responses/InternalServerError'
4678 '503':
4679 $ref: '#/components/responses/ServiceUnavailable'
4680 '5XX':
4681 $ref: '#/components/responses/UnexpectedError'
4682 default:
4683 $ref: '#/components/responses/UnexpectedError'
4684 '/admin/v1/users/{userId}':
4685 parameters:
4686 - name: userId
4687 in: path
4688 required: true
4689 description: User ID/Name
4690 schema:
4691 type: string
4692 get:
4693 tags:
garciadeblas77849982020-02-28 15:41:43 +01004694 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004695 - "Admin"
4696 summary: Query information about an individual User
4697 description: Query information about an individual User
4698 operationId: getUser
4699 responses:
4700 '200':
4701 description: OK
4702 content:
4703 application/json:
4704 schema:
4705 $ref: '#/components/schemas/UserInfo'
4706 application/yaml:
4707 schema:
4708 $ref: '#/components/schemas/UserInfo'
4709 '400':
4710 $ref: '#/components/responses/BadRequest'
4711 '401':
4712 $ref: '#/components/responses/Unauthorized'
4713 '403':
4714 $ref: '#/components/responses/Forbidden'
4715 '404':
4716 $ref: '#/components/responses/NotFound'
4717 '405':
4718 $ref: '#/components/responses/MethodNotAllowed'
4719 '406':
4720 $ref: '#/components/responses/NotAcceptable'
4721 '409':
4722 $ref: '#/components/responses/Conflict'
4723 '422':
4724 $ref: '#/components/responses/UnprocessableEntity'
4725 '500':
4726 $ref: '#/components/responses/InternalServerError'
4727 '503':
4728 $ref: '#/components/responses/ServiceUnavailable'
4729 '5XX':
4730 $ref: '#/components/responses/UnexpectedError'
4731 default:
4732 $ref: '#/components/responses/UnexpectedError'
4733 patch:
4734 tags:
garciadeblas77849982020-02-28 15:41:43 +01004735 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004736 - "Admin"
4737 summary: Modify a User
4738 description: Modify a User
4739 operationId: editUser
4740 requestBody:
4741 $ref: '#/components/requestBodies/EditUserRequest'
4742 responses:
4743 '204':
4744 description: No Content
4745 '400':
4746 $ref: '#/components/responses/BadRequest'
4747 '401':
4748 $ref: '#/components/responses/Unauthorized'
4749 '403':
4750 $ref: '#/components/responses/Forbidden'
4751 '404':
4752 $ref: '#/components/responses/NotFound'
4753 '405':
4754 $ref: '#/components/responses/MethodNotAllowed'
4755 '406':
4756 $ref: '#/components/responses/NotAcceptable'
4757 '409':
4758 $ref: '#/components/responses/Conflict'
4759 '422':
4760 $ref: '#/components/responses/UnprocessableEntity'
4761 '500':
4762 $ref: '#/components/responses/InternalServerError'
4763 '503':
4764 $ref: '#/components/responses/ServiceUnavailable'
4765 '5XX':
4766 $ref: '#/components/responses/UnexpectedError'
4767 default:
4768 $ref: '#/components/responses/UnexpectedError'
4769 delete:
4770 tags:
garciadeblas77849982020-02-28 15:41:43 +01004771 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004772 - "Admin"
4773 summary: Delete a User
4774 description: Delete a User
4775 operationId: deleteUser
4776 responses:
4777 '204':
4778 description: No Content
4779 '400':
4780 $ref: '#/components/responses/BadRequest'
4781 '401':
4782 $ref: '#/components/responses/Unauthorized'
4783 '403':
4784 $ref: '#/components/responses/Forbidden'
4785 '404':
4786 $ref: '#/components/responses/NotFound'
4787 '405':
4788 $ref: '#/components/responses/MethodNotAllowed'
4789 '406':
4790 $ref: '#/components/responses/NotAcceptable'
4791 '409':
4792 $ref: '#/components/responses/Conflict'
4793 '422':
4794 $ref: '#/components/responses/UnprocessableEntity'
4795 '500':
4796 $ref: '#/components/responses/InternalServerError'
4797 '503':
4798 $ref: '#/components/responses/ServiceUnavailable'
4799 '5XX':
4800 $ref: '#/components/responses/UnexpectedError'
4801 default:
4802 $ref: '#/components/responses/UnexpectedError'
4803 '/admin/v1/projects':
4804 get:
4805 tags:
garciadeblas77849982020-02-28 15:41:43 +01004806 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004807 - "Admin"
4808 summary: Query information about multiple Projects
4809 description: Query information about multiple Projects
4810 operationId: getProjects
4811 responses:
4812 '200':
4813 description: OK
4814 content:
4815 application/json:
4816 schema:
4817 $ref: '#/components/schemas/ArrayOfProjectInfo'
4818 application/yaml:
4819 schema:
4820 $ref: '#/components/schemas/ArrayOfProjectInfo'
4821 '400':
4822 $ref: '#/components/responses/BadRequest'
4823 '401':
4824 $ref: '#/components/responses/Unauthorized'
4825 '403':
4826 $ref: '#/components/responses/Forbidden'
4827 '404':
4828 $ref: '#/components/responses/NotFound'
4829 '405':
4830 $ref: '#/components/responses/MethodNotAllowed'
4831 '406':
4832 $ref: '#/components/responses/NotAcceptable'
4833 '409':
4834 $ref: '#/components/responses/Conflict'
4835 '422':
4836 $ref: '#/components/responses/UnprocessableEntity'
4837 '500':
4838 $ref: '#/components/responses/InternalServerError'
4839 '503':
4840 $ref: '#/components/responses/ServiceUnavailable'
4841 '5XX':
4842 $ref: '#/components/responses/UnexpectedError'
4843 default:
4844 $ref: '#/components/responses/UnexpectedError'
4845 post:
4846 tags:
garciadeblas77849982020-02-28 15:41:43 +01004847 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004848 - "Admin"
4849 summary: Create a new Project
4850 description: Create a new Project
4851 operationId: createProject
4852 requestBody:
4853 $ref: '#/components/requestBodies/CreateProjectRequest'
4854 responses:
4855 '201':
4856 description: Created
4857 headers:
4858 Location:
4859 schema:
4860 type: string
4861 format: uri
4862 content:
4863 application/json:
4864 schema:
4865 $ref: '#/components/schemas/ObjectId'
4866 application/yaml:
4867 schema:
4868 $ref: '#/components/schemas/ObjectId'
4869 '400':
4870 $ref: '#/components/responses/BadRequest'
4871 '401':
4872 $ref: '#/components/responses/Unauthorized'
4873 '403':
4874 $ref: '#/components/responses/Forbidden'
4875 '404':
4876 $ref: '#/components/responses/NotFound'
4877 '405':
4878 $ref: '#/components/responses/MethodNotAllowed'
4879 '406':
4880 $ref: '#/components/responses/NotAcceptable'
4881 '409':
4882 $ref: '#/components/responses/Conflict'
4883 '422':
4884 $ref: '#/components/responses/UnprocessableEntity'
4885 '500':
4886 $ref: '#/components/responses/InternalServerError'
4887 '503':
4888 $ref: '#/components/responses/ServiceUnavailable'
4889 '5XX':
4890 $ref: '#/components/responses/UnexpectedError'
4891 default:
4892 $ref: '#/components/responses/UnexpectedError'
4893 '/admin/v1/projects/{projectId}':
4894 parameters:
4895 - name: projectId
4896 in: path
4897 required: true
4898 description: Project ID/Name
4899 schema:
4900 type: string
4901 get:
4902 tags:
garciadeblas77849982020-02-28 15:41:43 +01004903 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004904 - "Admin"
4905 summary: Query information about an individual Project
4906 description: Query information about an individual Project
4907 operationId: getProject
4908 responses:
4909 '200':
4910 description: OK
4911 content:
4912 application/json:
4913 schema:
4914 $ref: '#/components/schemas/ProjectInfo'
4915 application/yaml:
4916 schema:
4917 $ref: '#/components/schemas/ProjectInfo'
4918 '400':
4919 $ref: '#/components/responses/BadRequest'
4920 '401':
4921 $ref: '#/components/responses/Unauthorized'
4922 '403':
4923 $ref: '#/components/responses/Forbidden'
4924 '404':
4925 $ref: '#/components/responses/NotFound'
4926 '405':
4927 $ref: '#/components/responses/MethodNotAllowed'
4928 '406':
4929 $ref: '#/components/responses/NotAcceptable'
4930 '409':
4931 $ref: '#/components/responses/Conflict'
4932 '422':
4933 $ref: '#/components/responses/UnprocessableEntity'
4934 '500':
4935 $ref: '#/components/responses/InternalServerError'
4936 '503':
4937 $ref: '#/components/responses/ServiceUnavailable'
4938 '5XX':
4939 $ref: '#/components/responses/UnexpectedError'
4940 default:
4941 $ref: '#/components/responses/UnexpectedError'
4942 patch:
4943 tags:
garciadeblas77849982020-02-28 15:41:43 +01004944 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004945 - "Admin"
4946 summary: Modify a Project
4947 description: Modify a Project
4948 operationId: editProject
4949 requestBody:
4950 $ref: '#/components/requestBodies/EditProjectRequest'
4951 responses:
4952 '204':
4953 description: No Content
4954 '400':
4955 $ref: '#/components/responses/BadRequest'
4956 '401':
4957 $ref: '#/components/responses/Unauthorized'
4958 '403':
4959 $ref: '#/components/responses/Forbidden'
4960 '404':
4961 $ref: '#/components/responses/NotFound'
4962 '405':
4963 $ref: '#/components/responses/MethodNotAllowed'
4964 '406':
4965 $ref: '#/components/responses/NotAcceptable'
4966 '409':
4967 $ref: '#/components/responses/Conflict'
4968 '422':
4969 $ref: '#/components/responses/UnprocessableEntity'
4970 '500':
4971 $ref: '#/components/responses/InternalServerError'
4972 '503':
4973 $ref: '#/components/responses/ServiceUnavailable'
4974 '5XX':
4975 $ref: '#/components/responses/UnexpectedError'
4976 default:
4977 $ref: '#/components/responses/UnexpectedError'
4978 delete:
4979 tags:
garciadeblas77849982020-02-28 15:41:43 +01004980 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004981 - "Admin"
4982 summary: Delete a Project
4983 description: Delete a Project
4984 operationId: deleteProject
4985 responses:
4986 '204':
4987 description: No Content
4988 '400':
4989 $ref: '#/components/responses/BadRequest'
4990 '401':
4991 $ref: '#/components/responses/Unauthorized'
4992 '403':
4993 $ref: '#/components/responses/Forbidden'
4994 '404':
4995 $ref: '#/components/responses/NotFound'
4996 '405':
4997 $ref: '#/components/responses/MethodNotAllowed'
4998 '406':
4999 $ref: '#/components/responses/NotAcceptable'
5000 '409':
5001 $ref: '#/components/responses/Conflict'
5002 '422':
5003 $ref: '#/components/responses/UnprocessableEntity'
5004 '500':
5005 $ref: '#/components/responses/InternalServerError'
5006 '503':
5007 $ref: '#/components/responses/ServiceUnavailable'
5008 '5XX':
5009 $ref: '#/components/responses/UnexpectedError'
5010 default:
5011 $ref: '#/components/responses/UnexpectedError'
5012 '/admin/v1/roles':
5013 get:
5014 tags:
garciadeblas77849982020-02-28 15:41:43 +01005015 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005016 - "Admin"
5017 summary: Query information about multiple Roles
5018 description: Query information about multiple Roles
5019 operationId: getRoles
5020 responses:
5021 '200':
5022 description: OK
5023 content:
5024 application/json:
5025 schema:
5026 $ref: '#/components/schemas/ArrayOfRoleInfo'
5027 application/yaml:
5028 schema:
5029 $ref: '#/components/schemas/ArrayOfRoleInfo'
5030 '400':
5031 $ref: '#/components/responses/BadRequest'
5032 '401':
5033 $ref: '#/components/responses/Unauthorized'
5034 '403':
5035 $ref: '#/components/responses/Forbidden'
5036 '404':
5037 $ref: '#/components/responses/NotFound'
5038 '405':
5039 $ref: '#/components/responses/MethodNotAllowed'
5040 '406':
5041 $ref: '#/components/responses/NotAcceptable'
5042 '409':
5043 $ref: '#/components/responses/Conflict'
5044 '422':
5045 $ref: '#/components/responses/UnprocessableEntity'
5046 '500':
5047 $ref: '#/components/responses/InternalServerError'
5048 '503':
5049 $ref: '#/components/responses/ServiceUnavailable'
5050 '5XX':
5051 $ref: '#/components/responses/UnexpectedError'
5052 default:
5053 $ref: '#/components/responses/UnexpectedError'
5054 post:
5055 tags:
garciadeblas77849982020-02-28 15:41:43 +01005056 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005057 - "Admin"
5058 summary: Create a new Role
5059 description: Create a new Role
5060 operationId: createRole
5061 requestBody:
5062 $ref: '#/components/requestBodies/CreateRoleRequest'
5063 responses:
5064 '201':
5065 description: Created
5066 headers:
5067 Location:
5068 schema:
5069 type: string
5070 format: uri
5071 content:
5072 application/json:
5073 schema:
5074 $ref: '#/components/schemas/ObjectId'
5075 application/yaml:
5076 schema:
5077 $ref: '#/components/schemas/ObjectId'
5078 '400':
5079 $ref: '#/components/responses/BadRequest'
5080 '401':
5081 $ref: '#/components/responses/Unauthorized'
5082 '403':
5083 $ref: '#/components/responses/Forbidden'
5084 '404':
5085 $ref: '#/components/responses/NotFound'
5086 '405':
5087 $ref: '#/components/responses/MethodNotAllowed'
5088 '406':
5089 $ref: '#/components/responses/NotAcceptable'
5090 '409':
5091 $ref: '#/components/responses/Conflict'
5092 '422':
5093 $ref: '#/components/responses/UnprocessableEntity'
5094 '500':
5095 $ref: '#/components/responses/InternalServerError'
5096 '503':
5097 $ref: '#/components/responses/ServiceUnavailable'
5098 '5XX':
5099 $ref: '#/components/responses/UnexpectedError'
5100 default:
5101 $ref: '#/components/responses/UnexpectedError'
5102 '/admin/v1/roles/{roleId}':
5103 parameters:
5104 - name: roleId
5105 in: path
5106 required: true
5107 description: Role ID/Name
5108 schema:
5109 type: string
5110 get:
5111 tags:
garciadeblas77849982020-02-28 15:41:43 +01005112 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005113 - "Admin"
5114 summary: Query information about an individual Role
5115 description: Query information about an individual Role
5116 operationId: getRole
5117 responses:
5118 '200':
5119 description: OK
5120 content:
5121 application/json:
5122 schema:
5123 $ref: '#/components/schemas/RoleInfo'
5124 application/yaml:
5125 schema:
5126 $ref: '#/components/schemas/RoleInfo'
5127 '400':
5128 $ref: '#/components/responses/BadRequest'
5129 '401':
5130 $ref: '#/components/responses/Unauthorized'
5131 '403':
5132 $ref: '#/components/responses/Forbidden'
5133 '404':
5134 $ref: '#/components/responses/NotFound'
5135 '405':
5136 $ref: '#/components/responses/MethodNotAllowed'
5137 '406':
5138 $ref: '#/components/responses/NotAcceptable'
5139 '409':
5140 $ref: '#/components/responses/Conflict'
5141 '422':
5142 $ref: '#/components/responses/UnprocessableEntity'
5143 '500':
5144 $ref: '#/components/responses/InternalServerError'
5145 '503':
5146 $ref: '#/components/responses/ServiceUnavailable'
5147 '5XX':
5148 $ref: '#/components/responses/UnexpectedError'
5149 default:
5150 $ref: '#/components/responses/UnexpectedError'
5151 patch:
5152 tags:
garciadeblas77849982020-02-28 15:41:43 +01005153 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005154 - "Admin"
5155 summary: Modify a Role
5156 description: Modify a Role
5157 operationId: editRole
5158 requestBody:
5159 $ref: '#/components/requestBodies/EditRoleRequest'
5160 responses:
5161 '204':
5162 description: No Content
5163 '400':
5164 $ref: '#/components/responses/BadRequest'
5165 '401':
5166 $ref: '#/components/responses/Unauthorized'
5167 '403':
5168 $ref: '#/components/responses/Forbidden'
5169 '404':
5170 $ref: '#/components/responses/NotFound'
5171 '405':
5172 $ref: '#/components/responses/MethodNotAllowed'
5173 '406':
5174 $ref: '#/components/responses/NotAcceptable'
5175 '409':
5176 $ref: '#/components/responses/Conflict'
5177 '422':
5178 $ref: '#/components/responses/UnprocessableEntity'
5179 '500':
5180 $ref: '#/components/responses/InternalServerError'
5181 '503':
5182 $ref: '#/components/responses/ServiceUnavailable'
5183 '5XX':
5184 $ref: '#/components/responses/UnexpectedError'
5185 default:
5186 $ref: '#/components/responses/UnexpectedError'
5187 delete:
5188 tags:
garciadeblas77849982020-02-28 15:41:43 +01005189 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02005190 - "Admin"
5191 summary: Delete a Role
5192 description: Delete a Role
5193 operationId: deleteRole
5194 responses:
5195 '204':
5196 description: No Content
5197 '400':
5198 $ref: '#/components/responses/BadRequest'
5199 '401':
5200 $ref: '#/components/responses/Unauthorized'
5201 '403':
5202 $ref: '#/components/responses/Forbidden'
5203 '404':
5204 $ref: '#/components/responses/NotFound'
5205 '405':
5206 $ref: '#/components/responses/MethodNotAllowed'
5207 '406':
5208 $ref: '#/components/responses/NotAcceptable'
5209 '409':
5210 $ref: '#/components/responses/Conflict'
5211 '422':
5212 $ref: '#/components/responses/UnprocessableEntity'
5213 '500':
5214 $ref: '#/components/responses/InternalServerError'
5215 '503':
5216 $ref: '#/components/responses/ServiceUnavailable'
5217 '5XX':
5218 $ref: '#/components/responses/UnexpectedError'
5219 default:
5220 $ref: '#/components/responses/UnexpectedError'
5221 '/admin/v1/vims':
5222 get:
5223 tags:
garciadeblas77849982020-02-28 15:41:43 +01005224 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005225 - "Admin"
5226 summary: Query information about multiple VIMs
5227 description: Query information about multiple VIMs
5228 operationId: getVIMs
5229 responses:
5230 '200':
5231 description: OK
5232 content:
5233 application/json:
5234 schema:
5235 $ref: '#/components/schemas/ArrayOfVimInfo'
5236 application/yaml:
5237 schema:
5238 $ref: '#/components/schemas/ArrayOfVimInfo'
5239 '400':
5240 $ref: '#/components/responses/BadRequest'
5241 '401':
5242 $ref: '#/components/responses/Unauthorized'
5243 '403':
5244 $ref: '#/components/responses/Forbidden'
5245 '404':
5246 $ref: '#/components/responses/NotFound'
5247 '405':
5248 $ref: '#/components/responses/MethodNotAllowed'
5249 '406':
5250 $ref: '#/components/responses/NotAcceptable'
5251 '409':
5252 $ref: '#/components/responses/Conflict'
5253 '422':
5254 $ref: '#/components/responses/UnprocessableEntity'
5255 '500':
5256 $ref: '#/components/responses/InternalServerError'
5257 '503':
5258 $ref: '#/components/responses/ServiceUnavailable'
5259 '5XX':
5260 $ref: '#/components/responses/UnexpectedError'
5261 default:
5262 $ref: '#/components/responses/UnexpectedError'
5263 post:
5264 tags:
garciadeblas77849982020-02-28 15:41:43 +01005265 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005266 - "Admin"
5267 summary: Create a new VIM
5268 description: Create a new VIM
5269 operationId: createVIM
5270 requestBody:
5271 $ref: '#/components/requestBodies/CreateVimRequest'
5272 responses:
5273 '202':
5274 description: Accepted
5275 content:
5276 application/json:
5277 schema:
5278 $ref: '#/components/schemas/ObjectId_plus_OpId'
5279 application/yaml:
5280 schema:
5281 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/vims/{vimId}':
5307 parameters:
5308 - name: vimId
5309 in: path
5310 required: true
5311 description: VIM ID
5312 schema:
5313 type: string
5314 format: uuid
5315 get:
5316 tags:
garciadeblas77849982020-02-28 15:41:43 +01005317 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005318 - "Admin"
5319 summary: Query information about an individual VIM
5320 description: Query information about an individual VIM
5321 operationId: getVIM
5322 responses:
5323 '200':
5324 description: OK
5325 content:
5326 application/json:
5327 schema:
5328 $ref: '#/components/schemas/VimInfo'
5329 application/yaml:
5330 schema:
5331 $ref: '#/components/schemas/VimInfo'
5332 '400':
5333 $ref: '#/components/responses/BadRequest'
5334 '401':
5335 $ref: '#/components/responses/Unauthorized'
5336 '403':
5337 $ref: '#/components/responses/Forbidden'
5338 '404':
5339 $ref: '#/components/responses/NotFound'
5340 '405':
5341 $ref: '#/components/responses/MethodNotAllowed'
5342 '406':
5343 $ref: '#/components/responses/NotAcceptable'
5344 '409':
5345 $ref: '#/components/responses/Conflict'
5346 '422':
5347 $ref: '#/components/responses/UnprocessableEntity'
5348 '500':
5349 $ref: '#/components/responses/InternalServerError'
5350 '503':
5351 $ref: '#/components/responses/ServiceUnavailable'
5352 '5XX':
5353 $ref: '#/components/responses/UnexpectedError'
5354 default:
5355 $ref: '#/components/responses/UnexpectedError'
5356 patch:
5357 tags:
garciadeblas77849982020-02-28 15:41:43 +01005358 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005359 - "Admin"
5360 summary: Modify a VIM
5361 description: Modify a VIM
5362 operationId: editVIM
5363 requestBody:
5364 $ref: '#/components/requestBodies/EditVimRequest'
5365 responses:
5366 '202':
5367 description: Accepted
5368 content:
5369 application/json:
5370 schema:
5371 $ref: '#/components/schemas/OpId'
5372 application/yaml:
5373 schema:
5374 $ref: '#/components/schemas/OpId'
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 delete:
5400 tags:
garciadeblas77849982020-02-28 15:41:43 +01005401 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005402 - "Admin"
5403 summary: Delete a VIM
5404 description: Delete a VIM
5405 operationId: deleteVIM
5406 responses:
5407 '202':
5408 description: Accepted
5409 '400':
5410 $ref: '#/components/responses/BadRequest'
5411 '401':
5412 $ref: '#/components/responses/Unauthorized'
5413 '403':
5414 $ref: '#/components/responses/Forbidden'
5415 '404':
5416 $ref: '#/components/responses/NotFound'
5417 '405':
5418 $ref: '#/components/responses/MethodNotAllowed'
5419 '406':
5420 $ref: '#/components/responses/NotAcceptable'
5421 '409':
5422 $ref: '#/components/responses/Conflict'
5423 '422':
5424 $ref: '#/components/responses/UnprocessableEntity'
5425 '500':
5426 $ref: '#/components/responses/InternalServerError'
5427 '503':
5428 $ref: '#/components/responses/ServiceUnavailable'
5429 '5XX':
5430 $ref: '#/components/responses/UnexpectedError'
5431 default:
5432 $ref: '#/components/responses/UnexpectedError'
5433 '/admin/v1/vim_accounts':
5434 get:
5435 tags:
garciadeblas77849982020-02-28 15:41:43 +01005436 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005437 - "Admin"
5438 summary: Query information about multiple VIM Accounts
5439 description: Query information about multiple VIM Accounts
5440 operationId: getVimAccounts
5441 responses:
5442 '200':
5443 description: OK
5444 content:
5445 application/json:
5446 schema:
5447 $ref: '#/components/schemas/ArrayOfVimInfo'
5448 application/yaml:
5449 schema:
5450 $ref: '#/components/schemas/ArrayOfVimInfo'
5451 '400':
5452 $ref: '#/components/responses/BadRequest'
5453 '401':
5454 $ref: '#/components/responses/Unauthorized'
5455 '403':
5456 $ref: '#/components/responses/Forbidden'
5457 '404':
5458 $ref: '#/components/responses/NotFound'
5459 '405':
5460 $ref: '#/components/responses/MethodNotAllowed'
5461 '406':
5462 $ref: '#/components/responses/NotAcceptable'
5463 '409':
5464 $ref: '#/components/responses/Conflict'
5465 '422':
5466 $ref: '#/components/responses/UnprocessableEntity'
5467 '500':
5468 $ref: '#/components/responses/InternalServerError'
5469 '503':
5470 $ref: '#/components/responses/ServiceUnavailable'
5471 '5XX':
5472 $ref: '#/components/responses/UnexpectedError'
5473 default:
5474 $ref: '#/components/responses/UnexpectedError'
5475 post:
5476 tags:
garciadeblas77849982020-02-28 15:41:43 +01005477 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005478 - "Admin"
5479 summary: Create a new VIM Account
5480 description: Create a new VIM Account
5481 operationId: createVimAccount
5482 requestBody:
5483 $ref: '#/components/requestBodies/CreateVimRequest'
5484 responses:
5485 '202':
5486 description: Accepted
5487 content:
5488 application/json:
5489 schema:
5490 $ref: '#/components/schemas/ObjectId_plus_OpId'
5491 application/yaml:
5492 schema:
5493 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/vim_accounts/{vimAccountId}':
5519 parameters:
5520 - name: vimAccountId
5521 in: path
5522 required: true
5523 description: VIM Account ID
5524 schema:
5525 type: string
5526 format: uuid
5527 get:
5528 tags:
garciadeblas77849982020-02-28 15:41:43 +01005529 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005530 - "Admin"
5531 summary: Query information about an individual VIM Account
5532 description: Query information about an individual VIM Account
5533 operationId: getVimAccount
5534 responses:
5535 '200':
5536 description: OK
5537 content:
5538 application/json:
5539 schema:
5540 $ref: '#/components/schemas/VimInfo'
5541 application/yaml:
5542 schema:
5543 $ref: '#/components/schemas/VimInfo'
5544 '400':
5545 $ref: '#/components/responses/BadRequest'
5546 '401':
5547 $ref: '#/components/responses/Unauthorized'
5548 '403':
5549 $ref: '#/components/responses/Forbidden'
5550 '404':
5551 $ref: '#/components/responses/NotFound'
5552 '405':
5553 $ref: '#/components/responses/MethodNotAllowed'
5554 '406':
5555 $ref: '#/components/responses/NotAcceptable'
5556 '409':
5557 $ref: '#/components/responses/Conflict'
5558 '422':
5559 $ref: '#/components/responses/UnprocessableEntity'
5560 '500':
5561 $ref: '#/components/responses/InternalServerError'
5562 '503':
5563 $ref: '#/components/responses/ServiceUnavailable'
5564 '5XX':
5565 $ref: '#/components/responses/UnexpectedError'
5566 default:
5567 $ref: '#/components/responses/UnexpectedError'
5568 patch:
5569 tags:
garciadeblas77849982020-02-28 15:41:43 +01005570 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005571 - "Admin"
5572 summary: Modify a VIM Account
5573 description: Modify a VIM Account
5574 operationId: editVimAccount
5575 requestBody:
5576 $ref: '#/components/requestBodies/EditVimRequest'
5577 responses:
5578 '202':
5579 description: Accepted
5580 content:
5581 application/json:
5582 schema:
5583 $ref: '#/components/schemas/OpId'
5584 application/yaml:
5585 schema:
5586 $ref: '#/components/schemas/OpId'
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 delete:
5612 tags:
garciadeblas77849982020-02-28 15:41:43 +01005613 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005614 - "Admin"
5615 summary: Delete a VIM Account
5616 description: Delete a VIM Account
5617 operationId: deleteVimAccount
5618 responses:
5619 '202':
5620 description: Accepted
5621 '400':
5622 $ref: '#/components/responses/BadRequest'
5623 '401':
5624 $ref: '#/components/responses/Unauthorized'
5625 '403':
5626 $ref: '#/components/responses/Forbidden'
5627 '404':
5628 $ref: '#/components/responses/NotFound'
5629 '405':
5630 $ref: '#/components/responses/MethodNotAllowed'
5631 '406':
5632 $ref: '#/components/responses/NotAcceptable'
5633 '409':
5634 $ref: '#/components/responses/Conflict'
5635 '422':
5636 $ref: '#/components/responses/UnprocessableEntity'
5637 '500':
5638 $ref: '#/components/responses/InternalServerError'
5639 '503':
5640 $ref: '#/components/responses/ServiceUnavailable'
5641 '5XX':
5642 $ref: '#/components/responses/UnexpectedError'
5643 default:
5644 $ref: '#/components/responses/UnexpectedError'
5645 '/admin/v1/wim_accounts':
5646 get:
5647 tags:
garciadeblas77849982020-02-28 15:41:43 +01005648 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005649 - "Admin"
5650 summary: Query information about multiple WIM Accounts
5651 description: Query information about multiple WIM Accounts
5652 operationId: getWimAccounts
5653 responses:
5654 '200':
5655 description: OK
5656 content:
5657 application/json:
5658 schema:
5659 $ref: '#/components/schemas/ArrayOfWimInfo'
5660 application/yaml:
5661 schema:
5662 $ref: '#/components/schemas/ArrayOfWimInfo'
5663 '400':
5664 $ref: '#/components/responses/BadRequest'
5665 '401':
5666 $ref: '#/components/responses/Unauthorized'
5667 '403':
5668 $ref: '#/components/responses/Forbidden'
5669 '404':
5670 $ref: '#/components/responses/NotFound'
5671 '405':
5672 $ref: '#/components/responses/MethodNotAllowed'
5673 '406':
5674 $ref: '#/components/responses/NotAcceptable'
5675 '409':
5676 $ref: '#/components/responses/Conflict'
5677 '422':
5678 $ref: '#/components/responses/UnprocessableEntity'
5679 '500':
5680 $ref: '#/components/responses/InternalServerError'
5681 '503':
5682 $ref: '#/components/responses/ServiceUnavailable'
5683 '5XX':
5684 $ref: '#/components/responses/UnexpectedError'
5685 default:
5686 $ref: '#/components/responses/UnexpectedError'
5687 post:
5688 tags:
garciadeblas77849982020-02-28 15:41:43 +01005689 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005690 - "Admin"
5691 summary: Create a new WIM Account
5692 description: Create a new WIM Account
5693 operationId: createWimAccount
5694 requestBody:
5695 $ref: '#/components/requestBodies/CreateWimRequest'
5696 responses:
5697 '202':
5698 description: Accepted
5699 content:
5700 application/json:
5701 schema:
5702 $ref: '#/components/schemas/ObjectId_plus_OpId'
5703 application/yaml:
5704 schema:
5705 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/wim_accounts/{wimAccountId}':
5731 parameters:
5732 - name: wimAccountId
5733 in: path
5734 required: true
5735 description: WIM Account ID
5736 schema:
5737 type: string
5738 format: uuid
5739 get:
5740 tags:
garciadeblas77849982020-02-28 15:41:43 +01005741 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005742 - "Admin"
5743 summary: Query information about an individual WIM Account
5744 description: Query information about an individual WIM Account
5745 operationId: getWimAccount
5746 responses:
5747 '200':
5748 description: OK
5749 content:
5750 application/json:
5751 schema:
5752 $ref: '#/components/schemas/WimInfo'
5753 application/yaml:
5754 schema:
5755 $ref: '#/components/schemas/WimInfo'
5756 '400':
5757 $ref: '#/components/responses/BadRequest'
5758 '401':
5759 $ref: '#/components/responses/Unauthorized'
5760 '403':
5761 $ref: '#/components/responses/Forbidden'
5762 '404':
5763 $ref: '#/components/responses/NotFound'
5764 '405':
5765 $ref: '#/components/responses/MethodNotAllowed'
5766 '406':
5767 $ref: '#/components/responses/NotAcceptable'
5768 '409':
5769 $ref: '#/components/responses/Conflict'
5770 '422':
5771 $ref: '#/components/responses/UnprocessableEntity'
5772 '500':
5773 $ref: '#/components/responses/InternalServerError'
5774 '503':
5775 $ref: '#/components/responses/ServiceUnavailable'
5776 '5XX':
5777 $ref: '#/components/responses/UnexpectedError'
5778 default:
5779 $ref: '#/components/responses/UnexpectedError'
5780 patch:
5781 tags:
garciadeblas77849982020-02-28 15:41:43 +01005782 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005783 - "Admin"
5784 summary: Modify a WIM Account
5785 description: Modify a WIM Account
5786 operationId: editWimAccount
5787 requestBody:
5788 $ref: '#/components/requestBodies/EditWimRequest'
5789 responses:
5790 '202':
5791 description: Accepted
5792 content:
5793 application/json:
5794 schema:
5795 $ref: '#/components/schemas/OpId'
5796 application/yaml:
5797 schema:
5798 $ref: '#/components/schemas/OpId'
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 delete:
5824 tags:
garciadeblas77849982020-02-28 15:41:43 +01005825 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005826 - "Admin"
5827 summary: Delete a WIM Account
5828 description: Delete a WIM Account
5829 operationId: deleteWimAccount
5830 responses:
5831 '202':
5832 description: Accepted
5833 '400':
5834 $ref: '#/components/responses/BadRequest'
5835 '401':
5836 $ref: '#/components/responses/Unauthorized'
5837 '403':
5838 $ref: '#/components/responses/Forbidden'
5839 '404':
5840 $ref: '#/components/responses/NotFound'
5841 '405':
5842 $ref: '#/components/responses/MethodNotAllowed'
5843 '406':
5844 $ref: '#/components/responses/NotAcceptable'
5845 '409':
5846 $ref: '#/components/responses/Conflict'
5847 '422':
5848 $ref: '#/components/responses/UnprocessableEntity'
5849 '500':
5850 $ref: '#/components/responses/InternalServerError'
5851 '503':
5852 $ref: '#/components/responses/ServiceUnavailable'
5853 '5XX':
5854 $ref: '#/components/responses/UnexpectedError'
5855 default:
5856 $ref: '#/components/responses/UnexpectedError'
5857 '/admin/v1/sdns':
5858 get:
5859 tags:
garciadeblas77849982020-02-28 15:41:43 +01005860 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005861 - "Admin"
5862 summary: Query information about multiple SDNs
5863 description: Query information about multiple SDNs
5864 operationId: getSDNs
5865 responses:
5866 '200':
5867 description: OK
5868 content:
5869 application/json:
5870 schema:
5871 $ref: '#/components/schemas/ArrayOfSdnInfo'
5872 application/yaml:
5873 schema:
5874 $ref: '#/components/schemas/ArrayOfSdnInfo'
5875 '400':
5876 $ref: '#/components/responses/BadRequest'
5877 '401':
5878 $ref: '#/components/responses/Unauthorized'
5879 '403':
5880 $ref: '#/components/responses/Forbidden'
5881 '404':
5882 $ref: '#/components/responses/NotFound'
5883 '405':
5884 $ref: '#/components/responses/MethodNotAllowed'
5885 '406':
5886 $ref: '#/components/responses/NotAcceptable'
5887 '409':
5888 $ref: '#/components/responses/Conflict'
5889 '422':
5890 $ref: '#/components/responses/UnprocessableEntity'
5891 '500':
5892 $ref: '#/components/responses/InternalServerError'
5893 '503':
5894 $ref: '#/components/responses/ServiceUnavailable'
5895 '5XX':
5896 $ref: '#/components/responses/UnexpectedError'
5897 default:
5898 $ref: '#/components/responses/UnexpectedError'
5899 post:
5900 tags:
garciadeblas77849982020-02-28 15:41:43 +01005901 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005902 - "Admin"
5903 summary: Create a new SDN
5904 description: Create a new SDN
5905 operationId: createSDN
5906 requestBody:
5907 $ref: '#/components/requestBodies/CreateSdnRequest'
5908 responses:
5909 '202':
5910 description: Accepted
5911 content:
5912 application/json:
5913 schema:
5914 $ref: '#/components/schemas/ObjectId_plus_OpId'
5915 application/yaml:
5916 schema:
5917 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/sdns/{sdnId}':
5943 parameters:
5944 - name: sdnId
5945 in: path
5946 required: true
5947 description: SDN ID
5948 schema:
5949 type: string
5950 format: uuid
5951 get:
5952 tags:
garciadeblas77849982020-02-28 15:41:43 +01005953 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005954 - "Admin"
5955 summary: Query information about an individual SDN
5956 description: Query information about an individual SDN
5957 operationId: getSDN
5958 responses:
5959 '200':
5960 description: OK
5961 content:
5962 application/json:
5963 schema:
5964 $ref: '#/components/schemas/SdnInfo'
5965 application/yaml:
5966 schema:
5967 $ref: '#/components/schemas/SdnInfo'
5968 '400':
5969 $ref: '#/components/responses/BadRequest'
5970 '401':
5971 $ref: '#/components/responses/Unauthorized'
5972 '403':
5973 $ref: '#/components/responses/Forbidden'
5974 '404':
5975 $ref: '#/components/responses/NotFound'
5976 '405':
5977 $ref: '#/components/responses/MethodNotAllowed'
5978 '406':
5979 $ref: '#/components/responses/NotAcceptable'
5980 '409':
5981 $ref: '#/components/responses/Conflict'
5982 '422':
5983 $ref: '#/components/responses/UnprocessableEntity'
5984 '500':
5985 $ref: '#/components/responses/InternalServerError'
5986 '503':
5987 $ref: '#/components/responses/ServiceUnavailable'
5988 '5XX':
5989 $ref: '#/components/responses/UnexpectedError'
5990 default:
5991 $ref: '#/components/responses/UnexpectedError'
5992 patch:
5993 tags:
garciadeblas77849982020-02-28 15:41:43 +01005994 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005995 - "Admin"
5996 summary: Modify a SDN
5997 description: Modify a SDN
5998 operationId: editSDN
5999 requestBody:
6000 $ref: '#/components/requestBodies/EditSdnRequest'
6001 responses:
6002 '202':
6003 description: Accepted
6004 content:
6005 application/json:
6006 schema:
6007 $ref: '#/components/schemas/OpId'
6008 application/yaml:
6009 schema:
6010 $ref: '#/components/schemas/OpId'
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 delete:
6036 tags:
garciadeblas77849982020-02-28 15:41:43 +01006037 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006038 - "Admin"
6039 summary: Delete a SDN
6040 description: Delete a SDN
6041 operationId: deleteSDN
6042 responses:
6043 '202':
6044 description: Accepted
6045 '400':
6046 $ref: '#/components/responses/BadRequest'
6047 '401':
6048 $ref: '#/components/responses/Unauthorized'
6049 '403':
6050 $ref: '#/components/responses/Forbidden'
6051 '404':
6052 $ref: '#/components/responses/NotFound'
6053 '405':
6054 $ref: '#/components/responses/MethodNotAllowed'
6055 '406':
6056 $ref: '#/components/responses/NotAcceptable'
6057 '409':
6058 $ref: '#/components/responses/Conflict'
6059 '422':
6060 $ref: '#/components/responses/UnprocessableEntity'
6061 '500':
6062 $ref: '#/components/responses/InternalServerError'
6063 '503':
6064 $ref: '#/components/responses/ServiceUnavailable'
6065 '5XX':
6066 $ref: '#/components/responses/UnexpectedError'
6067 default:
6068 $ref: '#/components/responses/UnexpectedError'
6069 '/admin/v1/k8sclusters':
6070 get:
6071 tags:
garciadeblas77849982020-02-28 15:41:43 +01006072 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006073 - "Admin"
6074 summary: Query information about multiple K8s Clusters
6075 description: Query information about multiple K8s Clusters
6076 operationId: getK8sClusters
6077 responses:
6078 '200':
6079 description: OK
6080 content:
6081 application/json:
6082 schema:
6083 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
6084 application/yaml:
6085 schema:
6086 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
6087 '400':
6088 $ref: '#/components/responses/BadRequest'
6089 '401':
6090 $ref: '#/components/responses/Unauthorized'
6091 '403':
6092 $ref: '#/components/responses/Forbidden'
6093 '404':
6094 $ref: '#/components/responses/NotFound'
6095 '405':
6096 $ref: '#/components/responses/MethodNotAllowed'
6097 '406':
6098 $ref: '#/components/responses/NotAcceptable'
6099 '409':
6100 $ref: '#/components/responses/Conflict'
6101 '422':
6102 $ref: '#/components/responses/UnprocessableEntity'
6103 '500':
6104 $ref: '#/components/responses/InternalServerError'
6105 '503':
6106 $ref: '#/components/responses/ServiceUnavailable'
6107 '5XX':
6108 $ref: '#/components/responses/UnexpectedError'
6109 default:
6110 $ref: '#/components/responses/UnexpectedError'
6111 post:
6112 tags:
garciadeblas77849982020-02-28 15:41:43 +01006113 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006114 - "Admin"
6115 summary: Create a new K8s Cluster
6116 description: Create a new K8s Cluster
6117 operationId: createK8sCluster
6118 requestBody:
6119 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
6120 responses:
6121 '202':
6122 description: Accepted
6123 content:
6124 application/json:
6125 schema:
6126 $ref: '#/components/schemas/ObjectId_plus_OpId'
6127 application/yaml:
6128 schema:
6129 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/k8sclusters/{k8sClusterId}':
6155 parameters:
6156 - name: k8sClusterId
6157 in: path
6158 required: true
6159 description: K8s Cluster ID
6160 schema:
6161 type: string
6162 format: uuid
6163 get:
6164 tags:
garciadeblas77849982020-02-28 15:41:43 +01006165 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006166 - "Admin"
6167 summary: Query information about an individual K8s Cluster
6168 description: Query information about an individual K8s Cluster
6169 operationId: getK8sCluster
6170 responses:
6171 '200':
6172 description: OK
6173 content:
6174 application/json:
6175 schema:
6176 $ref: '#/components/schemas/K8sClusterInfo'
6177 application/yaml:
6178 schema:
6179 $ref: '#/components/schemas/K8sClusterInfo'
6180 '400':
6181 $ref: '#/components/responses/BadRequest'
6182 '401':
6183 $ref: '#/components/responses/Unauthorized'
6184 '403':
6185 $ref: '#/components/responses/Forbidden'
6186 '404':
6187 $ref: '#/components/responses/NotFound'
6188 '405':
6189 $ref: '#/components/responses/MethodNotAllowed'
6190 '406':
6191 $ref: '#/components/responses/NotAcceptable'
6192 '409':
6193 $ref: '#/components/responses/Conflict'
6194 '422':
6195 $ref: '#/components/responses/UnprocessableEntity'
6196 '500':
6197 $ref: '#/components/responses/InternalServerError'
6198 '503':
6199 $ref: '#/components/responses/ServiceUnavailable'
6200 '5XX':
6201 $ref: '#/components/responses/UnexpectedError'
6202 default:
6203 $ref: '#/components/responses/UnexpectedError'
6204 patch:
6205 tags:
garciadeblas77849982020-02-28 15:41:43 +01006206 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006207 - "Admin"
6208 summary: Modify a K8s Cluster
6209 description: Modify a K8s Cluster
6210 operationId: editK8sCluster
6211 requestBody:
6212 $ref: '#/components/requestBodies/EditK8sClusterRequest'
6213 responses:
6214 '202':
6215 description: Accepted
6216 content:
6217 application/json:
6218 schema:
6219 $ref: '#/components/schemas/OpId'
6220 application/yaml:
6221 schema:
6222 $ref: '#/components/schemas/OpId'
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 delete:
6248 tags:
garciadeblas77849982020-02-28 15:41:43 +01006249 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02006250 - "Admin"
6251 summary: Delete a K8s Cluster
6252 description: Delete a K8s Cluster
6253 operationId: deleteK8sCluster
6254 responses:
6255 '202':
6256 description: Accepted
6257 '400':
6258 $ref: '#/components/responses/BadRequest'
6259 '401':
6260 $ref: '#/components/responses/Unauthorized'
6261 '403':
6262 $ref: '#/components/responses/Forbidden'
6263 '404':
6264 $ref: '#/components/responses/NotFound'
6265 '405':
6266 $ref: '#/components/responses/MethodNotAllowed'
6267 '406':
6268 $ref: '#/components/responses/NotAcceptable'
6269 '409':
6270 $ref: '#/components/responses/Conflict'
6271 '422':
6272 $ref: '#/components/responses/UnprocessableEntity'
6273 '500':
6274 $ref: '#/components/responses/InternalServerError'
6275 '503':
6276 $ref: '#/components/responses/ServiceUnavailable'
6277 '5XX':
6278 $ref: '#/components/responses/UnexpectedError'
6279 default:
6280 $ref: '#/components/responses/UnexpectedError'
David Garciaaf38fce2021-05-04 12:48:04 +02006281 '/admin/v1/vca':
6282 get:
6283 tags:
6284 - "Infrastructure"
6285 - "Admin"
6286 summary: Query information about multiple VCAs
6287 description: Query information about multiple VCAs
6288 operationId: getVcas
6289 responses:
6290 '200':
6291 description: OK
6292 content:
6293 application/json:
6294 schema:
6295 $ref: '#/components/schemas/ArrayOfVcaInfo'
6296 application/yaml:
6297 schema:
6298 $ref: '#/components/schemas/ArrayOfVcaInfo'
6299 '400':
6300 $ref: '#/components/responses/BadRequest'
6301 '401':
6302 $ref: '#/components/responses/Unauthorized'
6303 '403':
6304 $ref: '#/components/responses/Forbidden'
6305 '404':
6306 $ref: '#/components/responses/NotFound'
6307 '405':
6308 $ref: '#/components/responses/MethodNotAllowed'
6309 '406':
6310 $ref: '#/components/responses/NotAcceptable'
6311 '409':
6312 $ref: '#/components/responses/Conflict'
6313 '422':
6314 $ref: '#/components/responses/UnprocessableEntity'
6315 '500':
6316 $ref: '#/components/responses/InternalServerError'
6317 '503':
6318 $ref: '#/components/responses/ServiceUnavailable'
6319 '5XX':
6320 $ref: '#/components/responses/UnexpectedError'
6321 default:
6322 $ref: '#/components/responses/UnexpectedError'
6323 post:
6324 tags:
6325 - "Infrastructure"
6326 - "Admin"
6327 summary: Create a new VCA
6328 description: Create a new VCA
6329 operationId: createVca
6330 requestBody:
6331 $ref: '#/components/requestBodies/CreateVcaRequest'
6332 responses:
6333 '202':
6334 description: Accepted
6335 content:
6336 application/json:
6337 schema:
6338 $ref: '#/components/schemas/ObjectId_plus_OpId'
6339 application/yaml:
6340 schema:
6341 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/vca/{vcaId}':
6367 parameters:
6368 - name: vcaId
6369 in: path
6370 required: true
6371 description: VCA ID
6372 schema:
6373 type: string
6374 format: uuid
6375 get:
6376 tags:
6377 - "Infrastructure"
6378 - "Admin"
6379 summary: Query information about an individual VCA
6380 description: Query information about an individual VCA
6381 operationId: getVca
6382 responses:
6383 '200':
6384 description: OK
6385 content:
6386 application/json:
6387 schema:
6388 $ref: '#/components/schemas/VcaInfo'
6389 application/yaml:
6390 schema:
6391 $ref: '#/components/schemas/VcaInfo'
6392 '400':
6393 $ref: '#/components/responses/BadRequest'
6394 '401':
6395 $ref: '#/components/responses/Unauthorized'
6396 '403':
6397 $ref: '#/components/responses/Forbidden'
6398 '404':
6399 $ref: '#/components/responses/NotFound'
6400 '405':
6401 $ref: '#/components/responses/MethodNotAllowed'
6402 '406':
6403 $ref: '#/components/responses/NotAcceptable'
6404 '409':
6405 $ref: '#/components/responses/Conflict'
6406 '422':
6407 $ref: '#/components/responses/UnprocessableEntity'
6408 '500':
6409 $ref: '#/components/responses/InternalServerError'
6410 '503':
6411 $ref: '#/components/responses/ServiceUnavailable'
6412 '5XX':
6413 $ref: '#/components/responses/UnexpectedError'
6414 default:
6415 $ref: '#/components/responses/UnexpectedError'
6416 patch:
6417 tags:
6418 - "Infrastructure"
6419 - "Admin"
6420 summary: Modify a VCA
6421 description: Modify a VCA
6422 operationId: editVca
6423 requestBody:
6424 $ref: '#/components/requestBodies/EditVcaRequest'
6425 responses:
6426 '202':
6427 description: Accepted
6428 content:
6429 application/json:
6430 schema:
6431 $ref: '#/components/schemas/OpId'
6432 application/yaml:
6433 schema:
6434 $ref: '#/components/schemas/OpId'
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 delete:
6460 tags:
6461 - "Infrastructure"
6462 - "Admin"
6463 summary: Delete a VCA
6464 description: Delete a VCA
6465 operationId: deleteVca
6466 responses:
6467 '202':
6468 description: Accepted
6469 '400':
6470 $ref: '#/components/responses/BadRequest'
6471 '401':
6472 $ref: '#/components/responses/Unauthorized'
6473 '403':
6474 $ref: '#/components/responses/Forbidden'
6475 '404':
6476 $ref: '#/components/responses/NotFound'
6477 '405':
6478 $ref: '#/components/responses/MethodNotAllowed'
6479 '406':
6480 $ref: '#/components/responses/NotAcceptable'
6481 '409':
6482 $ref: '#/components/responses/Conflict'
6483 '422':
6484 $ref: '#/components/responses/UnprocessableEntity'
6485 '500':
6486 $ref: '#/components/responses/InternalServerError'
6487 '503':
6488 $ref: '#/components/responses/ServiceUnavailable'
6489 '5XX':
6490 $ref: '#/components/responses/UnexpectedError'
6491 default:
6492 $ref: '#/components/responses/UnexpectedError'
delacruzramaf79f3c2019-10-22 13:13:01 +02006493 '/admin/v1/k8srepos':
6494 get:
6495 tags:
garciadeblas77849982020-02-28 15:41:43 +01006496 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006497 - "Admin"
6498 summary: Query information about multiple K8s Repos
6499 description: Query information about multiple K8s Repos
6500 operationId: getK8sRepos
6501 responses:
6502 '200':
6503 description: OK
6504 content:
6505 application/json:
6506 schema:
6507 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6508 application/yaml:
6509 schema:
6510 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6511 '400':
6512 $ref: '#/components/responses/BadRequest'
6513 '401':
6514 $ref: '#/components/responses/Unauthorized'
6515 '403':
6516 $ref: '#/components/responses/Forbidden'
6517 '404':
6518 $ref: '#/components/responses/NotFound'
6519 '405':
6520 $ref: '#/components/responses/MethodNotAllowed'
6521 '406':
6522 $ref: '#/components/responses/NotAcceptable'
6523 '409':
6524 $ref: '#/components/responses/Conflict'
6525 '422':
6526 $ref: '#/components/responses/UnprocessableEntity'
6527 '500':
6528 $ref: '#/components/responses/InternalServerError'
6529 '503':
6530 $ref: '#/components/responses/ServiceUnavailable'
6531 '5XX':
6532 $ref: '#/components/responses/UnexpectedError'
6533 default:
6534 $ref: '#/components/responses/UnexpectedError'
6535 post:
6536 tags:
garciadeblas77849982020-02-28 15:41:43 +01006537 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006538 - "Admin"
6539 summary: Create a new K8s Repo
6540 description: Create a new K8s Repo
6541 operationId: createK8sRepo
6542 requestBody:
6543 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6544 responses:
6545 '202':
6546 description: Accepted
6547 content:
6548 application/json:
6549 schema:
6550 $ref: '#/components/schemas/ObjectId_plus_OpId'
6551 application/yaml:
6552 schema:
6553 $ref: '#/components/schemas/ObjectId_plus_OpId'
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 '/admin/v1/k8srepos/{k8sRepoId}':
6579 parameters:
6580 - name: k8sRepoId
6581 in: path
6582 required: true
6583 description: K8s Repo ID
6584 schema:
6585 type: string
6586 format: uuid
6587 get:
6588 tags:
garciadeblas77849982020-02-28 15:41:43 +01006589 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006590 - "Admin"
6591 summary: Query information about an individual K8s Repo
6592 description: Query information about an individual K8s Repo
6593 operationId: getK8sRepo
6594 responses:
6595 '200':
6596 description: OK
6597 content:
6598 application/json:
6599 schema:
6600 $ref: '#/components/schemas/K8sRepoInfo'
6601 application/yaml:
6602 schema:
6603 $ref: '#/components/schemas/K8sRepoInfo'
6604 '400':
6605 $ref: '#/components/responses/BadRequest'
6606 '401':
6607 $ref: '#/components/responses/Unauthorized'
6608 '403':
6609 $ref: '#/components/responses/Forbidden'
6610 '404':
6611 $ref: '#/components/responses/NotFound'
6612 '405':
6613 $ref: '#/components/responses/MethodNotAllowed'
6614 '406':
6615 $ref: '#/components/responses/NotAcceptable'
6616 '409':
6617 $ref: '#/components/responses/Conflict'
6618 '422':
6619 $ref: '#/components/responses/UnprocessableEntity'
6620 '500':
6621 $ref: '#/components/responses/InternalServerError'
6622 '503':
6623 $ref: '#/components/responses/ServiceUnavailable'
6624 '5XX':
6625 $ref: '#/components/responses/UnexpectedError'
6626 default:
6627 $ref: '#/components/responses/UnexpectedError'
6628 delete:
6629 tags:
garciadeblas77849982020-02-28 15:41:43 +01006630 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006631 - "Admin"
6632 summary: Delete a K8s Repo
6633 description: Delete a K8s Repo
6634 operationId: deleteK8sRepo
6635 responses:
6636 '202':
6637 description: Accepted
6638 '400':
6639 $ref: '#/components/responses/BadRequest'
6640 '401':
6641 $ref: '#/components/responses/Unauthorized'
6642 '403':
6643 $ref: '#/components/responses/Forbidden'
6644 '404':
6645 $ref: '#/components/responses/NotFound'
6646 '405':
6647 $ref: '#/components/responses/MethodNotAllowed'
6648 '406':
6649 $ref: '#/components/responses/NotAcceptable'
6650 '409':
6651 $ref: '#/components/responses/Conflict'
6652 '422':
6653 $ref: '#/components/responses/UnprocessableEntity'
6654 '500':
6655 $ref: '#/components/responses/InternalServerError'
6656 '503':
6657 $ref: '#/components/responses/ServiceUnavailable'
6658 '5XX':
6659 $ref: '#/components/responses/UnexpectedError'
6660 default:
6661 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02006662# END Admin
6663
garciadeblas60e2ee92018-02-27 19:09:51 +01006664externalDocs:
delacruzramaf79f3c2019-10-22 13:13:01 +02006665 description: Find out more about OSM
garciadeblas00c2eb92020-02-28 15:24:27 +01006666 url: 'https://osm.etsi.org/docs/user-guide/'
delacruzramfb52ade2019-10-07 16:46:59 +02006667
garciadeblas60e2ee92018-02-27 19:09:51 +01006668components:
6669 responses:
6670 BadRequest:
6671 description: Bad request. The server cannot process the request due to a client error.
6672 content:
6673 application/json:
6674 schema:
6675 $ref: '#/components/schemas/ProblemDetails'
6676 Unauthorized:
6677 description: Authorization information is missing or invalid.
6678 content:
6679 application/json:
6680 schema:
6681 $ref: '#/components/schemas/ProblemDetails'
6682 Forbidden:
6683 description: Not enough permissions to do this operation.
6684 content:
6685 application/json:
6686 schema:
6687 $ref: '#/components/schemas/ProblemDetails'
6688 NotFound:
6689 description: The specified resource was not found.
6690 content:
6691 application/json:
6692 schema:
6693 $ref: '#/components/schemas/ProblemDetails'
6694 MethodNotAllowed:
6695 description: This method is not supported for the requested resource.
6696 content:
6697 application/json:
6698 schema:
6699 $ref: '#/components/schemas/ProblemDetails'
6700 NotAcceptable:
6701 description: The requested resource content cannot match the Accept headers sent in the request.
6702 content:
6703 application/json:
6704 schema:
6705 $ref: '#/components/schemas/ProblemDetails'
6706 Conflict:
6707 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6708 content:
6709 application/json:
6710 schema:
6711 $ref: '#/components/schemas/ProblemDetails'
6712 UnprocessableEntity:
6713 description: The request was well-formed but was unable to be followed due to semantic errors.
6714 content:
6715 application/json:
6716 schema:
6717 $ref: '#/components/schemas/ProblemDetails'
6718 InternalServerError:
6719 description: Internal server error.
6720 content:
6721 application/json:
6722 schema:
6723 $ref: '#/components/schemas/ProblemDetails'
6724 ServiceUnavailable:
6725 description: Service temporarily unavailable.
6726 content:
6727 application/json:
6728 schema:
6729 $ref: '#/components/schemas/ProblemDetails'
6730 UnexpectedError:
6731 description: Unexpected error.
6732 content:
6733 application/json:
6734 schema:
6735 $ref: '#/components/schemas/ProblemDetails'
delacruzramfb52ade2019-10-07 16:46:59 +02006736 VnfDescriptor:
6737 description: VNF Descriptor (plaintext)
6738 content:
6739 text/plain:
6740 schema:
6741 $ref: '#/components/schemas/VnfDescriptor'
6742 VnfPackage:
6743 description: VNF Package (compressed)
6744 content:
6745 application/zip:
6746 schema:
6747 $ref: '#/components/schemas/VnfPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +01006748 NsDescriptor:
delacruzramfb52ade2019-10-07 16:46:59 +02006749 description: NS Descriptor (plaintext)
6750 content:
6751 text/plain:
6752 schema:
6753 $ref: '#/components/schemas/NsDescriptor'
garciadeblas60e2ee92018-02-27 19:09:51 +01006754 NsPackage:
delacruzramfb52ade2019-10-07 16:46:59 +02006755 description: NS Package (compressed)
6756 content:
6757 application/zip:
6758 schema:
6759 $ref: '#/components/schemas/NsPackage'
6760 NetSliceTemplate:
6761 description: NetSlice Template (plaintext)
6762 content:
6763 text/plain:
6764 schema:
6765 $ref: '#/components/schemas/NetSliceTemplate'
6766 NetSlicePackage:
6767 description: NetSlice Package (compressed)
6768 content:
6769 application/zip:
6770 schema:
6771 $ref: '#/components/schemas/NetSlicePackage'
preethika.p31b3a802020-07-28 09:14:01 +00006772 NslcmSubscriptionResponse:
6773 description: NslcmSubscriptionResponse
6774 content:
6775 application/json:
6776 schema:
6777 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6778 application/yaml:
6779 schema:
6780 $ref: '#/components/schemas/NslcmSubscriptionResponse'
delacruzramfb52ade2019-10-07 16:46:59 +02006781 # END RESPONSES
6782
6783 schemas:
6784 ObjectId:
garciadeblas60e2ee92018-02-27 19:09:51 +01006785 type: object
6786 properties:
6787 id:
delacruzramfb52ade2019-10-07 16:46:59 +02006788 type: string
6789 format: uuid
6790 KeyValuePairs:
6791 # A free list of key:value pairs
6792 type: object
6793 additionalProperties: true
6794 NsDescriptor:
6795 type: string
6796 format: yaml|json
6797 NsPackage:
6798 type: string
6799 format: binary
6800 CreateNsdInfoRequest:
6801 # A free list of key:value pairs
6802 type: object
6803 additionalProperties: true
6804 NsdInfoModifications:
6805 description: |
6806 NS Descriptor Information
6807 Only generic fields (id, name, description) are described
6808 For a full specification of the NS Descriptor see:
6809 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6810 type: object
6811 properties:
6812 id:
6813 description: NSD Identifier
6814 type: string
6815 name:
6816 description: NSD Name
6817 type: string
6818 description:
6819 description: NSD Description
6820 type: string
Atul Agarwal4cd9e952021-05-20 09:24:26 +00006821 AlarmInfoModifications:
6822 description: |
6823 Alarm Information
6824 type: object
6825 properties:
6826 id:
6827 description: UUID
6828 type: string
6829 is_enable:
6830 description: To enable/disable the alarm.
6831 type: string
6832 threshold:
6833 description: Threshold value of the Alarm
6834 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006835 NsdInfo:
6836 description: |
6837 NS Descriptor Information
6838 Only generic fields (_id, id, name, description) are described
6839 For a full specification of the NS Descriptor see:
6840 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6841 type: object
6842 properties:
6843 _id:
garciadeblas60e2ee92018-02-27 19:09:51 +01006844 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +01006845 Identifier of the onboarded individual NS descriptor
6846 resource. This identifier is allocated by the NFVO.
garciadeblas60e2ee92018-02-27 19:09:51 +01006847 type: string
6848 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02006849 id:
garciadeblas60e2ee92018-02-27 19:09:51 +01006850 description: |
6851 This identifier, which is allocated by the NSD
6852 designer, identifies the NSD in a globally unique
6853 way. It is copied from the NSD content and shall be
6854 present after the NSD content is on-boarded.
6855 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006856 name:
garciadeblas60e2ee92018-02-27 19:09:51 +01006857 description: |
6858 Name of the onboarded NSD. This information is
6859 copied from the NSD content and shall be present
garciadeblas60e2ee92018-02-27 19:09:51 +01006860 after the NSD content is on-boarded.
6861 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006862 description:
garciadeblas60e2ee92018-02-27 19:09:51 +01006863 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02006864 Description of the onboarded NSD.
6865 This information is copied from the NSD content.
garciadeblas60e2ee92018-02-27 19:09:51 +01006866 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +01006867 required:
delacruzramfb52ade2019-10-07 16:46:59 +02006868 - _id
garciadeblas60e2ee92018-02-27 19:09:51 +01006869 - id
6870 ArrayOfNsdInfo:
6871 type: array
6872 items:
6873 $ref: '#/components/schemas/NsdInfo'
garciadeblas60e2ee92018-02-27 19:09:51 +01006874 ProblemDetails:
6875 type: object
6876 properties:
6877 type:
6878 type: string
6879 format: uri
6880 title:
6881 type: string
6882 status:
6883 type: integer
6884 detail:
6885 type: string
6886 instance:
6887 type: string
6888 format: uri
6889 additionalProperties: true
6890 required:
6891 - status
6892 - detail
kayal2001ae8f00a2024-06-24 18:04:47 +05306893 CreateNsConfigTemplateInfoRequest:
6894 type: object
6895 properties:
6896 name:
6897 description: Ns Config Template name
6898 type: string
6899 nsdId:
6900 description: |
6901 ID of NS descriptor to which
6902 template is associated
6903 type: string
6904 config:
6905 description: Instantiation parameters
6906 type: object
6907 additionalProperties: false
6908 required:
6909 - name
6910 - nsdId
6911 - config
6912 additionalProperties: false
6913 NsConfigTemplateInfo:
6914 description: |
6915 Ns Config template information includes NSD ID, name
6916 and instantiation parameters of vld, vnf, additionParamForVnf,
6917 additionalParamsForNs.
6918 type: object
6919 properties:
6920 _id:
6921 description: |
6922 Identifier of the inboarded Ns config template resource.
6923 type: string
6924 format: uuid
6925 name:
6926 description: |
6927 Name of the onboarded Ns config template. This information
6928 is given by the user and it is unique.
6929 type: string
6930 nsdId:
6931 description: |
6932 Identifier of the NS descriptor, which is associated
6933 with Ns config template
6934 type: string
6935 config:
6936 description: |
6937 It includes instantiation parameters such as
6938 vld, vnf, additionalParamforVnf.
6939 type: object
6940 ArrayOfNsConfigTemplateInfo:
6941 type: array
6942 items:
6943 $ref: '#/components/schemas/NsConfigTemplateInfo'
6944 NsConfigTemplateInfoModifications:
6945 description: |
6946 Ns Config Template information
6947 It includes name of the template and instantiation parameters.
6948 Ns descriptor id cannot be edited.
6949 type: object
6950 properties:
6951 name:
6952 description: |
6953 Name of the template
6954 type: string
6955 config:
6956 description: |
6957 Instantiation parameters such as vld, vnf, additionalParamsForVnf
6958 can be edit.
6959 type: object
garciadeblas63fe88c2018-02-28 19:32:41 +01006960 VnfDescriptor:
6961 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006962 format: yaml|json
garciadeblas63fe88c2018-02-28 19:32:41 +01006963 VnfPackage:
6964 type: string
6965 format: binary
6966 CreateVnfPkgInfoRequest:
delacruzramfb52ade2019-10-07 16:46:59 +02006967 # A free list of key:value pairs
garciadeblas63fe88c2018-02-28 19:32:41 +01006968 type: object
6969 additionalProperties: true
6970 VnfPkgInfoModifications:
delacruzramfb52ade2019-10-07 16:46:59 +02006971 description: |
6972 VNF Package Information
6973 Only generic fields (id, name, description) are described
6974 For a full specification of the VNF Descriptor see:
6975 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
garciadeblas63fe88c2018-02-28 19:32:41 +01006976 type: object
6977 properties:
6978 id:
delacruzramfb52ade2019-10-07 16:46:59 +02006979 description: VNF Package Identifier
6980 type: string
6981 name:
6982 description: VNF Package Name
6983 type: string
6984 description:
6985 description: VNF Package description
6986 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006987 VnfPkgInfo:
6988 description: |
6989 VNF Package Information
6990 Only generic fields (_id, id, name, description) are described
6991 For a full specification of the VNF Descriptor see:
6992 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6993 type: object
6994 properties:
6995 _id:
garciadeblas63fe88c2018-02-28 19:32:41 +01006996 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +01006997 Identifier of the VNF package. This identifier is allocated by the NFVO.
garciadeblas63fe88c2018-02-28 19:32:41 +01006998 type: string
6999 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007000 id:
7001 description: VNF Package Identifier
garciadeblas63fe88c2018-02-28 19:32:41 +01007002 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007003 name:
7004 description: VNF Package Name
garciadeblas63fe88c2018-02-28 19:32:41 +01007005 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007006 description:
7007 description: VNF Package description
garciadeblas63fe88c2018-02-28 19:32:41 +01007008 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01007009 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007010 - _id
garciadeblas63fe88c2018-02-28 19:32:41 +01007011 - id
garciadeblas63fe88c2018-02-28 19:32:41 +01007012 ArrayOfVnfPkgInfo:
7013 type: array
7014 items:
7015 $ref: '#/components/schemas/VnfPkgInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02007016 # CreateNsRequest:
7017 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +01007018 NsInstance:
delacruzramfb52ade2019-10-07 16:46:59 +02007019 description: |
7020 NS Instance Information
7021 Only generic fields (_id, id, name, description) are described
7022 For a full specification of the NS Instance see:
7023 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
garciadeblas12fcc4b2018-03-02 16:12:02 +01007024 type: object
7025 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007026 _id:
7027 description: Identifier of the NS instance.
7028 type: string
7029 format: uuid
garciadeblas12fcc4b2018-03-02 16:12:02 +01007030 id:
7031 description: Identifier of the NS instance.
7032 type: string
7033 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007034 name:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007035 description: Human readable name of the NS instance.
7036 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007037 description:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007038 description: Human readable description of the NS instance.
7039 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01007040 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007041 - _id
garciadeblas12fcc4b2018-03-02 16:12:02 +01007042 - id
delacruzramfb52ade2019-10-07 16:46:59 +02007043 - name
garciadeblas12fcc4b2018-03-02 16:12:02 +01007044 InstantiateNsRequest:
7045 type: object
7046 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007047 nsName:
7048 description: |
7049 Human-readable name of the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01007050 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007051 nsdId:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007052 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02007053 Identifier of the NSD that defines the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01007054 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007055 format: uuid
7056 vimAccountId:
garciadeblas12fcc4b2018-03-02 16:12:02 +01007057 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02007058 Identifier of the VIM Account where the NS instance shall be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01007059 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007060 format: uuid
kayal2001ae8f00a2024-06-24 18:04:47 +05307061 nsConfigTemplateId:
7062 description: |
7063 Identifier of the Ns config template which is selected
7064 while instantiation
7065 type: string
7066 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02007067 lcmOperationType:
7068 type: string
7069 nsInstanceId:
7070 type: string
7071 format: uuid
7072 netsliceInstanceId:
7073 type: string
7074 format: uuid
7075 nsDescription:
7076 type: string
7077 nullable: true
7078 wimAccountId:
7079 oneOf:
7080 - type: string
7081 - type: boolean
7082 nullable: true
7083 additionalParamsForNs:
7084 type: object
7085 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007086 additionalParamsForVnf: &additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +02007087 type: array
7088 items:
7089 type: object
7090 properties:
7091 member-vnf-index:
7092 type: string
7093 additionalParams:
7094 type: object
7095 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007096 k8s-namespace:
7097 type: string
7098 description: |
7099 use this namespace for all the KDU deployed in this VNF
7100 (if any). By default it is used the id of the project
delacruzramaf79f3c2019-10-22 13:13:01 +02007101 additionalParamsForVdu:
7102 type: array
7103 items:
7104 type: object
7105 properties:
7106 vdu_id:
7107 type: string
7108 additionalParams:
7109 type: object
7110 additionalProperties: true
7111 required:
7112 - vdu_id
7113 - additionalParams
7114 additionalProperties: false
7115 additionalParamsForKdu:
7116 type: array
7117 items:
7118 type: object
7119 properties:
7120 kdu_name:
7121 type: string
tiernof2c14402020-04-24 13:55:01 +00007122 k8s-namespace:
7123 type: string
7124 description: use this namespace for this KDU
7125 kdu_model:
7126 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +02007127 additionalParams:
7128 type: object
7129 additionalProperties: true
7130 required:
7131 - kdu_name
tiernof2c14402020-04-24 13:55:01 +00007132 minProperties: 2
delacruzramaf79f3c2019-10-22 13:13:01 +02007133 additionalProperties: false
7134 required:
7135 - member-vnf-index
7136 minProperties: 2
7137 additionalProperties: false
7138 ssh_keys:
7139 type: array
7140 items:
7141 type: string
7142 nsr_id:
7143 type: string
7144 format: uuid
7145 vduImage:
7146 type: string
tiernof2c14402020-04-24 13:55:01 +00007147 placement-engine:
7148 type: string
7149 description: |
7150 To compute automatically the target VIM for each VNF based on
7151 constrains, e.g. latency. Currently only 'PLA' is supported
7152 placement-constraints:
7153 type: object
7154 additionalProperties: true
7155 k8s-namespace:
7156 type: string
7157 timeout_ns_deploy:
7158 type: integer
delacruzramaf79f3c2019-10-22 13:13:01 +02007159 vnf:
7160 type: array
7161 items:
7162 type: object
7163 properties:
7164 member-vnf-index:
7165 type: string
7166 vimAccountId:
7167 type: string
7168 format: uuid
7169 vdu:
7170 type: array
7171 items:
7172 type: object
7173 properties:
7174 id:
7175 type: string
7176 volume:
7177 type: array
7178 items:
7179 type: object
7180 properties:
7181 name:
7182 type: string
7183 vim-volume-id:
7184 type: string
7185 required:
7186 - name
7187 - vim-volume-id
7188 additionalProperties: false
7189 minItems: 1
7190 interface:
7191 type: array
7192 items:
7193 type: object
7194 properties:
7195 name:
7196 type: string
7197 ip-address:
7198 type: string
7199 format: ipv4
7200 mac-address:
7201 type: string
7202 format: mac_address
7203 floating-ip-required:
7204 type: boolean
7205 required:
7206 - name
7207 additionalProperties: false
7208 minItems: 1
7209 required:
7210 - id
7211 additionalProperties: false
7212 minItems: 1
7213 internal-vld:
7214 type: array
7215 items:
7216 type: object
7217 properties:
7218 name:
7219 type: string
7220 vim-network-name:
7221 type: string
7222 vim-network-id:
7223 type: string
7224 ip-profile:
7225 type: object
7226 properties:
7227 ip-version:
7228 type: string
7229 enum:
7230 - ipv4
7231 - ipv6
7232 subnet-address:
7233 type: string
7234 format: ip_prefix
7235 nullable: true
7236 gateway-address:
7237 type: string
7238 format: ipv4
7239 nullable: true
7240 dns-server:
7241 type: array
7242 items:
7243 type: object
7244 properties:
7245 address:
7246 type: string
7247 format: ipv4
7248 required:
7249 - address
7250 additionalProperties: false
7251 minItems: 1
7252 nullable: true
7253 dhcp-params:
7254 type: object
7255 properties:
7256 enabled:
7257 type: boolean
7258 count:
7259 type: integer
7260 minimum: 1
7261 start-address:
7262 type: string
7263 format: ipv4
7264 additionalProperties: false
7265 nullable: true
7266 additionalProperties: false
7267 provider-network:
7268 type: object
7269 properties:
7270 physical-network:
7271 type: string
7272 segmentation-id:
7273 type: string
tiernof2c14402020-04-24 13:55:01 +00007274 network-type:
7275 type: string
7276 sdn-ports:
7277 description: |
7278 connect additional ports to the created underlay SDN connectivity.
7279 Normally for external connectivy.
7280 type: array
7281 items:
7282 type: object
7283 properties:
7284 switch_id:
7285 type: string
7286 switch_port:
7287 type: string
7288 mac_address:
7289 type: string
7290 format: mac_address
7291 vlan:
7292 type: integer
7293 additionalProperties: true
7294 required:
7295 - switch_id
7296 - switch_port
7297 minItems: 1
delacruzramaf79f3c2019-10-22 13:13:01 +02007298 additionalProperties: false
7299 internal-connection-point:
7300 type: array
7301 items:
7302 type: object
7303 properties:
7304 id-ref:
7305 type: string
7306 ip-address:
7307 type: string
7308 format: ipv4
7309 required:
7310 - id-ref
7311 minProperties: 2
7312 additionalProperties: False
7313 minItems: 1
7314 required:
7315 - name
7316 minProperties: 2
7317 additionalProperties: false
7318 minItems: 1
7319 required:
7320 - member-vnf-index
7321 minProperties: 2
7322 additionalProperties: false
7323 minItems: 1
7324 vld:
7325 type: array
7326 items:
7327 type: object
7328 properties:
7329 name:
7330 type: string
7331 vim-network-name:
7332 oneOf:
7333 - type: string
7334 - type: object
7335 vim-network-id:
7336 oneOf:
7337 - type: string
7338 - type: object
7339 ns-net:
7340 type: object
7341 additionalProperties: true
7342 wimAccountId:
7343 oneOf:
7344 - type: string
7345 - type: boolean
7346 nullable: true
7347 ip-profile:
7348 type: object
7349 additionalProperties: true
7350 provider-network:
7351 type: object
7352 properties:
7353 physical-network:
7354 type: string
7355 segmentation-id:
7356 type: string
7357 additionalProperties: false
7358 vnfd-connection-point-ref:
7359 type: array
7360 items:
7361 type: object
7362 properties:
7363 member-vnf-index-ref:
7364 type: string
7365 vnfd-connection-point-ref:
7366 type: string
7367 ip-address:
7368 type: string
7369 format: ipv4
7370 required:
7371 - member-vnf-index-ref
7372 - vnfd-connection-point-ref
7373 minProperties: 3
7374 additionalProperties: false
7375 minItems: 1
7376 required:
7377 - name
7378 additionalProperties: false
7379 minItems: 1
garciadeblas12fcc4b2018-03-02 16:12:02 +01007380 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007381 - nsName
7382 - nsdId
7383 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +02007384 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007385 ScaleNsRequest:
7386 type: object
garciadeblas12fcc4b2018-03-02 16:12:02 +01007387 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007388 scaleType:
7389 type: string
7390 enum:
7391 - SCALE_VNF
tiernof2c14402020-04-24 13:55:01 +00007392 timeout_ns_scale:
7393 description: timeout for the scale operation
7394 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +02007395 scaleVnfData:
7396 type: object
7397 properties:
7398 scaleVnfType:
7399 type: string
7400 enum:
7401 - SCALE_IN
7402 - SCALE_OUT
7403 scaleByStepData:
7404 type: object
7405 properties:
7406 scaling-group-descriptor:
7407 type: string
tiernof2c14402020-04-24 13:55:01 +00007408 scaling-policy:
7409 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007410 member-vnf-index:
7411 type: string
tiernof2c14402020-04-24 13:55:01 +00007412 required:
7413 - scaling-group-descriptor
7414 - member-vnf-index
7415 additionalProperties: false
7416 required:
7417 - scaleVnfType
7418 - scaleByStepData
7419 additionalProperties: false
7420 required:
7421 - scaleType
7422 - scaleVnfData
7423 additionalProperties: false
garciadeblasb5a065f2022-02-11 00:27:47 +01007424 HealNsRequest:
7425 description: >
7426 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
7427 instance by healing one or more of the VNF that are part of this NS.
7428 type: object
7429 properties:
7430 timeout_ns_heal:
7431 description: timeout for the heal operation in seconds
7432 type: integer
7433 healVnfData:
7434 description: >
7435 List of VNF to be healed, together with the information needed to heal each.
7436 type: array
7437 items:
7438 $ref: "#/components/schemas/HealVnfData"
7439 required:
7440 - healVnfData
7441 HealVnfData:
7442 description: >
7443 This type represents the information to heal a VNF that is part of an NS.
7444 type: object
7445 required:
7446 - vnfInstanceId
7447 properties:
7448 vnfInstanceId:
7449 description: >
7450 Identifies the VNF instance, part of the NS, requiring a
7451 healing action.
7452 type: string
7453 format: uuid
7454 cause:
7455 description: >
7456 Indicates the reason why a healing procedure is required.
7457 type: string
7458 additionalParams:
7459 description: >
7460 Additional parameters passed by the NFVO as input to
7461 the healing process, specific to the VNF being healed.
7462 type: object
7463 properties:
7464 run-day1:
7465 description: >
7466 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
7467 type: boolean
7468 default: false
7469 vdu:
7470 description: >
7471 List of VDU to be healed, together with the information needed to heal each.
7472 type: array
7473 items:
7474 $ref: "#/components/schemas/HealVduData"
7475 HealVduData:
7476 description: >
7477 This type represents the information to heal a VDU that is part of a VNF.
7478 type: object
7479 required:
7480 - vdu-id
7481 properties:
7482 vdu-id:
7483 description: >
7484 Identifies the VDU id, part of the VNF, requiring a healing action.
7485 type: string
7486 format: uuid
7487 count-index:
7488 description: >
7489 Indicates the VDU number when the VDU is part of a scale-group.
7490 type: integer
7491 minimum: 0
7492 run-day1:
7493 description: >
7494 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
7495 type: boolean
7496 default: false
elumalai4b120f12022-04-28 16:44:35 +05307497 NSinstanceMigrateRequest:
7498 description: >
7499 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
7500 instance by migrating one or more of the VDUs that are part of this NS.
7501 type: object
7502 properties:
7503 vnfInstanceId:
7504 type: string
7505 migrateToHost:
7506 type: string
7507 vdu:
7508 type: object
7509 properties:
7510 vduId:
7511 type: string
7512 vduCountIndex:
7513 type: integer
7514 required:
7515 - vduId
7516 required:
7517 - vnfInstanceId
7518 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007519 TerminateNsRequest:
7520 type: object
7521 properties:
tiernof2c14402020-04-24 13:55:01 +00007522 timeout_ns_terminate:
7523 description: timeout for terminate operation
7524 type: integer
7525 autoremove:
7526 description: remove network service if termination end without error
7527 type: boolean
7528 skip_terminate_primitives:
7529 description: Do not execute network service termination primitives
7530 type: boolean
7531 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007532 ArrayOfNsInstance:
7533 type: array
7534 items:
7535 $ref: '#/components/schemas/NsInstance'
delacruzramfb52ade2019-10-07 16:46:59 +02007536 NSinstanceActionRequest:
7537 type: object
7538 properties:
7539 primitive:
7540 type: string
tiernof2c14402020-04-24 13:55:01 +00007541 description: |
7542 name of the primitive in the 'config-descriptor'. If the target is
7543 a kdu it can be also 'status', 'rollback' or 'upgrade'
delacruzramfb52ade2019-10-07 16:46:59 +02007544 primitive_params:
tiernof2c14402020-04-24 13:55:01 +00007545 description: parameters of this primitive
delacruzramfb52ade2019-10-07 16:46:59 +02007546 $ref: '#/components/schemas/KeyValuePairs'
delacruzramfb52ade2019-10-07 16:46:59 +02007547 member_vnf_index:
7548 type: string
tiernof2c14402020-04-24 13:55:01 +00007549 description: provide if the target action is for a vnf, vdu or kdu
delacruzramfb52ade2019-10-07 16:46:59 +02007550 vdu_id:
7551 type: string
tiernof2c14402020-04-24 13:55:01 +00007552 description: provide if the target action is for a vdu
7553 kdu_name:
7554 type: string
7555 description: provide if the target action is for a kdu
delacruzramfb52ade2019-10-07 16:46:59 +02007556 vdu_count_index:
7557 type: integer
tiernof2c14402020-04-24 13:55:01 +00007558 timeout_ns_action:
7559 description: timeout for the day 1/2 operation
7560 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +02007561 required:
7562 - primitive
7563 - primitive_params
7564 additionalProperties: false
elumalaif2eb5e72022-03-21 19:44:39 +05307565 UpdateNsRequest:
7566 description: >
7567 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
7568 instance by updating one or more of the VNFs that are part of this NS.
7569 type: object
7570 properties:
7571 updateType:
7572 type: string
7573 enum:
7574 - CHANGE_VNFPKG
7575 - REMOVE_VNF
7576 - MODIFY_VNF_INFORMATION
k4.rahul66c884c2022-06-21 06:38:49 +00007577 - OPERATE_VNF
rahulkumarr7b6daf52024-06-20 05:23:01 +00007578 - VERTICAL_SCALE
elumalaif2eb5e72022-03-21 19:44:39 +05307579 changeVnfPackageData:
7580 type: object
7581 properties:
7582 vnfInstanceId:
7583 type: string
7584 vnfdId:
7585 type: string
7586 required:
7587 - vnfInstanceId
7588 - vnfdId
7589 removeVnfInstanceId:
7590 type: string
7591 modifyVnfInfoData:
7592 type: object
7593 properties:
7594 vnfInstanceId:
7595 type: string
7596 vnfdId:
7597 type: string
7598 required:
7599 - vnfInstanceId
7600 - vnfdId
k4.rahul66c884c2022-06-21 06:38:49 +00007601 operateVnfData:
7602 type: object
7603 properties:
7604 vnfInstanceId:
7605 type: string
7606 changeStateTo:
7607 type: string
7608 additionalParam:
7609 type: object
7610 properties:
7611 run-day1:
7612 type: boolean
7613 vdu_id:
7614 type: string
7615 count-index:
7616 type: number
7617 required:
7618 - vdu_id
7619 - count-index
7620 required:
7621 - vnfInstanceId
7622 - changeStateTo
7623 additionalProperties: false
rahulkumarr7b6daf52024-06-20 05:23:01 +00007624 verticalScaleVnf:
govindarajul36a93312022-06-21 13:36:22 +05307625 type: object
7626 properties:
7627 vnfInstanceId:
7628 type: string
rahulkumarr7b6daf52024-06-20 05:23:01 +00007629 vnfdId:
7630 type: string
7631 vduId:
7632 type: string
7633 countIndex:
7634 type: number
govindarajul36a93312022-06-21 13:36:22 +05307635 required:
7636 - vnfInstanceId
rahulkumarr7b6daf52024-06-20 05:23:01 +00007637 - vnfdId
7638 - vduId
govindarajul36a93312022-06-21 13:36:22 +05307639 required:
rahulkumarr7b6daf52024-06-20 05:23:01 +00007640 - updateType
govindarajul36a93312022-06-21 13:36:22 +05307641 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02007642 # CreateNSinstanceContentRequest:
7643 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007644 CreateNSinstanceContentResponse:
7645 type: object
7646 properties:
7647 id:
7648 type: string
7649 format: uuid
7650 nslcmop_id:
7651 type: string
7652 format: uuid
7653 NsLcmOpOcc:
7654 type: object
7655 properties:
7656 _id:
7657 type: string
7658 format: uuid
7659 id:
7660 type: string
7661 format: uuid
7662 lcmOperationType:
7663 type: string
7664 nsInstanceId:
7665 type: string
7666 format: uuid
7667 isAutomaticInvocation:
7668 type: boolean
7669 isCancelPending:
7670 type: boolean
7671 startTime:
7672 type: number
7673 format: float
7674 statusEnteredTime:
7675 type: number
7676 format: float
7677 operationParams:
7678 type: object
7679 properties:
7680 nsName:
7681 type: string
7682 nsdId:
7683 type: string
7684 format: uuid
7685 vimAccountId:
7686 type: string
7687 format: uuid
7688 nsInstanceId:
7689 type: string
7690 format: uuid
7691 lcmOperationType:
7692 type: string
7693 operationState:
7694 type: string
7695 detailed-status:
7696 type: string
7697 links:
7698 type: object
7699 properties:
7700 self:
7701 type: string
7702 format: path # uri?
7703 nsInstance:
7704 type: string
7705 format: path # uri?
7706 ArrayOfNsLcmOpOcc:
7707 type: array
7708 items:
7709 $ref: '#/components/schemas/NsLcmOpOcc'
7710 VnfInstanceInfo:
7711 description: |
7712 VNF Instance Information
7713 Only generic fields (_id, id) are described
7714 For a full specification of the VNF Instance see:
7715 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7716 type: object
7717 properties:
7718 _id:
7719 type: string
7720 format: uuid
7721 id:
7722 type: string
7723 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007724 ArrayOfVnfInstanceInfo:
7725 type: array
7726 items:
7727 $ref: '#/components/schemas/VnfInstanceInfo'
7728 NstInfo:
7729 description: |
7730 NetSlice Template Information
7731 Only generic fields (_id, id, name) are described
7732 For a full specification of the NetSlice Template see:
7733 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7734 type: object
7735 properties:
7736 _id:
7737 description: NetSlice Template Identifier
7738 type: string
7739 format: uuid
7740 id:
7741 description: Human readable NetSlice Template Identifier
7742 type: string
7743 name:
7744 description: Human readable name of the NetSlice Template
7745 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007746 ArrayOfNstInfo:
7747 type: array
7748 items:
7749 $ref: '#/components/schemas/NstInfo'
7750 CreateNstInfoRequest:
7751 # A free list of key:value pairs
7752 type: object
7753 additionalProperties: true
7754 NetSliceTemplate:
7755 type: string
7756 format: yaml|json
7757 NetSlicePackage:
7758 type: string
7759 format: binary
7760 NstInfoModifications:
7761 description: |
7762 NetSlice Template Information
7763 Only generic fields (id, name) are described
7764 For a full specification of the NetSlice Template see:
7765 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7766 type: object
7767 properties:
7768 id:
7769 description: NST Identifier
7770 type: string
7771 name:
7772 description: NST Name
7773 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007774 NetSliceInstance:
7775 description: |
7776 NetSlice Instance Information
7777 Only generic fields (_id, id, name, description) are described
7778 For a full specification of the NetSlice Instance see:
7779 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7780 type: object
7781 properties:
7782 _id:
7783 description: Identifier of the NetSlice instance.
7784 type: string
7785 format: uuid
7786 id:
7787 description: Identifier of the NetSlice instance.
7788 type: string
7789 format: uuid
7790 name:
7791 description: Human readable name of the NetSlice instance.
7792 type: string
7793 description:
7794 description: Human readable description of the NetSlice instance.
7795 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007796 required:
7797 - _id
7798 - id
7799 - name
7800 ArrayOfNetSliceInstance:
7801 type: array
7802 items:
7803 $ref: '#/components/schemas/NetSliceInstance'
Atul Agarwal4cd9e952021-05-20 09:24:26 +00007804 Alarm:
7805 description: |
7806 Alarm Information
7807 type: object
7808 properties:
7809 _id:
7810 description: Identifier of the Alarm.
7811 type: string
7812 format: uuid
7813 id:
7814 description: Identifier of the Alarm.
7815 type: string
7816 format: uuid
7817 metric:
7818 description: Alarm metric.
7819 type: string
7820 threshold:
7821 description: Threshold value of the Alarm.
7822 type: number
7823 format: float
7824 operation:
7825 description: Operation to be applied.
7826 type: string
7827 action:
7828 description: Action to be taken.
7829 type: string
7830 status:
7831 description: Current status of the alarm.
7832 type: string
7833 required:
7834 - _id
7835 - id
7836 - metric
7837 - threshold
7838 - operation
7839 ArrayOfAlarm:
7840 type: array
7841 items:
7842 $ref: '#/components/schemas/Alarm'
delacruzramaf79f3c2019-10-22 13:13:01 +02007843 # CreateNsiRequest:
7844 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007845 InstantiateNsiRequest:
7846 type: object
7847 properties:
7848 nsiName:
7849 description: |
7850 Human-readable name of the NetSlice instance to be created.
7851 type: string
7852 nstId:
7853 description: |
7854 Identifier of the NST that defines the NetSlice instance to be created.
7855 type: string
7856 format: uuid
7857 vimAccountId:
7858 description: |
7859 Identifier of the VIM Account where the NetSlice instance shall be created.
7860 type: string
7861 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02007862 lcmOperationType:
7863 type: string
7864 netsliceInstanceId:
7865 type: string
7866 format: uuid
7867 nsiDescription:
7868 type: string
7869 nullable: true
7870 ssh_keys:
7871 type: string
7872 nsi_id:
7873 type: string
7874 format: uuid
7875 additionalParamsForNsi:
7876 type: object
7877 additionalProperties: true
7878 netslice-subnet:
7879 type: array
7880 items:
7881 type: object
7882 properties:
7883 id:
7884 type: string
7885 nsName:
7886 type: string
7887 nsdId:
7888 type: string
7889 format: uuid
7890 vimAccountId:
7891 type: string
7892 format: uuid
7893 lcmOperationType:
7894 type: string
7895 nsInstanceId:
7896 type: string
7897 format: uuid
7898 netsliceInstanceId:
7899 type: string
7900 format: uuid
7901 nsDescription:
7902 type: string
7903 nullable: true
7904 wimAccountId:
7905 oneOf:
7906 - type: string
7907 - type: boolean
7908 nullable: true
7909 additionalParamsForNs:
7910 type: object
7911 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007912 additionalParamsForVnf: *additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +02007913 ssh_keys:
7914 type: array
7915 items:
7916 type: string
7917 nsr_id:
7918 type: string
7919 format: uuid
7920 vduImage:
7921 type: string
7922 vnf:
7923 type: array
7924 items:
7925 type: object
7926 properties:
7927 member-vnf-index:
7928 type: string
7929 vimAccountId:
7930 type: string
7931 format: uuid
7932 vdu:
7933 type: array
7934 items:
7935 type: object
7936 properties:
7937 id:
7938 type: string
7939 volume:
7940 type: array
7941 items:
7942 type: object
7943 properties:
7944 name:
7945 type: string
7946 vim-volume-id:
7947 type: string
7948 required:
7949 - name
7950 - vim-volume-id
7951 additionalProperties: false
7952 minItems: 1
7953 interface:
7954 type: array
7955 items:
7956 type: object
7957 properties:
7958 name:
7959 type: string
7960 ip-address:
7961 type: string
7962 format: ipv4
7963 mac-address:
7964 type: string
7965 format: mac_address
7966 floating-ip-required:
7967 type: boolean
7968 required:
7969 - name
7970 additionalProperties: false
7971 minItems: 1
7972 required:
7973 - id
7974 additionalProperties: false
7975 minItems: 1
7976 internal-vld:
7977 type: array
7978 items:
7979 type: object
7980 properties:
7981 name:
7982 type: string
7983 vim-network-name:
7984 type: string
7985 vim-network-id:
7986 type: string
7987 ip-profile:
7988 type: object
7989 properties:
7990 ip-version:
7991 type: string
7992 enum:
7993 - ipv4
7994 - ipv6
7995 subnet-address:
7996 type: string
7997 format: ip_prefix
7998 nullable: true
7999 gateway-address:
8000 type: string
8001 format: ipv4
8002 nullable: true
8003 dns-server:
8004 type: array
8005 items:
8006 type: object
8007 properties:
8008 address:
8009 type: string
8010 format: ipv4
8011 required:
8012 - address
8013 additionalProperties: false
8014 minItems: 1
8015 nullable: true
8016 dhcp-params:
8017 type: object
8018 properties:
8019 enabled:
8020 type: boolean
8021 count:
8022 type: integer
8023 minimum: 1
8024 start-address:
8025 type: string
8026 format: ipv4
8027 additionalProperties: false
8028 nullable: true
8029 additionalProperties: false
8030 provider-network:
8031 type: object
8032 properties:
8033 physical-network:
8034 type: string
8035 segmentation-id:
8036 type: string
8037 additionalProperties: false
8038 internal-connection-point:
8039 type: array
8040 items:
8041 type: object
8042 properties:
8043 id-ref:
8044 type: string
8045 ip-address:
8046 type: string
8047 format: ipv4
8048 required:
8049 - id-ref
8050 minProperties: 2
8051 additionalProperties: False
8052 minItems: 1
8053 required:
8054 - name
8055 minProperties: 2
8056 additionalProperties: false
8057 minItems: 1
8058 required:
8059 - member-vnf-index
8060 minProperties: 2
8061 additionalProperties: false
8062 minItems: 1
8063 vld:
8064 type: array
8065 items:
8066 type: object
8067 properties:
8068 name:
8069 type: string
8070 vim-network-name:
8071 oneOf:
8072 - type: string
8073 - type: object
8074 vim-network-id:
8075 oneOf:
8076 - type: string
8077 - type: object
8078 ns-net:
8079 type: object
8080 additionalProperties: true
8081 wimAccountId:
8082 oneOf:
8083 - type: string
8084 - type: boolean
8085 nullable: true
8086 ip-profile:
8087 type: object
8088 additionalProperties: true
8089 provider-network:
8090 type: object
8091 properties:
8092 physical-network:
8093 type: string
8094 segmentation-id:
8095 type: string
8096 additionalProperties: false
8097 vnfd-connection-point-ref:
8098 type: array
8099 items:
8100 type: object
8101 properties:
8102 member-vnf-index-ref:
8103 type: string
8104 vnfd-connection-point-ref:
8105 type: string
8106 ip-address:
8107 type: string
8108 format: ipv4
8109 required:
8110 - member-vnf-index-ref
8111 - vnfd-connection-point-ref
8112 minProperties: 3
8113 additionalProperties: false
8114 minItems: 1
8115 required:
8116 - name
8117 additionalProperties: false
8118 minItems: 1
8119 additionalProperties: false
8120 minItems: 1
8121 netslice-vld:
8122 type: array
8123 items:
8124 type: object
8125 properties:
8126 name:
8127 type: string
8128 vim-network-name:
8129 oneOf:
8130 - type: string
8131 - type: object
8132 vim-network-id:
8133 oneOf:
8134 - type: string
8135 - type: object
8136 ip-profile:
8137 type: object
8138 additionalProperties: true
8139 required:
8140 - name
8141 additionalProperties: false
8142 minItems: 1
delacruzramfb52ade2019-10-07 16:46:59 +02008143 required:
8144 - nsiName
8145 - nstId
8146 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +02008147 additionalProperties: false
delacruzramfb52ade2019-10-07 16:46:59 +02008148 TerminateNsiRequest:
8149 type: object
8150 properties:
8151 terminationTime:
8152 description: |
8153 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
8154 automatically at this timestamp. Cardinality "0" indicates the NSI termination
8155 takes place immediately.
8156 type: string
8157 format: date-time
8158 NsiActionRequest:
8159 type: object
8160 properties:
8161 primitive:
8162 type: string
8163 primitive_params:
8164 $ref: '#/components/schemas/KeyValuePairs'
8165 lcmOperationType:
8166 type: string
8167 netsliceInstanceId:
8168 type: string
8169 format: uuid
8170 required:
8171 - primitive
8172 - primitive_params
delacruzramaf79f3c2019-10-22 13:13:01 +02008173 # CreateNsiContentRequest:
8174 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02008175 CreateNsiContentResponse:
8176 type: object
8177 properties:
8178 id:
8179 type: string
8180 format: uuid
8181 nsilcmop_id:
8182 type: string
8183 format: uuid
8184 NsiLcmOpOcc:
8185 type: object
8186 properties:
8187 _id:
8188 type: string
8189 format: uuid
8190 id:
8191 type: string
8192 format: uuid
8193 lcmOperationType:
8194 type: string
8195 netsliceInstanceId:
8196 type: string
8197 format: uuid
8198 isAutomaticInvocation:
8199 type: boolean
8200 isCancelPending:
8201 type: boolean
8202 startTime:
8203 type: number
8204 format: float
8205 statusEnteredTime:
8206 type: number
8207 format: float
8208 operationParams:
8209 type: object
8210 properties:
8211 nsiName:
8212 type: string
8213 nstId:
8214 type: string
8215 format: uuid
8216 vimAccountId:
8217 type: string
8218 format: uuid
8219 netsliceInstanceId:
8220 type: string
8221 format: uuid
8222 lcmOperationType:
8223 type: string
8224 nslcmops_ids:
8225 type: array
8226 items:
8227 type: string
8228 format: uuid
8229 operationState:
8230 type: string
8231 detailed-status:
8232 type: string
8233 links:
8234 type: object
8235 properties:
8236 self:
8237 type: string
8238 format: path # uri?
8239 netsliceInstanceId:
8240 type: string
8241 format: path # uri?
8242 ArrayOfNsiLcmOpOcc:
8243 type: array
8244 items:
8245 $ref: '#/components/schemas/NsiLcmOpOcc'
delacruzramaf79f3c2019-10-22 13:13:01 +02008246 TokenInfo:
8247 type: object
8248 properties:
8249 _id:
8250 type: string
8251 id:
8252 type: string
8253 admin:
8254 type: boolean
selvi.j9058fd92023-04-18 14:58:14 +00008255 admin_show:
8256 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +02008257 project_id:
8258 type: string
8259 format: uuid
8260 user_id:
8261 type: string
8262 format: uuid
8263 project_name:
8264 type: string
8265 username:
8266 type: string
8267 issued_at:
8268 type: number
8269 format: float
selvi.j9058fd92023-04-18 14:58:14 +00008270 user_show:
8271 type: boolean
8272 last_login:
8273 type: number
8274 format: float
8275 login_count:
8276 type: number
delacruzramaf79f3c2019-10-22 13:13:01 +02008277 expires:
8278 type: number
8279 format: float
8280 remote_host:
8281 type: string
8282 format: ipv4
8283 remote_port:
8284 type: integer
8285 roles:
8286 type: array
8287 items:
8288 type: object
8289 properties:
8290 id:
8291 type: string
8292 format: uuid
8293 name:
8294 type: string
selvi.ja6f638b2022-03-23 12:27:35 +00008295 PasswordExpiryInfo:
8296 type: object
8297 properties:
8298 id:
8299 type: string
8300 message:
8301 type: string
8302 user_id:
8303 type: string
8304 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008305 ArrayOfTokenInfo:
8306 type: array
8307 items:
8308 $ref: '#/components/schemas/TokenInfo'
8309 CreateTokenRequest:
8310 type: object
8311 properties:
8312 username:
8313 type: string
8314 password:
8315 type: string
8316 project_id:
8317 type: string
8318 required:
8319 - username
8320 - password
8321 UserInfo:
8322 type: object
8323 properties:
8324 _id:
8325 type: string
8326 format: uuid
8327 username:
8328 type: string
8329 password:
8330 type: string
8331 project_role_mappings:
8332 type: array
8333 items:
8334 type: object
8335 properties:
8336 project:
8337 type: string
8338 format: uuid
8339 role:
8340 type: string
8341 format: uuid
8342 project_name:
8343 type: string
8344 role_name:
8345 type: string
8346 projects:
8347 type: array
8348 items:
8349 type: string
8350 ArrayOfUserInfo:
8351 type: array
8352 items:
8353 $ref: '#/components/schemas/UserInfo'
8354 ProjectRoleMappings:
8355 type: array
8356 items:
8357 type: object
8358 properties:
8359 project:
8360 type: string
8361 role:
8362 type: string
8363 required:
8364 - project
8365 - role
8366 additionalProperties: false
8367 ProjectRoleMappingsOpt:
8368 type: array
8369 items:
8370 type: object
8371 properties:
8372 project:
8373 type: string
8374 role:
8375 type: string
8376 required:
8377 - project
8378 additionalProperties: false
8379 CreateUserRequest:
8380 type: object
8381 properties:
8382 username:
8383 type: string
8384 password:
8385 type: string
8386 projects:
8387 type: array
8388 items:
8389 type: string
8390 project_role_mappings:
8391 $ref: '#/components/schemas/ProjectRoleMappings'
8392 required:
8393 - username
8394 - password
8395 additionalProperties: false
8396 ShortNameList:
8397 type: array
8398 items:
8399 type: string
8400 ArrayEditionSchema:
8401 type: object
8402 additionalProperties: true
8403 minProperties: 1
8404 description: |
8405 Array edition keys must start with '$'
8406 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
8407 EditUserRequest:
8408 type: object
8409 properties:
8410 username:
8411 type: string
8412 password:
8413 type: string
selvi.j9058fd92023-04-18 14:58:14 +00008414 old_password:
8415 type: string
8416 system_admin_id:
8417 type: string
8418 format: uuid
8419 unlock:
8420 type: boolean
8421 renew:
8422 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +02008423 projects:
8424 oneOf:
8425 - $ref: '#/components/schemas/ShortNameList'
8426 - $ref: '#/components/schemas/ArrayEditionSchema'
8427 project_role_mappings:
8428 $ref: '#/components/schemas/ProjectRoleMappings'
8429 add_project_role_mappings:
8430 $ref: '#/components/schemas/ProjectRoleMappings'
8431 remove_project_role_mappings:
8432 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
8433 QuotasInfo:
8434 type: object
8435 properties:
8436 vnfds:
8437 type: integer
8438 minimum: 0
8439 nullable: false
8440 nsds:
8441 type: integer
8442 minimum: 0
8443 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008444 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +02008445 type: integer
8446 minimum: 0
8447 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008448 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +02008449 type: integer
8450 minimum: 0
8451 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008452 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008453 type: integer
8454 minimum: 0
8455 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008456 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008457 type: integer
8458 minimum: 0
8459 nullable: false
8460 vim_accounts:
8461 type: integer
8462 minimum: 0
8463 nullable: false
8464 wim_accounts:
8465 type: integer
8466 minimum: 0
8467 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008468 sdn_controllers:
8469 type: integer
8470 minimum: 0
8471 nullable: false
8472 k8sclusters:
8473 type: integer
8474 minimum: 0
8475 nullable: false
David Garciaaf38fce2021-05-04 12:48:04 +02008476 vca:
8477 type: integer
8478 minimum: 0
8479 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008480 k8srepos:
8481 type: integer
8482 minimum: 0
8483 nullable: false
8484 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +02008485 type: integer
8486 minimum: 0
8487 nullable: false
8488 additionalProperties: false
8489 EditQuotasInfo:
8490 type: object
8491 properties:
8492 vnfds:
8493 type: integer
8494 minimum: 0
8495 nullable: true
8496 nsds:
8497 type: integer
8498 minimum: 0
8499 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008500 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +02008501 type: integer
8502 minimum: 0
8503 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008504 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +02008505 type: integer
8506 minimum: 0
8507 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008508 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008509 type: integer
8510 minimum: 0
8511 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008512 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008513 type: integer
8514 minimum: 0
8515 nullable: true
8516 vim_accounts:
8517 type: integer
8518 minimum: 0
8519 nullable: true
8520 wim_accounts:
8521 type: integer
8522 minimum: 0
8523 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008524 sdn_controllers:
8525 type: integer
8526 minimum: 0
8527 nullable: true
8528 k8sclusters:
8529 type: integer
8530 minimum: 0
8531 nullable: true
David Garciaaf38fce2021-05-04 12:48:04 +02008532 vca:
8533 type: integer
8534 minimum: 0
8535 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008536 k8srepos:
8537 type: integer
8538 minimum: 0
8539 nullable: true
8540 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +02008541 type: integer
8542 minimum: 0
8543 nullable: true
8544 additionalProperties: false
8545 ProjectInfo:
8546 type: object
8547 properties:
8548 _id:
8549 type: string
8550 format: uuid
8551 name:
8552 type: string
8553 quotas:
8554 $ref: '#/components/schemas/QuotasInfo'
8555 ArrayOfProjectInfo:
8556 type: array
8557 items:
8558 $ref: '#/components/schemas/ProjectInfo'
8559 CreateProjectRequest:
8560 type: object
8561 properties:
8562 name:
8563 type: string
8564 admin:
8565 type: boolean
8566 quotas:
8567 $ref: '#/components/schemas/QuotasInfo'
8568 required:
8569 - name
8570 additionalProperties: false
8571 EditProjectRequest:
8572 type: object
8573 properties:
8574 name:
8575 type: string
8576 admin:
8577 type: boolean
8578 quotas:
8579 $ref: '#/components/schemas/EditQuotasInfo'
8580 additionalProperties: false
8581 PermissionsInfo:
8582 type: object
8583 additionalProperties:
8584 type: boolean
8585 nullable: false
8586 description: |
8587 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8588 Permission values are either true or false
8589 EditPermissionsInfo:
8590 type: object
8591 additionalProperties:
8592 type: boolean
8593 nullable: true
8594 description: |
8595 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8596 Permission values are either true, false, or null
8597 RoleInfo:
8598 type: object
8599 properties:
8600 _id:
8601 type: string
8602 format: uuid
8603 name:
8604 type: string
8605 permissions:
8606 $ref: '#/components/schemas/PermissionsInfo'
8607 ArrayOfRoleInfo:
8608 type: array
8609 items:
8610 $ref: '#/components/schemas/RoleInfo'
8611 CreateRoleRequest:
8612 type: object
8613 properties:
8614 name:
8615 type: string
8616 permissions:
8617 $ref: '#/components/schemas/PermissionsInfo'
8618 required:
8619 - name
8620 additionalProperties: false
8621 EditRoleRequest:
8622 type: object
8623 properties:
8624 name:
8625 type: string
8626 permissions:
8627 $ref: '#/components/schemas/EditPermissionsInfo'
8628 additionalProperties: false
8629 VimType:
8630 type: string
8631 enum:
8632 - openvim
8633 - openstack
8634 - vmware
8635 - opennebula
8636 - aws
8637 - azure
8638 - fos
8639 VimInfo:
8640 type: object
8641 properties:
8642 _id:
8643 type: string
8644 format: uuid
8645 schema_version:
8646 type: string
8647 format: X.Y[.Z]
8648 schema_type:
8649 type: string
8650 name:
8651 type: string
8652 description:
8653 type: string
8654 vim:
8655 type: string
8656 datacenter:
8657 type: string
8658 vim_type:
8659 $ref: '#/components/schemas/VimType'
8660 vim_url:
8661 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008662 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008663 vim_tenant_name:
8664 type: string
8665 vim_user:
8666 type: string
8667 vim_password:
8668 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008669 vca:
8670 type: string
8671 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008672 config:
8673 type: object
8674 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +00008675 resources:
8676 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +02008677 ArrayOfVimInfo:
8678 type: array
8679 items:
8680 $ref: '#/components/schemas/VimInfo'
8681 CreateVimRequest:
8682 type: object
8683 properties:
8684 schema_version:
8685 type: string
8686 format: X.Y[.Z]
8687 schema_type:
8688 type: string
8689 name:
8690 type: string
8691 description:
8692 type: string
8693 vim:
8694 type: string
8695 datacenter:
8696 type: string
8697 vim_type:
8698 $ref: '#/components/schemas/VimType'
8699 vim_url:
8700 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008701 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008702 vim_tenant_name:
8703 type: string
8704 vim_user:
8705 type: string
8706 vim_password:
8707 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008708 vca:
8709 type: string
8710 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008711 config:
8712 type: object
8713 additionalProperties: true
garciadeblas6229f2f2022-11-24 15:03:56 +01008714 prometheus-config:
8715 type: object
8716 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +00008717 resources:
8718 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +02008719 required:
8720 - name
8721 - vim_url
8722 - vim_type
8723 - vim_user
8724 - vim_password
8725 - vim_tenant_name
8726 additionalProperties: false
8727 EditVimRequest:
8728 type: object
8729 properties:
8730 name:
8731 type: string
8732 description:
8733 type: string
8734 vim:
8735 type: string
8736 datacenter:
8737 type: string
8738 vim_type:
8739 $ref: '#/components/schemas/VimType'
8740 vim_url:
8741 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008742 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008743 vim_tenant_name:
8744 type: string
8745 vim_user:
8746 type: string
8747 vim_password:
8748 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008749 vca:
8750 type: string
8751 format: uuid
garciadeblas6229f2f2022-11-24 15:03:56 +01008752 prometheus-config:
8753 type: object
8754 additionalProperties: true
delacruzramaf79f3c2019-10-22 13:13:01 +02008755 config:
8756 type: object
8757 additionalProperties: true
8758 additionalProperties: false
8759 ObjectId_plus_OpId:
8760 type: object
8761 properties:
8762 id:
8763 type: string
8764 format: uuid
8765 op_id:
8766 type: string
8767 format: uuid
8768 OpId:
8769 type: object
8770 properties:
8771 op_id:
8772 type: string
8773 format: uuid
8774 WimType:
8775 type: string
8776 enum:
8777 - onos
8778 - odl
8779 - tapi
8780 - dynpac
8781 - fake
8782 WimInfo:
8783 type: object
8784 properties:
8785 _id:
8786 type: string
8787 format: uuid
8788 schema_version:
8789 type: string
8790 format: X.Y[.Z]
8791 schema_type:
8792 type: string
8793 name:
8794 type: string
8795 description:
8796 type: string
8797 wim:
8798 type: string
8799 wim_type:
8800 $ref: '#/components/schemas/WimType'
8801 wim_url:
8802 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008803 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008804 user:
8805 type: string
8806 password:
8807 type: string
8808 config:
8809 type: object
8810 additionalProperties: true
8811 ArrayOfWimInfo:
8812 type: array
8813 items:
8814 $ref: '#/components/schemas/WimInfo'
8815 CreateWimRequest:
8816 type: object
8817 properties:
8818 schema_version:
8819 type: string
8820 format: X.Y[.Z]
8821 schema_type:
8822 type: string
8823 name:
8824 type: string
8825 description:
8826 type: string
8827 wim:
8828 type: string
8829 wim_type:
8830 $ref: '#/components/schemas/WimType'
8831 wim_url:
8832 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008833 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008834 user:
8835 type: string
8836 password:
8837 type: string
8838 config:
8839 type: object
8840 additionalProperties: true
8841 required:
8842 - name
8843 - wim_url
8844 - wim_type
8845 additionalProperties: false
8846 EditWimRequest:
8847 type: object
8848 properties:
8849 name:
8850 type: string
8851 description:
8852 type: string
8853 wim:
8854 type: string
8855 wim_type:
8856 type: string
8857 wim_url:
8858 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008859 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008860 user:
8861 type: string
8862 password:
8863 type: string
8864 config:
8865 type: object
8866 additionalProperties: true
8867 additionalProperties: false
8868 SdnBasicProperties:
8869 type: object
8870 properties:
8871 name:
8872 type: string
8873 description:
8874 type: string
8875 dpid:
8876 type: string
8877 format: mac_address
8878 ip:
8879 type: string
8880 format: ipv4
8881 port:
8882 type: integer
8883 type:
8884 type: string
8885 enum:
8886 - floodlight
8887 - opendaylight
8888 - onos
8889 version:
8890 type: string
8891 user:
8892 type: string
8893 password:
8894 type: string
8895 SdnExtraProperties:
8896 type: object
8897 properties:
8898 _id:
8899 type: string
8900 format: uuid
8901 schema_version:
8902 type: string
8903 format: X.Y[.Z]
8904 SdnInfo:
8905 allOf:
8906 - $ref: '#/components/schemas/SdnExtraProperties'
8907 - $ref: '#/components/schemas/SdnBasicProperties'
8908 ArrayOfSdnInfo:
8909 type: array
8910 items:
8911 $ref: '#/components/schemas/SdnInfo'
8912 CreateSdnRequest:
8913 allOf:
8914 - $ref: '#/components/schemas/SdnBasicProperties'
8915 required:
8916 - name
8917 - type
8918 - ip
8919 - port
8920 - dpid
8921 additionalProperties: false
8922 EditSdnRequest:
8923 allOf:
8924 - $ref: '#/components/schemas/SdnBasicProperties'
8925 additionalProperties: false
8926 NsPmJobReportInfo:
8927 type: object
8928 properties:
8929 entries:
8930 type: array
8931 items:
8932 type: object
8933 properties:
8934 objectInstanceId:
8935 type: string
8936 format: uuid
8937 performanceMetric:
8938 type: string
8939 performanceValue:
8940 type: object
8941 properties:
8942 performanceValue:
8943 type: object
8944 properties:
8945 performanceValue:
8946 type: number
8947 vnfMemberIndex:
8948 type: string
8949 vduName:
8950 type: string
8951 timestamp:
8952 type: number
8953 PduInterfaces:
8954 type: array
8955 items:
8956 type: object
8957 properties:
8958 name:
8959 type: string
8960 mgmt:
8961 type: boolean
8962 type:
8963 type: string
8964 enum:
8965 - overlay
8966 - underlay
8967 ip-address:
8968 type: string
8969 format: ipv4
8970 mac-address:
8971 type: string
8972 format: mac_address
8973 vim-network-name:
8974 type: string
8975 vim-network-id:
8976 type: string
8977 required:
8978 - name
8979 - mgmt
8980 - ip-address
8981 additionalProperties: false
8982 PduInfo:
8983 type: object
8984 properties:
8985 _id:
8986 type: string
8987 format: uuid
8988 name:
8989 type: string
8990 type:
8991 type: string
8992 description:
8993 type: string
8994 shared:
8995 type: boolean
8996 vims:
8997 type: array
8998 items:
8999 type: string
9000 vim_accounts:
9001 type: array
9002 items:
9003 type: string
9004 interfaces:
9005 $ref: '#/components/schemas/PduInterfaces'
9006 ArrayOfPduInfo:
9007 type: array
9008 items:
9009 $ref: '#/components/schemas/PduInfo'
9010 CreatePduRequest:
9011 type: object
9012 properties:
9013 name:
9014 type: string
9015 type:
9016 type: string
9017 description:
9018 type: string
9019 shared:
9020 type: boolean
9021 vims:
9022 type: array
9023 items:
9024 type: string
9025 vim_accounts:
9026 type: array
9027 items:
9028 type: string
9029 interfaces:
9030 $ref: '#/components/schemas/PduInterfaces'
9031 required:
9032 - name
9033 - type
9034 - interfaces
9035 additionalProperties: false
9036 EditPduRequest:
9037 type: object
9038 properties:
9039 name:
9040 type: string
9041 type:
9042 type: string
9043 description:
9044 type: string
9045 shared:
9046 type: boolean
9047 vims:
9048 type: array
9049 items:
9050 type: string
9051 vim_accounts:
9052 type: array
9053 items:
9054 type: string
9055 interfaces:
9056 $ref: '#/components/schemas/PduInterfaces'
9057 additionalProperties: false
9058 K8sClusterNetList:
9059 type: array
9060 items:
9061 type: object
Gabriel Cubab77d0df2022-03-22 14:43:11 -05009062 additionalProperties: false
9063 K8sClusterDeploymentMethods:
9064 type: object
9065 properties:
Gabriel Cubab77d0df2022-03-22 14:43:11 -05009066 juju-bundle:
9067 type: boolean
9068 helm-chart-v3:
9069 type: boolean
9070 additionalProperties: false
9071 minProperties: 3
delacruzramaf79f3c2019-10-22 13:13:01 +02009072 K8sClusterInfo:
9073 type: object
9074 properties:
9075 _id:
9076 type: string
9077 format: uuid
9078 schema_version:
9079 type: string
9080 format: X.Y[.Z]
9081 schema_type:
9082 type: string
9083 name:
9084 type: string
9085 description:
9086 type: string
9087 credentials:
9088 type: object
9089 additionalProperties: true
9090 vim_account:
9091 type: string
9092 format: uuid
9093 k8s_version:
9094 type: string
9095 nets:
9096 $ref: '#/components/schemas/K8sClusterNetList'
Gabriel Cubab77d0df2022-03-22 14:43:11 -05009097 deployment_methods:
9098 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
delacruzramaf79f3c2019-10-22 13:13:01 +02009099 namespace:
9100 type: string
9101 cni:
9102 type: array
9103 items:
9104 type: string
9105 ArrayOfK8sClusterInfo:
9106 type: array
9107 items:
9108 $ref: '#/components/schemas/K8sClusterInfo'
9109 CreateK8sClusterRequest:
9110 type: object
9111 properties:
9112 schema_version:
9113 type: string
9114 format: X.Y[.Z]
9115 schema_type:
9116 type: string
9117 name:
9118 type: string
9119 description:
9120 type: string
9121 credentials:
9122 type: object
9123 additionalProperties: true
9124 vim_account:
9125 type: string
9126 format: uuid
9127 k8s_version:
9128 type: string
9129 nets:
9130 $ref: '#/components/schemas/K8sClusterNetList'
9131 namespace:
9132 type: string
9133 cni:
9134 type: array
9135 items:
9136 type: string
9137 required:
9138 - name
9139 - credentials
9140 - vim_account
9141 - k8s_version
9142 - nets
9143 additionalProperties: false
9144 EditK8sClusterRequest:
9145 type: object
9146 properties:
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'
9161 namespace:
9162 type: string
9163 cni:
9164 type: array
9165 items:
9166 type: string
9167 additionalProperties: false
David Garciaaf38fce2021-05-04 12:48:04 +02009168 VcaInfo:
9169 type: object
9170 properties:
9171 _id:
9172 type: string
9173 format: uuid
9174 schema_version:
9175 type: string
9176 format: X.Y[.Z]
9177 schema_type:
9178 type: string
9179 name:
9180 type: string
9181 description:
9182 type: string
9183 endpoints:
9184 type: string
9185 user:
9186 type: string
9187 secret:
9188 type: string
9189 cacert:
9190 type: string
9191 lxd-cloud:
9192 type: string
9193 lxd-credentials:
9194 type: string
9195 k8s-cloud:
9196 type: string
9197 k8s-credentials:
9198 type: string
9199 model-config:
9200 type: object
9201 additionalProperties: true
9202 ArrayOfVcaInfo:
9203 type: array
9204 items:
9205 $ref: '#/components/schemas/VcaInfo'
9206 CreateVcaRequest:
9207 type: object
9208 properties:
9209 schema_version:
9210 type: string
9211 format: X.Y[.Z]
9212 schema_type:
9213 type: string
9214 name:
9215 type: string
9216 description:
9217 type: string
9218 endpoints:
9219 type: string
9220 user:
9221 type: string
9222 secret:
9223 type: string
9224 cacert:
9225 type: string
9226 lxd-cloud:
9227 type: string
9228 lxd-credentials:
9229 type: string
9230 k8s-cloud:
9231 type: string
9232 k8s-credentials:
9233 type: string
9234 model-config:
9235 type: object
9236 additionalProperties: true
9237 required:
9238 - name
9239 - endpoints
9240 - user
9241 - secret
9242 - cacert
9243 - lxd-cloud
9244 - lxd-credentials
9245 - k8s-cloud
9246 - k8s-credentials
9247 additionalProperties: false
9248 EditVcaRequest:
9249 type: object
9250 properties:
9251 name:
9252 type: string
9253 description:
9254 type: string
9255 endpoints:
9256 type: string
9257 user:
9258 type: string
9259 secret:
9260 type: string
9261 cacert:
9262 type: string
9263 lxd-cloud:
9264 type: string
9265 lxd-credentials:
9266 type: string
9267 k8s-cloud:
9268 type: string
9269 k8s-credentials:
9270 type: string
9271 model-config:
9272 type: object
9273 additionalProperties: true
9274 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02009275 K8sRepoType:
9276 type: string
9277 enum:
9278 - chart
9279 - bundle
9280 K8sRepoInfo:
9281 type: object
9282 properties:
9283 _id:
9284 type: string
9285 format: uuid
9286 name:
9287 type: string
9288 description:
9289 type: string
9290 type:
9291 $ref: '#/components/schemas/K8sRepoType'
9292 url:
9293 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01009294 format: uri
garciadeblas8bb3cce2022-02-11 00:41:18 +01009295 username:
9296 type: string
9297 description: repository username
9298 password:
9299 type: string
9300 description: repository password
9301 ca-file:
9302 type: string
9303 description: verify certificates of HTTPS-enabled servers using this CA bundle
9304 cert-file:
9305 type: string
9306 description: identify HTTPS client using this SSL certificate file
9307 skip-tls-verify:
9308 type: boolean
9309 description: skip tls certificate checks for the repository
9310 key-file:
9311 type: string
9312 description: identify HTTPS client using this SSL key file
garciadeblas0881dcf2023-10-20 12:00:08 +02009313 oci:
9314 type: boolean
9315 default: false
9316 description: >
9317 Flag to indicate whether or not it is an OCI-enabled repo (default: false)
9318 required:
9319 - name
9320 - type
9321 - url
9322 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02009323 ArrayOfK8sRepoInfo:
9324 type: array
9325 items:
9326 $ref: '#/components/schemas/K8sRepoInfo'
9327 CreateK8sRepoRequest:
9328 type: object
9329 properties:
9330 name:
9331 type: string
9332 description:
9333 type: string
9334 type:
9335 $ref: '#/components/schemas/K8sRepoType'
9336 url:
9337 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01009338 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02009339 required:
9340 - name
9341 - type
9342 - url
9343 additionalProperties: false
preethika.p31b3a802020-07-28 09:14:01 +00009344 NslcmSubscriptionResponse:
9345 type: object
9346 properties:
9347 id:
9348 type: string
9349 format: uuid
9350 filter:
9351 type: object
9352 CallbackUri:
9353 type: string
9354 format: uri
9355 _links:
9356 type: object
9357 NslcmSubscriptionInfo:
9358 type: object
9359 properties:
9360 _id:
9361 type: string
9362 format: uuid
9363 _admin:
9364 type: object
9365 schema_version:
9366 type: string
9367 format: 'X.Y[.Z]'
9368 CallbackUri:
9369 type: string
9370 format: uri
9371 filter:
9372 type: object
9373 authentication:
9374 $ref: '#/components/schemas/Authenticationschema'
9375 ArrayOfNslcmSubscriptionInfo:
9376 type: array
9377 items:
9378 $ref: '#/components/schemas/NslcmSubscriptionInfo'
9379 NsInstanceSubscriptionFilter:
9380 description: |
9381 used to identify the network service
9382 type: object
9383 oneOf:
9384 - $ref: '#/components/schemas/nsdIds'
9385 - $ref: '#/components/schemas/vnfdIds'
9386 - $ref: '#/components/schemas/pnfdIds'
9387 - $ref: '#/components/schemas/nsInstanceIds'
9388 - $ref: '#/components/schemas/nsInstanceNames'
9389 nsdIds:
9390 type: array
9391 items:
9392 type: string
9393 vnfdIds:
9394 type: array
9395 items:
9396 type: string
9397 pnfdIds:
9398 type: array
9399 items:
9400 type: string
9401 nsInstanceIds:
9402 type: array
9403 items:
9404 type: string
9405 nsInstanceNames:
9406 type: array
9407 items:
9408 type: string
9409 Nslcmsubschema:
9410 type: object
9411 properties:
9412 nsInstanceSubscriptionFilter:
9413 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
9414 notificationTypes:
9415 description: |
9416 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
9417 type: array
9418 items:
9419 type: string
9420 enum:
9421 - NsIdentifierCreationNotification
9422 - NsIdentifierDeletionNotification
9423 - NsLcmOperationOccurrenceNotification
9424 - NsChangeNotification
9425 operationTypes:
9426 type: array
9427 items:
9428 type: string
9429 enum:
9430 - INSTANTIATE
9431 - SCALE
9432 - TERMINATE
9433 - UPDATE
9434 - HEAL
9435 operationStates:
9436 type: array
9437 items:
9438 type: string
9439 enum:
9440 - PROCESSING
9441 - COMPLETED
9442 - PARTIALLY_COMPLETED
9443 - FAILED
9444 - FAILED_TEMP
9445 - ROLLING_BACK
9446 - ROLLED_BACK
9447 nsComponentTypes:
9448 type: array
9449 items:
9450 type: string
9451 enum:
9452 - VNF
9453 - NS
9454 - PNF
9455 lcmOpNameImpactingNsComponent:
9456 type: array
9457 items:
9458 type: string
9459 enum:
9460 - VNF_INSTANTIATE
9461 - VNF_SCALE
9462 - VNF_SCALE_TO_LEVEL
9463 - VNF_CHANGE_FLAVOUR
9464 - VNF_TERMINATE
9465 - VNF_HEAL
9466 - VNF_OPERATE
9467 - VNF_CHANGE_EXT_CONN
9468 - VNF_MODIFY_INFO
9469 - NS_INSTANTIATE
9470 - NS_SCALE
9471 - NS_UPDATE
9472 - NS_TERMINATE
9473 - NS_HEAL
9474 lcmOpOccStatusImpactingNsComponent:
9475 type: array
9476 items:
9477 type: string
9478 enum:
9479 - START
9480 - COMPLETED
9481 - PARTIALLY_COMPLETED
9482 - FAILED
9483 - ROLLED_BACK
9484 Authenticationschema:
9485 type: object
9486 properties:
9487 authType:
9488 type: string
9489 enum:
9490 - basic
9491 paramsBasic:
9492 type: object
9493 properties:
9494 userName:
9495 type: string
9496 password:
9497 type: string
9498 NslcmSubscriptionRequest:
9499 type: object
9500 properties:
9501 filter:
9502 $ref: '#/components/schemas/Nslcmsubschema'
9503 CallbackUri:
9504 type: string
9505 format: uri
9506 authentication:
9507 $ref: '#/components/schemas/Authenticationschema'
9508 required:
9509 - CallbackUri
Gabriel Cuba2c8be082023-11-14 16:52:01 -05009510 CancelNSLCMOpOccRequest:
9511 type: object
9512 properties:
9513 cancelMode:
9514 type: string
9515 enum:
9516 - GRACEFUL
9517 - FORCEFUL
delacruzramfb52ade2019-10-07 16:46:59 +02009518 # END SCHEMAS
9519
garciadeblas60e2ee92018-02-27 19:09:51 +01009520 requestBodies:
9521 CreateNsdInfoRequest:
9522 content:
9523 application/json:
9524 schema:
9525 $ref: '#/components/schemas/CreateNsdInfoRequest'
9526 application/yaml:
9527 schema:
9528 $ref: '#/components/schemas/CreateNsdInfoRequest'
9529 NsdInfoModifications:
9530 content:
9531 application/json:
9532 schema:
9533 $ref: '#/components/schemas/NsdInfoModifications'
9534 application/yaml:
9535 schema:
9536 $ref: '#/components/schemas/NsdInfoModifications'
Atul Agarwal4cd9e952021-05-20 09:24:26 +00009537 AlarmInfoModifications:
9538 content:
9539 application/json:
9540 schema:
9541 $ref: '#/components/schemas/AlarmInfoModifications'
9542 application/yaml:
9543 schema:
9544 $ref: '#/components/schemas/AlarmInfoModifications'
delacruzramfb52ade2019-10-07 16:46:59 +02009545 NsDescriptor:
garciadeblas60e2ee92018-02-27 19:09:51 +01009546 content:
9547 text/plain:
9548 schema:
9549 $ref: '#/components/schemas/NsDescriptor'
delacruzramfb52ade2019-10-07 16:46:59 +02009550 NsPackage:
9551 content:
garciadeblas60e2ee92018-02-27 19:09:51 +01009552 application/zip:
9553 schema:
9554 $ref: '#/components/schemas/NsPackage'
kayal2001ae8f00a2024-06-24 18:04:47 +05309555 CreateNsConfigTemplateInfoRequest:
9556 content:
9557 application/json:
9558 schema:
9559 $ref: '#/components/schemas/CreateNsdInfoRequest'
9560 application/yaml:
9561 schema:
9562 $ref: '#/components/schemas/CreateNsdInfoRequest'
9563 NsConfigTemplateInfoModifications:
9564 content:
9565 application/json:
9566 schema:
9567 $ref: '#/components/schemas/NsdInfoModifications'
9568 application/yaml:
9569 schema:
9570 $ref: '#/components/schemas/NsdInfoModifications'
garciadeblas63fe88c2018-02-28 19:32:41 +01009571 CreateVnfPkgInfoRequest:
9572 content:
9573 application/json:
9574 schema:
9575 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9576 application/yaml:
9577 schema:
9578 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9579 VnfPkgInfoModifications:
9580 content:
9581 application/json:
9582 schema:
9583 $ref: '#/components/schemas/VnfPkgInfoModifications'
9584 application/yaml:
9585 schema:
9586 $ref: '#/components/schemas/VnfPkgInfoModifications'
9587 VnfPackage:
9588 content:
9589 application/zip:
9590 schema:
9591 $ref: '#/components/schemas/VnfPackage'
delacruzramfb52ade2019-10-07 16:46:59 +02009592 VnfDescriptor:
garciadeblas63fe88c2018-02-28 19:32:41 +01009593 content:
delacruzramfb52ade2019-10-07 16:46:59 +02009594 text/plain:
garciadeblas63fe88c2018-02-28 19:32:41 +01009595 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02009596 $ref: '#/components/schemas/VnfDescriptor'
delacruzramaf79f3c2019-10-22 13:13:01 +02009597 # CreateNsRequest:
9598 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +01009599 InstantiateNsRequest:
9600 content:
9601 application/json:
9602 schema:
9603 $ref: '#/components/schemas/InstantiateNsRequest'
9604 application/yaml:
9605 schema:
9606 $ref: '#/components/schemas/InstantiateNsRequest'
garciadeblasb5a065f2022-02-11 00:27:47 +01009607 HealNsRequest:
9608 content:
9609 application/json:
9610 schema:
9611 $ref: '#/components/schemas/HealNsRequest'
9612 application/yaml:
9613 schema:
9614 $ref: '#/components/schemas/HealNsRequest'
elumalai4b120f12022-04-28 16:44:35 +05309615 NSinstanceMigrateRequest:
9616 content:
9617 application/json:
9618 schema:
9619 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9620 application/yaml:
9621 schema:
9622 $ref: '#/components/schemas/NSinstanceMigrateRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01009623 ScaleNsRequest:
9624 content:
9625 application/json:
9626 schema:
9627 $ref: '#/components/schemas/ScaleNsRequest'
9628 application/yaml:
9629 schema:
9630 $ref: '#/components/schemas/ScaleNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01009631 TerminateNsRequest:
9632 content:
9633 application/json:
9634 schema:
9635 $ref: '#/components/schemas/TerminateNsRequest'
9636 application/yaml:
9637 schema:
9638 $ref: '#/components/schemas/TerminateNsRequest'
elumalaif2eb5e72022-03-21 19:44:39 +05309639 UpdateNsRequest:
9640 content:
9641 application/json:
9642 schema:
9643 $ref: '#/components/schemas/UpdateNsRequest'
9644 application/yaml:
9645 schema:
9646 $ref: '#/components/schemas/UpdateNsRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009647 # CreateNSinstanceContentRequest:
9648 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +02009649 CreateNstInfoRequest:
9650 content:
9651 application/json:
9652 schema:
9653 $ref: '#/components/schemas/CreateNstInfoRequest'
9654 application/yaml:
9655 schema:
9656 $ref: '#/components/schemas/CreateNstInfoRequest'
9657 NetSliceTemplate:
9658 content:
9659 text/plain:
9660 schema:
9661 $ref: '#/components/schemas/NetSliceTemplate'
9662 NetSlicePackage:
9663 content:
9664 application/zip:
9665 schema:
9666 $ref: '#/components/schemas/NetSlicePackage'
9667 NstInfoModifications:
9668 content:
9669 application/json:
9670 schema:
9671 $ref: '#/components/schemas/NstInfoModifications'
9672 application/yaml:
9673 schema:
9674 $ref: '#/components/schemas/NstInfoModifications'
delacruzramaf79f3c2019-10-22 13:13:01 +02009675 # CreateNsiRequest:
9676 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02009677 InstantiateNsiRequest:
9678 content:
9679 application/json:
9680 schema:
9681 $ref: '#/components/schemas/InstantiateNsiRequest'
9682 application/yaml:
9683 schema:
9684 $ref: '#/components/schemas/InstantiateNsiRequest'
9685 TerminateNsiRequest:
9686 content:
9687 application/json:
9688 schema:
9689 $ref: '#/components/schemas/TerminateNsiRequest'
9690 application/yaml:
9691 schema:
9692 $ref: '#/components/schemas/TerminateNsiRequest'
9693 NsiActionRequest:
9694 content:
9695 application/json:
9696 schema:
9697 $ref: '#/components/schemas/NsiActionRequest'
9698 application/yaml:
9699 schema:
9700 $ref: '#/components/schemas/NsiActionRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009701 # CreateNsiContentRequest:
9702 # Substituted by InstantiateNsiRequest
9703 CreateTokenRequest:
delacruzramfb52ade2019-10-07 16:46:59 +02009704 content:
9705 application/json:
9706 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02009707 $ref: '#/components/schemas/CreateTokenRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02009708 application/yaml:
9709 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02009710 $ref: '#/components/schemas/CreateTokenRequest'
9711 CreateUserRequest:
9712 content:
9713 application/json:
9714 schema:
9715 $ref: '#/components/schemas/CreateUserRequest'
9716 application/yaml:
9717 schema:
9718 $ref: '#/components/schemas/CreateUserRequest'
9719 EditUserRequest:
9720 content:
9721 application/json:
9722 schema:
9723 $ref: '#/components/schemas/EditUserRequest'
9724 application/yaml:
9725 schema:
9726 $ref: '#/components/schemas/EditUserRequest'
9727 CreateProjectRequest:
9728 content:
9729 application/json:
9730 schema:
9731 $ref: '#/components/schemas/CreateProjectRequest'
9732 application/yaml:
9733 schema:
9734 $ref: '#/components/schemas/CreateProjectRequest'
9735 EditProjectRequest:
9736 content:
9737 application/json:
9738 schema:
9739 $ref: '#/components/schemas/EditProjectRequest'
9740 application/yaml:
9741 schema:
9742 $ref: '#/components/schemas/EditProjectRequest'
9743 CreateRoleRequest:
9744 content:
9745 application/json:
9746 schema:
9747 $ref: '#/components/schemas/CreateRoleRequest'
9748 application/yaml:
9749 schema:
9750 $ref: '#/components/schemas/CreateRoleRequest'
9751 EditRoleRequest:
9752 content:
9753 application/json:
9754 schema:
9755 $ref: '#/components/schemas/EditRoleRequest'
9756 application/yaml:
9757 schema:
9758 $ref: '#/components/schemas/EditRoleRequest'
9759 CreateVimRequest:
9760 content:
9761 application/json:
9762 schema:
9763 $ref: '#/components/schemas/CreateVimRequest'
9764 application/yaml:
9765 schema:
9766 $ref: '#/components/schemas/CreateVimRequest'
9767 EditVimRequest:
9768 content:
9769 application/json:
9770 schema:
9771 $ref: '#/components/schemas/EditVimRequest'
9772 application/yaml:
9773 schema:
9774 $ref: '#/components/schemas/EditVimRequest'
9775 CreateWimRequest:
9776 content:
9777 application/json:
9778 schema:
9779 $ref: '#/components/schemas/CreateWimRequest'
9780 application/yaml:
9781 schema:
9782 $ref: '#/components/schemas/CreateWimRequest'
9783 EditWimRequest:
9784 content:
9785 application/json:
9786 schema:
9787 $ref: '#/components/schemas/EditWimRequest'
9788 application/yaml:
9789 schema:
9790 $ref: '#/components/schemas/EditWimRequest'
9791 CreateSdnRequest:
9792 content:
9793 application/json:
9794 schema:
9795 $ref: '#/components/schemas/CreateSdnRequest'
9796 application/yaml:
9797 schema:
9798 $ref: '#/components/schemas/CreateSdnRequest'
9799 EditSdnRequest:
9800 content:
9801 application/json:
9802 schema:
9803 $ref: '#/components/schemas/EditSdnRequest'
9804 application/yaml:
9805 schema:
9806 $ref: '#/components/schemas/EditSdnRequest'
9807 CreatePduRequest:
9808 content:
9809 application/json:
9810 schema:
9811 $ref: '#/components/schemas/CreatePduRequest'
9812 application/yaml:
9813 schema:
9814 $ref: '#/components/schemas/CreatePduRequest'
9815 EditPduRequest:
9816 content:
9817 application/json:
9818 schema:
9819 $ref: '#/components/schemas/EditPduRequest'
9820 application/yaml:
9821 schema:
9822 $ref: '#/components/schemas/EditPduRequest'
9823 CreateK8sClusterRequest:
9824 content:
9825 application/json:
9826 schema:
9827 $ref: '#/components/schemas/CreateK8sClusterRequest'
9828 application/yaml:
9829 schema:
9830 $ref: '#/components/schemas/CreateK8sClusterRequest'
9831 EditK8sClusterRequest:
9832 content:
9833 application/json:
9834 schema:
9835 $ref: '#/components/schemas/EditK8sClusterRequest'
9836 application/yaml:
9837 schema:
9838 $ref: '#/components/schemas/EditK8sClusterRequest'
David Garciaaf38fce2021-05-04 12:48:04 +02009839 CreateVcaRequest:
9840 content:
9841 application/json:
9842 schema:
9843 $ref: '#/components/schemas/CreateVcaRequest'
9844 application/yaml:
9845 schema:
9846 $ref: '#/components/schemas/CreateVcaRequest'
9847 EditVcaRequest:
9848 content:
9849 application/json:
9850 schema:
9851 $ref: '#/components/schemas/EditVcaRequest'
9852 application/yaml:
9853 schema:
9854 $ref: '#/components/schemas/EditVcaRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009855 CreateK8sRepoRequest:
9856 content:
9857 application/json:
9858 schema:
9859 $ref: '#/components/schemas/CreateK8sRepoRequest'
9860 application/yaml:
9861 schema:
9862 $ref: '#/components/schemas/CreateK8sRepoRequest'
preethika.p31b3a802020-07-28 09:14:01 +00009863 NslcmSubscriptionRequest:
9864 content:
9865 application/json:
9866 schema:
9867 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9868 application/yaml:
9869 schema:
9870 $ref: '#/components/schemas/NslcmSubscriptionRequest'
Gabriel Cuba2c8be082023-11-14 16:52:01 -05009871 CancelNSLCMOpOccRequest:
9872 content:
9873 application/json:
9874 schema:
9875 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
9876 application/yaml:
9877 schema:
9878 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02009879 # END REQUEST BODIES
9880
garciadeblas60e2ee92018-02-27 19:09:51 +01009881 securitySchemes:
9882 bearerAuth:
9883 type: http
9884 scheme: bearer