blob: 736724fa51e4bd670066915ccd4012376206a0a8 [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
681# BEGIN VNF Packages
garciadeblas12fcc4b2018-03-02 16:12:02 +0100682 '/vnfpkgm/v1/vnf_packages':
garciadeblas63fe88c2018-02-28 19:32:41 +0100683 get:
684 tags:
685 - "VNF packages"
686 summary: Query information about multiple VNF package resources
delacruzramfb52ade2019-10-07 16:46:59 +0200687 description: Query information about multiple VNF package resources
garciadeblas63fe88c2018-02-28 19:32:41 +0100688 operationId: getVnfPkgs
garciadeblas63fe88c2018-02-28 19:32:41 +0100689 responses:
690 '200':
691 description: OK
692 content:
693 application/json:
694 schema:
695 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
696 application/yaml:
697 schema:
698 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
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 - "VNF packages"
726 summary: Create a new VNF package resource
727 description: Create a new VNF package resource
728 operationId: addVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100729 requestBody:
730 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
731 responses:
732 '201':
733 description: Created
734 headers:
735 Location:
736 schema:
737 type: string
738 format: uri
739 content:
740 application/json:
741 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200742 $ref: '#/components/schemas/ObjectId'
garciadeblas63fe88c2018-02-28 19:32:41 +0100743 application/yaml:
744 schema:
delacruzramfb52ade2019-10-07 16:46:59 +0200745 $ref: '#/components/schemas/ObjectId'
garciadeblas63fe88c2018-02-28 19:32:41 +0100746 '400':
747 $ref: '#/components/responses/BadRequest'
748 '401':
749 $ref: '#/components/responses/Unauthorized'
750 '403':
751 $ref: '#/components/responses/Forbidden'
752 '404':
753 $ref: '#/components/responses/NotFound'
754 '405':
755 $ref: '#/components/responses/MethodNotAllowed'
756 '406':
757 $ref: '#/components/responses/NotAcceptable'
758 '409':
759 $ref: '#/components/responses/Conflict'
760 '422':
761 $ref: '#/components/responses/UnprocessableEntity'
762 '500':
763 $ref: '#/components/responses/InternalServerError'
764 '503':
765 $ref: '#/components/responses/ServiceUnavailable'
766 '5XX':
767 $ref: '#/components/responses/UnexpectedError'
768 default:
769 $ref: '#/components/responses/UnexpectedError'
770 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
delacruzramfb52ade2019-10-07 16:46:59 +0200771 parameters:
772 - name: vnfPkgId
773 in: path
774 required: true
775 description: VNF Package ID
776 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200777 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100778 get:
779 tags:
780 - "VNF packages"
781 summary: Read information about an individual VNF package resource
782 description: Read information about an individual VNF package resource
783 operationId: getVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100784 responses:
785 '200':
786 description: OK
787 content:
788 application/json:
789 schema:
790 $ref: '#/components/schemas/VnfPkgInfo'
791 application/yaml:
792 schema:
793 $ref: '#/components/schemas/VnfPkgInfo'
794 '400':
795 $ref: '#/components/responses/BadRequest'
796 '401':
797 $ref: '#/components/responses/Unauthorized'
798 '403':
799 $ref: '#/components/responses/Forbidden'
800 '404':
801 $ref: '#/components/responses/NotFound'
802 '405':
803 $ref: '#/components/responses/MethodNotAllowed'
804 '406':
805 $ref: '#/components/responses/NotAcceptable'
806 '409':
807 $ref: '#/components/responses/Conflict'
808 '422':
809 $ref: '#/components/responses/UnprocessableEntity'
810 '500':
811 $ref: '#/components/responses/InternalServerError'
812 '503':
813 $ref: '#/components/responses/ServiceUnavailable'
814 '5XX':
815 $ref: '#/components/responses/UnexpectedError'
816 default:
817 $ref: '#/components/responses/UnexpectedError'
818 delete:
819 tags:
820 - "VNF packages"
821 summary: Delete an individual VNF package resource
822 description: Delete an individual VNF package resource
823 operationId: deleteVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100824 responses:
825 '204':
826 description: No Content
827 '400':
828 $ref: '#/components/responses/BadRequest'
829 '401':
830 $ref: '#/components/responses/Unauthorized'
831 '403':
832 $ref: '#/components/responses/Forbidden'
833 '404':
834 $ref: '#/components/responses/NotFound'
835 '405':
836 $ref: '#/components/responses/MethodNotAllowed'
837 '406':
838 $ref: '#/components/responses/NotAcceptable'
839 '409':
840 $ref: '#/components/responses/Conflict'
841 '422':
842 $ref: '#/components/responses/UnprocessableEntity'
843 '500':
844 $ref: '#/components/responses/InternalServerError'
845 '503':
846 $ref: '#/components/responses/ServiceUnavailable'
847 '5XX':
848 $ref: '#/components/responses/UnexpectedError'
849 default:
850 $ref: '#/components/responses/UnexpectedError'
851 patch:
852 tags:
853 - "VNF packages"
delacruzramfb52ade2019-10-07 16:46:59 +0200854 summary: Modify an individual VNF package resource
855 description: Modify an individual VNF package resource
garciadeblas63fe88c2018-02-28 19:32:41 +0100856 operationId: updateVnfPkg
garciadeblas63fe88c2018-02-28 19:32:41 +0100857 requestBody:
858 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
859 responses:
delacruzramfb52ade2019-10-07 16:46:59 +0200860 '204':
861 description: No Content
garciadeblas63fe88c2018-02-28 19:32:41 +0100862 '400':
863 $ref: '#/components/responses/BadRequest'
864 '401':
865 $ref: '#/components/responses/Unauthorized'
866 '403':
867 $ref: '#/components/responses/Forbidden'
868 '404':
869 $ref: '#/components/responses/NotFound'
870 '405':
871 $ref: '#/components/responses/MethodNotAllowed'
872 '406':
873 $ref: '#/components/responses/NotAcceptable'
874 '409':
875 $ref: '#/components/responses/Conflict'
876 '422':
877 $ref: '#/components/responses/UnprocessableEntity'
878 '500':
879 $ref: '#/components/responses/InternalServerError'
880 '503':
881 $ref: '#/components/responses/ServiceUnavailable'
882 '5XX':
883 $ref: '#/components/responses/UnexpectedError'
884 default:
885 $ref: '#/components/responses/UnexpectedError'
886 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
delacruzramfb52ade2019-10-07 16:46:59 +0200887 parameters:
888 - name: vnfPkgId
889 in: path
890 required: true
891 description: VNF Package ID
892 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200893 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100894 get:
895 tags:
896 - "VNF packages"
897 summary: Read VNFD of an on-boarded VNF package
898 description: Read VNFD of an on-boarded VNF package
delacruzramfb52ade2019-10-07 16:46:59 +0200899 operationId: getVnfPkgVnfd
garciadeblas63fe88c2018-02-28 19:32:41 +0100900 responses:
901 '200':
902 description: OK
903 content:
904 text/plain:
905 schema:
906 $ref: '#/components/schemas/VnfDescriptor'
907 '400':
908 $ref: '#/components/responses/BadRequest'
909 '401':
910 $ref: '#/components/responses/Unauthorized'
911 '403':
912 $ref: '#/components/responses/Forbidden'
913 '404':
914 $ref: '#/components/responses/NotFound'
915 '405':
916 $ref: '#/components/responses/MethodNotAllowed'
917 '406':
918 $ref: '#/components/responses/NotAcceptable'
919 '409':
920 $ref: '#/components/responses/Conflict'
921 '422':
922 $ref: '#/components/responses/UnprocessableEntity'
923 '500':
924 $ref: '#/components/responses/InternalServerError'
925 '503':
926 $ref: '#/components/responses/ServiceUnavailable'
927 '5XX':
928 $ref: '#/components/responses/UnexpectedError'
929 default:
930 $ref: '#/components/responses/UnexpectedError'
931 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
delacruzramfb52ade2019-10-07 16:46:59 +0200932 parameters:
933 - name: vnfPkgId
934 in: path
935 required: true
936 description: VNF Package ID
937 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +0200938 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +0100939 get:
940 tags:
941 - "VNF packages"
942 summary: Fetch an on-boarded VNF package
943 description: Fetch an on-boarded VNF package
944 operationId: getVnfPkgContent
garciadeblas63fe88c2018-02-28 19:32:41 +0100945 responses:
946 '200':
947 description: OK
948 content:
949 application/zip:
950 schema:
951 $ref: '#/components/schemas/VnfPackage'
952 '206':
953 description: Partial Content
954 headers:
955 Content-Range:
956 schema:
957 type: string
958 content:
959 application/zip:
960 schema:
961 $ref: '#/components/schemas/VnfPackage'
962 '400':
963 $ref: '#/components/responses/BadRequest'
964 '401':
965 $ref: '#/components/responses/Unauthorized'
966 '403':
967 $ref: '#/components/responses/Forbidden'
968 '404':
969 $ref: '#/components/responses/NotFound'
970 '405':
971 $ref: '#/components/responses/MethodNotAllowed'
972 '406':
973 $ref: '#/components/responses/NotAcceptable'
974 '409':
975 $ref: '#/components/responses/Conflict'
976 '422':
977 $ref: '#/components/responses/UnprocessableEntity'
978 '500':
979 $ref: '#/components/responses/InternalServerError'
980 '503':
981 $ref: '#/components/responses/ServiceUnavailable'
982 '5XX':
983 $ref: '#/components/responses/UnexpectedError'
984 default:
985 $ref: '#/components/responses/UnexpectedError'
986 put:
987 tags:
988 - "VNF packages"
989 summary: Upload a VNF package by providing the content of the VNF package
990 description: Upload a VNF package by providing the content of the VNF package
991 operationId: uploadVnfPkgContent
garciadeblas63fe88c2018-02-28 19:32:41 +0100992 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +0200993 content:
994 application/zip:
995 schema:
996 $ref: '#/components/schemas/VnfPackage'
garciadeblas63fe88c2018-02-28 19:32:41 +0100997 responses:
998 '202':
999 description: Accepted
delacruzramfb52ade2019-10-07 16:46:59 +02001000 '204':
1001 description: No Content
garciadeblas63fe88c2018-02-28 19:32:41 +01001002 '400':
1003 $ref: '#/components/responses/BadRequest'
1004 '401':
1005 $ref: '#/components/responses/Unauthorized'
1006 '403':
1007 $ref: '#/components/responses/Forbidden'
1008 '404':
1009 $ref: '#/components/responses/NotFound'
1010 '405':
1011 $ref: '#/components/responses/MethodNotAllowed'
1012 '406':
1013 $ref: '#/components/responses/NotAcceptable'
1014 '409':
1015 $ref: '#/components/responses/Conflict'
1016 '422':
1017 $ref: '#/components/responses/UnprocessableEntity'
1018 '500':
1019 $ref: '#/components/responses/InternalServerError'
1020 '503':
1021 $ref: '#/components/responses/ServiceUnavailable'
1022 '5XX':
1023 $ref: '#/components/responses/UnexpectedError'
1024 default:
1025 $ref: '#/components/responses/UnexpectedError'
1026 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
delacruzramfb52ade2019-10-07 16:46:59 +02001027 parameters:
1028 - name: vnfPkgId
1029 in: path
1030 required: true
1031 description: VNF Package ID
1032 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001033 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02001034 - name: artifactPath
1035 in: path
1036 required: true
1037 description: Artifact Path
1038 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001039 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01001040 get:
1041 tags:
1042 - "VNF packages"
1043 summary: Fetch individual VNF package artifact
1044 description: Fetch individual VNF package artifact
1045 operationId: getVnfPkgArtifact
garciadeblas63fe88c2018-02-28 19:32:41 +01001046 responses:
1047 '200':
1048 description: OK
1049 content:
1050 application/octet-stream:
1051 schema:
1052 type: string
1053 format: binary
1054 '206':
1055 description: Partial Content
1056 headers:
1057 Content-Range:
1058 schema:
1059 type: string
1060 content:
1061 application/octet-stream:
1062 schema:
1063 type: string
1064 format: binary
1065 '400':
1066 $ref: '#/components/responses/BadRequest'
1067 '401':
1068 $ref: '#/components/responses/Unauthorized'
1069 '403':
1070 $ref: '#/components/responses/Forbidden'
1071 '404':
1072 $ref: '#/components/responses/NotFound'
1073 '405':
1074 $ref: '#/components/responses/MethodNotAllowed'
1075 '406':
1076 $ref: '#/components/responses/NotAcceptable'
1077 '409':
1078 $ref: '#/components/responses/Conflict'
1079 '422':
1080 $ref: '#/components/responses/UnprocessableEntity'
1081 '500':
1082 $ref: '#/components/responses/InternalServerError'
1083 '503':
1084 $ref: '#/components/responses/ServiceUnavailable'
1085 '5XX':
1086 $ref: '#/components/responses/UnexpectedError'
1087 default:
1088 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02001089 '/vnfpkgm/v1/vnf_packages_content':
1090 post:
1091 tags:
1092 - "VNF packages"
1093 summary: Upload a VNF package by providing the content of the VNF package
1094 description: Upload a VNF package by providing the content of the VNF package
1095 operationId: uploadVnfPkgsContent
1096 requestBody:
1097 content:
1098 application/zip:
1099 schema:
1100 $ref: '#/components/schemas/VnfPackage'
1101 responses:
1102 '201':
1103 description: Created
1104 headers:
1105 Location:
1106 schema:
1107 type: string
1108 format: uri
1109 content:
1110 application/json:
1111 schema:
1112 $ref: '#/components/schemas/ObjectId'
1113 application/yaml:
1114 schema:
1115 $ref: '#/components/schemas/ObjectId'
1116 '202':
1117 description: Accepted
1118 '204':
1119 description: No Content
1120 '400':
1121 $ref: '#/components/responses/BadRequest'
1122 '401':
1123 $ref: '#/components/responses/Unauthorized'
1124 '403':
1125 $ref: '#/components/responses/Forbidden'
1126 '404':
1127 $ref: '#/components/responses/NotFound'
1128 '405':
1129 $ref: '#/components/responses/MethodNotAllowed'
1130 '406':
1131 $ref: '#/components/responses/NotAcceptable'
1132 '409':
1133 $ref: '#/components/responses/Conflict'
1134 '422':
1135 $ref: '#/components/responses/UnprocessableEntity'
1136 '500':
1137 $ref: '#/components/responses/InternalServerError'
1138 '503':
1139 $ref: '#/components/responses/ServiceUnavailable'
1140 '5XX':
1141 $ref: '#/components/responses/UnexpectedError'
1142 default:
1143 $ref: '#/components/responses/UnexpectedError'
1144 get:
1145 tags:
1146 - "VNF packages"
1147 summary: Query information about multiple VNF package resources
1148 description: Query information about multiple VNF package resources
1149 operationId: getVnfPkgsContent
1150 responses:
1151 '200':
1152 description: OK
1153 content:
1154 application/json:
1155 schema:
1156 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1157 application/yaml:
1158 schema:
1159 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1160 '206':
1161 description: Partial Content
1162 headers:
1163 Content-Range:
1164 schema:
1165 type: string
1166 content:
1167 application/octet-stream:
1168 schema:
1169 type: string
1170 format: binary
1171 '400':
1172 $ref: '#/components/responses/BadRequest'
1173 '401':
1174 $ref: '#/components/responses/Unauthorized'
1175 '403':
1176 $ref: '#/components/responses/Forbidden'
1177 '404':
1178 $ref: '#/components/responses/NotFound'
1179 '405':
1180 $ref: '#/components/responses/MethodNotAllowed'
1181 '406':
1182 $ref: '#/components/responses/NotAcceptable'
1183 '409':
1184 $ref: '#/components/responses/Conflict'
1185 '422':
1186 $ref: '#/components/responses/UnprocessableEntity'
1187 '500':
1188 $ref: '#/components/responses/InternalServerError'
1189 '503':
1190 $ref: '#/components/responses/ServiceUnavailable'
1191 '5XX':
1192 $ref: '#/components/responses/UnexpectedError'
1193 default:
1194 $ref: '#/components/responses/UnexpectedError'
1195 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1196 parameters:
1197 - name: packageContentId
1198 in: path
1199 required: true
1200 description: VNF Package Content ID
1201 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001202 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02001203 get:
1204 tags:
1205 - "VNF packages"
1206 summary: Read information about an individual VNF package resource
1207 description: Read information about an individual VNF package resource
1208 operationId: getVnfPkgsIdContent
1209 responses:
1210 '200':
1211 description: OK
1212 content:
1213 application/json:
1214 schema:
1215 $ref: '#/components/schemas/VnfPkgInfo'
1216 application/yaml:
1217 schema:
1218 $ref: '#/components/schemas/VnfPkgInfo'
1219 '400':
1220 $ref: '#/components/responses/BadRequest'
1221 '401':
1222 $ref: '#/components/responses/Unauthorized'
1223 '403':
1224 $ref: '#/components/responses/Forbidden'
1225 '404':
1226 $ref: '#/components/responses/NotFound'
1227 '405':
1228 $ref: '#/components/responses/MethodNotAllowed'
1229 '406':
1230 $ref: '#/components/responses/NotAcceptable'
1231 '409':
1232 $ref: '#/components/responses/Conflict'
1233 '422':
1234 $ref: '#/components/responses/UnprocessableEntity'
1235 '500':
1236 $ref: '#/components/responses/InternalServerError'
1237 '503':
1238 $ref: '#/components/responses/ServiceUnavailable'
1239 '5XX':
1240 $ref: '#/components/responses/UnexpectedError'
1241 default:
1242 $ref: '#/components/responses/UnexpectedError'
1243 put:
1244 tags:
1245 - "VNF packages"
1246 summary: Modify an individual VNF package resource
1247 description: Modify an individual VNF package resource
1248 operationId: updateVnfPkgsIdContent
1249 requestBody:
1250 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1251 responses:
1252 '204':
1253 description: No Content
1254 '400':
1255 $ref: '#/components/responses/BadRequest'
1256 '401':
1257 $ref: '#/components/responses/Unauthorized'
1258 '403':
1259 $ref: '#/components/responses/Forbidden'
1260 '404':
1261 $ref: '#/components/responses/NotFound'
1262 '405':
1263 $ref: '#/components/responses/MethodNotAllowed'
1264 '406':
1265 $ref: '#/components/responses/NotAcceptable'
1266 '409':
1267 $ref: '#/components/responses/Conflict'
1268 '422':
1269 $ref: '#/components/responses/UnprocessableEntity'
1270 '500':
1271 $ref: '#/components/responses/InternalServerError'
1272 '503':
1273 $ref: '#/components/responses/ServiceUnavailable'
1274 '5XX':
1275 $ref: '#/components/responses/UnexpectedError'
1276 default:
1277 $ref: '#/components/responses/UnexpectedError'
1278 delete:
1279 tags:
1280 - "VNF packages"
1281 summary: Delete an individual VNF package resource
1282 description: Delete an individual VNF package resource
1283 operationId: deleteVnfPkgsIdContent
1284 responses:
1285 '204':
1286 description: No Content
1287 '400':
1288 $ref: '#/components/responses/BadRequest'
1289 '401':
1290 $ref: '#/components/responses/Unauthorized'
1291 '403':
1292 $ref: '#/components/responses/Forbidden'
1293 '404':
1294 $ref: '#/components/responses/NotFound'
1295 '405':
1296 $ref: '#/components/responses/MethodNotAllowed'
1297 '406':
1298 $ref: '#/components/responses/NotAcceptable'
1299 '409':
1300 $ref: '#/components/responses/Conflict'
1301 '422':
1302 $ref: '#/components/responses/UnprocessableEntity'
1303 '500':
1304 $ref: '#/components/responses/InternalServerError'
1305 '503':
1306 $ref: '#/components/responses/ServiceUnavailable'
1307 '5XX':
1308 $ref: '#/components/responses/UnexpectedError'
1309 default:
1310 $ref: '#/components/responses/UnexpectedError'
1311# END VNF Packages
1312
1313# BEGIN NS Instances
garciadeblas12fcc4b2018-03-02 16:12:02 +01001314 '/nslcm/v1/ns_instances':
1315 get:
1316 tags:
1317 - "NS instances"
1318 summary: Query information about multiple NS instances
1319 description: Query information about multiple NS isntances
1320 operationId: getNSinstances
garciadeblas12fcc4b2018-03-02 16:12:02 +01001321 responses:
1322 '200':
1323 description: OK
1324 content:
1325 application/json:
1326 schema:
1327 $ref: '#/components/schemas/ArrayOfNsInstance'
1328 application/yaml:
1329 schema:
1330 $ref: '#/components/schemas/ArrayOfNsInstance'
1331 '400':
1332 $ref: '#/components/responses/BadRequest'
1333 '401':
1334 $ref: '#/components/responses/Unauthorized'
1335 '403':
1336 $ref: '#/components/responses/Forbidden'
1337 '404':
1338 $ref: '#/components/responses/NotFound'
1339 '405':
1340 $ref: '#/components/responses/MethodNotAllowed'
1341 '406':
1342 $ref: '#/components/responses/NotAcceptable'
1343 '409':
1344 $ref: '#/components/responses/Conflict'
1345 '422':
1346 $ref: '#/components/responses/UnprocessableEntity'
1347 '500':
1348 $ref: '#/components/responses/InternalServerError'
1349 '503':
1350 $ref: '#/components/responses/ServiceUnavailable'
1351 '5XX':
1352 $ref: '#/components/responses/UnexpectedError'
1353 default:
1354 $ref: '#/components/responses/UnexpectedError'
1355 post:
1356 tags:
1357 - "NS instances"
1358 summary: Create a new NS instance resource
1359 description: Create a new NS instance resource
1360 operationId: addNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001361 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02001362 $ref: '#/components/requestBodies/InstantiateNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001363 responses:
1364 '201':
1365 description: Created
1366 headers:
1367 Location:
1368 schema:
1369 type: string
1370 format: uri
1371 content:
1372 application/json:
1373 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02001374 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001375 application/yaml:
1376 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02001377 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001378 '400':
1379 $ref: '#/components/responses/BadRequest'
1380 '401':
1381 $ref: '#/components/responses/Unauthorized'
1382 '403':
1383 $ref: '#/components/responses/Forbidden'
1384 '404':
1385 $ref: '#/components/responses/NotFound'
1386 '405':
1387 $ref: '#/components/responses/MethodNotAllowed'
1388 '406':
1389 $ref: '#/components/responses/NotAcceptable'
1390 '409':
1391 $ref: '#/components/responses/Conflict'
1392 '422':
1393 $ref: '#/components/responses/UnprocessableEntity'
1394 '500':
1395 $ref: '#/components/responses/InternalServerError'
1396 '503':
1397 $ref: '#/components/responses/ServiceUnavailable'
1398 '5XX':
1399 $ref: '#/components/responses/UnexpectedError'
1400 default:
1401 $ref: '#/components/responses/UnexpectedError'
1402 '/nslcm/v1/ns_instances/{nsInstanceId}':
delacruzramfb52ade2019-10-07 16:46:59 +02001403 parameters:
1404 - name: nsInstanceId
1405 in: path
1406 required: true
1407 description: NS Instance ID
1408 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001409 type: string
ksaikiranr6400ff72021-04-07 14:19:50 +05301410 - name: vcaStatusRefresh
1411 in: query
1412 required: false
1413 description: Set to true if vca status needs to be refreshed.
1414 schema:
1415 type: boolean
garciadeblas12fcc4b2018-03-02 16:12:02 +01001416 get:
1417 tags:
1418 - "NS instances"
1419 summary: Read an individual NS instance resource
1420 description: Read an individual NS instance resource
1421 operationId: getNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001422 responses:
1423 '200':
1424 description: OK
1425 content:
1426 application/json:
1427 schema:
1428 $ref: '#/components/schemas/NsInstance'
1429 application/yaml:
1430 schema:
1431 $ref: '#/components/schemas/NsInstance'
1432 '400':
1433 $ref: '#/components/responses/BadRequest'
1434 '401':
1435 $ref: '#/components/responses/Unauthorized'
1436 '403':
1437 $ref: '#/components/responses/Forbidden'
1438 '404':
1439 $ref: '#/components/responses/NotFound'
1440 '405':
1441 $ref: '#/components/responses/MethodNotAllowed'
1442 '406':
1443 $ref: '#/components/responses/NotAcceptable'
1444 '409':
1445 $ref: '#/components/responses/Conflict'
1446 '422':
1447 $ref: '#/components/responses/UnprocessableEntity'
1448 '500':
1449 $ref: '#/components/responses/InternalServerError'
1450 '503':
1451 $ref: '#/components/responses/ServiceUnavailable'
1452 '5XX':
1453 $ref: '#/components/responses/UnexpectedError'
1454 default:
1455 $ref: '#/components/responses/UnexpectedError'
1456 delete:
1457 tags:
1458 - "NS instances"
1459 summary: Delete an individual NS instance resource
1460 description: Delete an individual NS instance resource
1461 operationId: deleteNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001462 responses:
1463 '204':
1464 description: No Content
1465 '400':
1466 $ref: '#/components/responses/BadRequest'
1467 '401':
1468 $ref: '#/components/responses/Unauthorized'
1469 '403':
1470 $ref: '#/components/responses/Forbidden'
1471 '404':
1472 $ref: '#/components/responses/NotFound'
1473 '405':
1474 $ref: '#/components/responses/MethodNotAllowed'
1475 '406':
1476 $ref: '#/components/responses/NotAcceptable'
1477 '409':
1478 $ref: '#/components/responses/Conflict'
1479 '422':
1480 $ref: '#/components/responses/UnprocessableEntity'
1481 '500':
1482 $ref: '#/components/responses/InternalServerError'
1483 '503':
1484 $ref: '#/components/responses/ServiceUnavailable'
1485 '5XX':
1486 $ref: '#/components/responses/UnexpectedError'
1487 default:
1488 $ref: '#/components/responses/UnexpectedError'
1489 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
delacruzramfb52ade2019-10-07 16:46:59 +02001490 parameters:
1491 - name: nsInstanceId
1492 in: path
1493 required: true
1494 description: NS Instance ID
1495 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001496 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01001497 post:
1498 tags:
1499 - "NS instances"
1500 summary: Instantiate a NS
1501 description: |
1502 Instantiate a NS. The precondition is that the NS instance must have
1503 been created and must be in NOT_INSTANTIATED state. As a result of the
1504 success of this operation, the NFVO creates a "NS Lifecycle Operation
1505 Occurrence" resource for the request, and the NS instance state becomes
1506 INSTANTIATED.
1507 operationId: instantiateNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001508 requestBody:
1509 $ref: '#/components/requestBodies/InstantiateNsRequest'
1510 responses:
1511 '202':
1512 description: Accepted
1513 headers:
1514 Location:
1515 description: |
1516 It must point to the new "NS Lifecycle Operation Occurrence"
1517 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1518 schema:
1519 type: string
1520 format: uri
delacruzramfb52ade2019-10-07 16:46:59 +02001521 content:
1522 application/json:
1523 schema:
1524 $ref: '#/components/schemas/ObjectId'
1525 application/yaml:
1526 schema:
1527 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001528 '400':
1529 $ref: '#/components/responses/BadRequest'
1530 '401':
1531 $ref: '#/components/responses/Unauthorized'
1532 '403':
1533 $ref: '#/components/responses/Forbidden'
1534 '404':
1535 $ref: '#/components/responses/NotFound'
1536 '405':
1537 $ref: '#/components/responses/MethodNotAllowed'
1538 '406':
1539 $ref: '#/components/responses/NotAcceptable'
1540 '409':
1541 $ref: '#/components/responses/Conflict'
1542 '422':
1543 $ref: '#/components/responses/UnprocessableEntity'
1544 '500':
1545 $ref: '#/components/responses/InternalServerError'
1546 '503':
1547 $ref: '#/components/responses/ServiceUnavailable'
1548 '5XX':
1549 $ref: '#/components/responses/UnexpectedError'
1550 default:
1551 $ref: '#/components/responses/UnexpectedError'
1552 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
delacruzramfb52ade2019-10-07 16:46:59 +02001553 parameters:
1554 - name: nsInstanceId
1555 in: path
1556 required: true
1557 description: NS Instance ID
1558 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001559 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01001560 post:
1561 tags:
1562 - "NS instances"
1563 summary: Scale a NS instance
1564 description: |
1565 Scale a NS instance. The precondition is that the NS instance must have
1566 been created and must be in INSTANTIATED state. As a result of the
1567 success of this operation, the NFVO creates a "NS Lifecycle Operation
1568 Occurrence" resource for the request, and the NS instance state remains
1569 INSTANTIATED.
1570 operationId: scaleNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001571 requestBody:
1572 $ref: '#/components/requestBodies/ScaleNsRequest'
1573 responses:
1574 '202':
1575 description: Accepted
1576 headers:
1577 Location:
1578 description: |
1579 It must point to the new "NS Lifecycle Operation Occurrence"
1580 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1581 schema:
1582 type: string
1583 format: uri
1584 '400':
1585 $ref: '#/components/responses/BadRequest'
1586 '401':
1587 $ref: '#/components/responses/Unauthorized'
1588 '403':
1589 $ref: '#/components/responses/Forbidden'
1590 '404':
1591 $ref: '#/components/responses/NotFound'
1592 '405':
1593 $ref: '#/components/responses/MethodNotAllowed'
1594 '406':
1595 $ref: '#/components/responses/NotAcceptable'
1596 '409':
1597 $ref: '#/components/responses/Conflict'
1598 '422':
1599 $ref: '#/components/responses/UnprocessableEntity'
1600 '500':
1601 $ref: '#/components/responses/InternalServerError'
1602 '503':
1603 $ref: '#/components/responses/ServiceUnavailable'
1604 '5XX':
1605 $ref: '#/components/responses/UnexpectedError'
1606 default:
1607 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +01001608 '/nslcm/v1/ns_instances/{nsInstanceId}/heal':
1609 parameters:
1610 - name: nsInstanceId
1611 in: path
1612 required: true
1613 description: NS Instance ID
1614 schema:
1615 type: string
1616 post:
1617 tags:
1618 - "NS instances"
1619 summary: Heal a NS instance
1620 description: |
1621 Heal a NS instance. The precondition is that the NS instance must have
1622 been created and must be in INSTANTIATED state. As a result of the
1623 success of this operation, the NFVO creates a "NS Lifecycle Operation
1624 Occurrence" resource for the request, and the NS instance state remains
1625 INSTANTIATED.
1626 operationId: healNSinstance
1627 requestBody:
1628 $ref: '#/components/requestBodies/HealNsRequest'
1629 responses:
1630 '202':
1631 description: Accepted
1632 headers:
1633 Location:
1634 description: |
1635 It must point to the new "NS Lifecycle Operation Occurrence"
1636 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1637 schema:
1638 type: string
1639 format: uri
1640 '400':
1641 $ref: '#/components/responses/BadRequest'
1642 '401':
1643 $ref: '#/components/responses/Unauthorized'
1644 '403':
1645 $ref: '#/components/responses/Forbidden'
1646 '404':
1647 $ref: '#/components/responses/NotFound'
1648 '405':
1649 $ref: '#/components/responses/MethodNotAllowed'
1650 '406':
1651 $ref: '#/components/responses/NotAcceptable'
1652 '409':
1653 $ref: '#/components/responses/Conflict'
1654 '422':
1655 $ref: '#/components/responses/UnprocessableEntity'
1656 '500':
1657 $ref: '#/components/responses/InternalServerError'
1658 '503':
1659 $ref: '#/components/responses/ServiceUnavailable'
1660 '5XX':
1661 $ref: '#/components/responses/UnexpectedError'
1662 default:
1663 $ref: '#/components/responses/UnexpectedError'
elumalai4b120f12022-04-28 16:44:35 +05301664 '/nslcm/v1/ns_instances/{nsInstanceId}/migrate':
1665 parameters:
1666 - name: nsInstanceId
1667 in: path
1668 required: true
1669 description: NS Instance ID
1670 schema:
1671 type: string
1672 post:
1673 tags:
1674 - "NS instances"
1675 summary: Migrate VNFs in a NS instance
1676 description: |
1677 Migrate the VNFs and VDUs in a NS instance. The precondition is
1678 that the NS instance must have been created and must be in
1679 INSTANTIATED state. As a result of the success of this operation,
1680 the NFVO creates a "NS Lifecycle Operation Occurrence" resource
1681 for the request, and the NS instance state remains INSTANTIATED.
1682 operationId: migrateNSinstance
1683 requestBody:
1684 $ref: '#/components/requestBodies/NSinstanceMigrateRequest'
1685 responses:
1686 '202':
1687 description: Accepted
1688 headers:
1689 Location:
1690 description: |
1691 It must point to the new "NS Lifecycle Operation Occurrence"
1692 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1693 schema:
1694 type: string
1695 format: uri
1696 '400':
1697 $ref: '#/components/responses/BadRequest'
1698 '401':
1699 $ref: '#/components/responses/Unauthorized'
1700 '403':
1701 $ref: '#/components/responses/Forbidden'
1702 '404':
1703 $ref: '#/components/responses/NotFound'
1704 '405':
1705 $ref: '#/components/responses/MethodNotAllowed'
1706 '406':
1707 $ref: '#/components/responses/NotAcceptable'
1708 '409':
1709 $ref: '#/components/responses/Conflict'
1710 '422':
1711 $ref: '#/components/responses/UnprocessableEntity'
1712 '500':
1713 $ref: '#/components/responses/InternalServerError'
1714 '503':
1715 $ref: '#/components/responses/ServiceUnavailable'
1716 '5XX':
1717 $ref: '#/components/responses/UnexpectedError'
1718 default:
1719 $ref: '#/components/responses/UnexpectedError'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001720 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
delacruzramfb52ade2019-10-07 16:46:59 +02001721 parameters:
1722 - name: nsInstanceId
1723 in: path
1724 required: true
1725 description: NS Instance ID
1726 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001727 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01001728 post:
1729 tags:
1730 - "NS instances"
1731 summary: Terminate a NS instance
1732 description: |
1733 Terminate a NS instance. The precondition is that the NS instance must have
1734 been created and must be in INSTANTIATED state. As a result of the
1735 success of this operation, the NFVO creates a "NS Lifecycle Operation
1736 Occurrence" resource for the request, and the NS instance state becomes
1737 NOT_INSTANTIATED.
1738 operationId: terminateNSinstance
garciadeblas12fcc4b2018-03-02 16:12:02 +01001739 requestBody:
delacruzramfb52ade2019-10-07 16:46:59 +02001740 # Request data is not required
garciadeblas12fcc4b2018-03-02 16:12:02 +01001741 $ref: '#/components/requestBodies/TerminateNsRequest'
1742 responses:
1743 '202':
1744 description: Accepted
1745 headers:
1746 Location:
1747 description: |
1748 It must point to the new "NS Lifecycle Operation Occurrence"
1749 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1750 schema:
1751 type: string
1752 format: uri
delacruzramfb52ade2019-10-07 16:46:59 +02001753 content:
1754 application/json:
1755 schema:
1756 $ref: '#/components/schemas/ObjectId'
1757 application/yaml:
1758 schema:
1759 $ref: '#/components/schemas/ObjectId'
garciadeblas12fcc4b2018-03-02 16:12:02 +01001760 '400':
1761 $ref: '#/components/responses/BadRequest'
1762 '401':
1763 $ref: '#/components/responses/Unauthorized'
1764 '403':
1765 $ref: '#/components/responses/Forbidden'
1766 '404':
1767 $ref: '#/components/responses/NotFound'
1768 '405':
1769 $ref: '#/components/responses/MethodNotAllowed'
1770 '406':
1771 $ref: '#/components/responses/NotAcceptable'
1772 '409':
1773 $ref: '#/components/responses/Conflict'
1774 '422':
1775 $ref: '#/components/responses/UnprocessableEntity'
1776 '500':
1777 $ref: '#/components/responses/InternalServerError'
1778 '503':
1779 $ref: '#/components/responses/ServiceUnavailable'
1780 '5XX':
1781 $ref: '#/components/responses/UnexpectedError'
1782 default:
1783 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02001784 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1785 parameters:
1786 - name: nsInstanceId
1787 in: path
1788 required: true
1789 description: NS Instance ID
1790 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02001791 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02001792 post:
1793 tags:
1794 - "NS instances"
1795 summary: Execute an action on a NS instance
1796 description: |
1797 Execute an action on a NS instance.
1798 The NS instance must have been created and must be in INSTANTIATED state.
1799 operationId: actionOnNSinstance
1800 requestBody:
1801 content:
1802 application/json:
1803 schema:
1804 $ref: '#/components/schemas/NSinstanceActionRequest'
1805 application/yaml:
1806 schema:
1807 $ref: '#/components/schemas/NSinstanceActionRequest'
1808 responses:
1809 '202':
1810 description: Accepted
1811 headers:
1812 Location:
1813 description: |
1814 It must point to the new "NS Lifecycle Operation Occurrence"
1815 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1816 schema:
1817 type: string
1818 format: uri
1819 content:
1820 application/json:
1821 schema:
1822 $ref: '#/components/schemas/ObjectId'
1823 application/yaml:
1824 schema:
1825 $ref: '#/components/schemas/ObjectId'
1826 '400':
1827 $ref: '#/components/responses/BadRequest'
1828 '401':
1829 $ref: '#/components/responses/Unauthorized'
1830 '403':
1831 $ref: '#/components/responses/Forbidden'
1832 '404':
1833 $ref: '#/components/responses/NotFound'
1834 '405':
1835 $ref: '#/components/responses/MethodNotAllowed'
1836 '406':
1837 $ref: '#/components/responses/NotAcceptable'
1838 '409':
1839 $ref: '#/components/responses/Conflict'
1840 '422':
1841 $ref: '#/components/responses/UnprocessableEntity'
1842 '500':
1843 $ref: '#/components/responses/InternalServerError'
1844 '503':
1845 $ref: '#/components/responses/ServiceUnavailable'
1846 '5XX':
1847 $ref: '#/components/responses/UnexpectedError'
1848 default:
1849 $ref: '#/components/responses/UnexpectedError'
elumalaif2eb5e72022-03-21 19:44:39 +05301850 '/nslcm/v1/ns_instances/{nsInstanceId}/update':
1851 parameters:
1852 - name: nsInstanceId
1853 in: path
1854 required: true
1855 description: NS Instance ID
1856 schema:
1857 type: string
1858 post:
1859 tags:
1860 - "NS instances"
1861 summary: Update a NS instance
1862 description: |
1863 Update a NS instance. The precondition is that the NS instance must have
1864 been created and must be in INSTANTIATED state. As a result of the
1865 success of this operation, the NFVO creates a "NS Lifecycle Operation
1866 Occurrence" resource for the request, and the NS instance state remains
1867 INSTANTIATED.
1868 operationId: updateNSinstance
1869 requestBody:
1870 $ref: '#/components/requestBodies/UpdateNsRequest'
1871 responses:
1872 '202':
1873 description: Accepted
1874 headers:
1875 Location:
1876 description: |
1877 It must point to the new "NS Lifecycle Operation Occurrence"
1878 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1879 schema:
1880 type: string
1881 format: uri
1882 '400':
1883 $ref: '#/components/responses/BadRequest'
1884 '401':
1885 $ref: '#/components/responses/Unauthorized'
1886 '403':
1887 $ref: '#/components/responses/Forbidden'
1888 '404':
1889 $ref: '#/components/responses/NotFound'
1890 '405':
1891 $ref: '#/components/responses/MethodNotAllowed'
1892 '406':
1893 $ref: '#/components/responses/NotAcceptable'
1894 '409':
1895 $ref: '#/components/responses/Conflict'
1896 '422':
1897 $ref: '#/components/responses/UnprocessableEntity'
1898 '500':
1899 $ref: '#/components/responses/InternalServerError'
1900 '503':
1901 $ref: '#/components/responses/ServiceUnavailable'
1902 '5XX':
1903 $ref: '#/components/responses/UnexpectedError'
1904 default:
1905 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02001906 '/nslcm/v1/ns_instances_content':
1907 get:
1908 tags:
1909 - "NS instances"
1910 summary: Query information about multiple NS instances
1911 description: Query information about multiple NS isntances
1912 operationId: getNSinstancesContent
1913 responses:
1914 '200':
1915 description: OK
1916 content:
1917 application/json:
1918 schema:
1919 $ref: '#/components/schemas/ArrayOfNsInstance'
1920 application/yaml:
1921 schema:
1922 $ref: '#/components/schemas/ArrayOfNsInstance'
1923 '400':
1924 $ref: '#/components/responses/BadRequest'
1925 '401':
1926 $ref: '#/components/responses/Unauthorized'
1927 '403':
1928 $ref: '#/components/responses/Forbidden'
1929 '404':
1930 $ref: '#/components/responses/NotFound'
1931 '405':
1932 $ref: '#/components/responses/MethodNotAllowed'
1933 '406':
1934 $ref: '#/components/responses/NotAcceptable'
1935 '409':
1936 $ref: '#/components/responses/Conflict'
1937 '422':
1938 $ref: '#/components/responses/UnprocessableEntity'
1939 '500':
1940 $ref: '#/components/responses/InternalServerError'
1941 '503':
1942 $ref: '#/components/responses/ServiceUnavailable'
1943 '5XX':
1944 $ref: '#/components/responses/UnexpectedError'
1945 default:
1946 $ref: '#/components/responses/UnexpectedError'
1947 post:
1948 tags:
1949 - "NS instances"
1950 summary: Create a new NS instance
1951 description: Create a new NS instance
1952 operationId: createNSinstanceContent
1953 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02001954 $ref: '#/components/requestBodies/InstantiateNsRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02001955 responses:
1956 '201':
1957 description: Created
1958 headers:
1959 Location:
1960 schema:
1961 type: string
1962 format: uri
1963 content:
1964 application/json:
1965 schema:
1966 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1967 application/yaml:
1968 schema:
1969 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1970 '400':
1971 $ref: '#/components/responses/BadRequest'
1972 '401':
1973 $ref: '#/components/responses/Unauthorized'
1974 '403':
1975 $ref: '#/components/responses/Forbidden'
1976 '404':
1977 $ref: '#/components/responses/NotFound'
1978 '405':
1979 $ref: '#/components/responses/MethodNotAllowed'
1980 '406':
1981 $ref: '#/components/responses/NotAcceptable'
1982 '409':
1983 $ref: '#/components/responses/Conflict'
1984 '422':
1985 $ref: '#/components/responses/UnprocessableEntity'
1986 '500':
1987 $ref: '#/components/responses/InternalServerError'
1988 '503':
1989 $ref: '#/components/responses/ServiceUnavailable'
1990 '5XX':
1991 $ref: '#/components/responses/UnexpectedError'
1992 default:
1993 $ref: '#/components/responses/UnexpectedError'
1994 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1995 parameters:
1996 - name: nsInstanceContentId
1997 in: path
1998 required: true
1999 description: NS Instance Content ID
2000 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002001 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002002 get:
2003 tags:
2004 - "NS instances"
2005 summary: Read an individual NS instance resource
2006 description: Read an individual NS instance resource
2007 operationId: getNSinstanceContent
2008 responses:
2009 '200':
2010 description: OK
2011 content:
2012 application/json:
2013 schema:
2014 $ref: '#/components/schemas/NsInstance'
2015 application/yaml:
2016 schema:
2017 $ref: '#/components/schemas/NsInstance'
2018 '400':
2019 $ref: '#/components/responses/BadRequest'
2020 '401':
2021 $ref: '#/components/responses/Unauthorized'
2022 '403':
2023 $ref: '#/components/responses/Forbidden'
2024 '404':
2025 $ref: '#/components/responses/NotFound'
2026 '405':
2027 $ref: '#/components/responses/MethodNotAllowed'
2028 '406':
2029 $ref: '#/components/responses/NotAcceptable'
2030 '409':
2031 $ref: '#/components/responses/Conflict'
2032 '422':
2033 $ref: '#/components/responses/UnprocessableEntity'
2034 '500':
2035 $ref: '#/components/responses/InternalServerError'
2036 '503':
2037 $ref: '#/components/responses/ServiceUnavailable'
2038 '5XX':
2039 $ref: '#/components/responses/UnexpectedError'
2040 default:
2041 $ref: '#/components/responses/UnexpectedError'
2042 delete:
2043 tags:
2044 - "NS instances"
2045 summary: Delete an individual NS instance resource
2046 description: Delete an individual NS instance resource
2047 operationId: deleteNSinstanceContent
2048 responses:
2049 '202':
2050 description: Accepted
2051 content:
2052 application/json:
2053 schema:
2054 $ref: '#/components/schemas/ObjectId'
2055 application/yaml:
2056 schema:
2057 $ref: '#/components/schemas/ObjectId'
2058 '204':
2059 description: No Content
2060 '400':
2061 $ref: '#/components/responses/BadRequest'
2062 '401':
2063 $ref: '#/components/responses/Unauthorized'
2064 '403':
2065 $ref: '#/components/responses/Forbidden'
2066 '404':
2067 $ref: '#/components/responses/NotFound'
2068 '405':
2069 $ref: '#/components/responses/MethodNotAllowed'
2070 '406':
2071 $ref: '#/components/responses/NotAcceptable'
2072 '409':
2073 $ref: '#/components/responses/Conflict'
2074 '422':
2075 $ref: '#/components/responses/UnprocessableEntity'
2076 '500':
2077 $ref: '#/components/responses/InternalServerError'
2078 '503':
2079 $ref: '#/components/responses/ServiceUnavailable'
2080 '5XX':
2081 $ref: '#/components/responses/UnexpectedError'
2082 default:
2083 $ref: '#/components/responses/UnexpectedError'
2084 '/nslcm/v1/ns_lcm_op_occs':
2085 get:
2086 tags:
2087 - "NS instances"
2088 summary: Query information about multiple NS LCM Operation Occurrences
2089 description: Query information about multiple NS LCM Operation Occurrences
2090 operationId: getNSLCMOpOccs
2091 responses:
2092 '200':
2093 description: OK
2094 content:
2095 application/json:
2096 schema:
2097 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2098 application/yaml:
2099 schema:
2100 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2101 '400':
2102 $ref: '#/components/responses/BadRequest'
2103 '401':
2104 $ref: '#/components/responses/Unauthorized'
2105 '403':
2106 $ref: '#/components/responses/Forbidden'
2107 '404':
2108 $ref: '#/components/responses/NotFound'
2109 '405':
2110 $ref: '#/components/responses/MethodNotAllowed'
2111 '406':
2112 $ref: '#/components/responses/NotAcceptable'
2113 '409':
2114 $ref: '#/components/responses/Conflict'
2115 '422':
2116 $ref: '#/components/responses/UnprocessableEntity'
2117 '500':
2118 $ref: '#/components/responses/InternalServerError'
2119 '503':
2120 $ref: '#/components/responses/ServiceUnavailable'
2121 '5XX':
2122 $ref: '#/components/responses/UnexpectedError'
2123 default:
2124 $ref: '#/components/responses/UnexpectedError'
2125 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2126 parameters:
2127 - name: nsLcmOpOccId
2128 in: path
2129 required: true
2130 description: NS LCM Operation Occurrence ID
2131 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002132 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002133 get:
2134 tags:
2135 - "NS instances"
2136 summary: Query information about an individual NS LCM Operation Occurrence
2137 description: Query information about an individual NS LCM Operation Occurrence
2138 operationId: getNSLCMOpOcc
2139 responses:
2140 '200':
2141 description: OK
2142 content:
2143 application/json:
2144 schema:
2145 $ref: '#/components/schemas/NsLcmOpOcc'
2146 application/yaml:
2147 schema:
2148 $ref: '#/components/schemas/NsLcmOpOcc'
2149 '400':
2150 $ref: '#/components/responses/BadRequest'
2151 '401':
2152 $ref: '#/components/responses/Unauthorized'
2153 '403':
2154 $ref: '#/components/responses/Forbidden'
2155 '404':
2156 $ref: '#/components/responses/NotFound'
2157 '405':
2158 $ref: '#/components/responses/MethodNotAllowed'
2159 '406':
2160 $ref: '#/components/responses/NotAcceptable'
2161 '409':
2162 $ref: '#/components/responses/Conflict'
2163 '422':
2164 $ref: '#/components/responses/UnprocessableEntity'
2165 '500':
2166 $ref: '#/components/responses/InternalServerError'
2167 '503':
2168 $ref: '#/components/responses/ServiceUnavailable'
2169 '5XX':
2170 $ref: '#/components/responses/UnexpectedError'
2171 default:
2172 $ref: '#/components/responses/UnexpectedError'
Gabriel Cuba2c8be082023-11-14 16:52:01 -05002173 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
2174 parameters:
2175 - name: nsLcmOpOccId
2176 in: path
2177 required: true
2178 description: NS LCM Operation Occurrence ID
2179 schema:
2180 type: string
2181 post:
2182 tags:
2183 - "NS instances"
2184 summary: Cancel an ongoing NS lifecycle management operation
2185 description: Cancel an ongoing NS lifecycle management operation while it is being executed or rolled back
2186 operationId: cancelNSLCMOpOcc
2187 requestBody:
2188 $ref: '#/components/requestBodies/CancelNSLCMOpOccRequest'
2189 responses:
2190 '202':
2191 description: Accepted
2192 '400':
2193 $ref: '#/components/responses/BadRequest'
2194 '401':
2195 $ref: '#/components/responses/Unauthorized'
2196 '403':
2197 $ref: '#/components/responses/Forbidden'
2198 '404':
2199 $ref: '#/components/responses/NotFound'
2200 '405':
2201 $ref: '#/components/responses/MethodNotAllowed'
2202 '406':
2203 $ref: '#/components/responses/NotAcceptable'
2204 '409':
2205 $ref: '#/components/responses/Conflict'
2206 '422':
2207 $ref: '#/components/responses/UnprocessableEntity'
2208 '500':
2209 $ref: '#/components/responses/InternalServerError'
2210 '503':
2211 $ref: '#/components/responses/ServiceUnavailable'
2212 '5XX':
2213 $ref: '#/components/responses/UnexpectedError'
2214 default:
2215 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002216 '/nslcm/v1/vnf_instances':
2217 get:
2218 tags:
2219 - "NS instances"
2220 summary: Query information about multiple VNF Instances
2221 description: Query information about multiple VNF Instances
2222 operationId: getVnfInstances
2223 responses:
2224 '200':
2225 description: OK
2226 content:
2227 application/json:
2228 schema:
2229 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2230 application/yaml:
2231 schema:
2232 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2233 '400':
2234 $ref: '#/components/responses/BadRequest'
2235 '401':
2236 $ref: '#/components/responses/Unauthorized'
2237 '403':
2238 $ref: '#/components/responses/Forbidden'
2239 '404':
2240 $ref: '#/components/responses/NotFound'
2241 '405':
2242 $ref: '#/components/responses/MethodNotAllowed'
2243 '406':
2244 $ref: '#/components/responses/NotAcceptable'
2245 '409':
2246 $ref: '#/components/responses/Conflict'
2247 '422':
2248 $ref: '#/components/responses/UnprocessableEntity'
2249 '500':
2250 $ref: '#/components/responses/InternalServerError'
2251 '503':
2252 $ref: '#/components/responses/ServiceUnavailable'
2253 '5XX':
2254 $ref: '#/components/responses/UnexpectedError'
2255 default:
2256 $ref: '#/components/responses/UnexpectedError'
2257 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2258 parameters:
2259 - name: vnfInstanceId
2260 in: path
2261 required: true
2262 description: VNF Instance ID
2263 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002264 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002265 get:
2266 tags:
2267 - "NS instances"
2268 summary: Query information about an individual VNF Instance
2269 description: Query information about an individual VNF Instance
2270 operationId: getVnfInstance
2271 responses:
2272 '200':
2273 description: OK
2274 content:
2275 application/json:
2276 schema:
2277 $ref: '#/components/schemas/VnfInstanceInfo'
2278 application/yaml:
2279 schema:
2280 $ref: '#/components/schemas/VnfInstanceInfo'
2281 '400':
2282 $ref: '#/components/responses/BadRequest'
2283 '401':
2284 $ref: '#/components/responses/Unauthorized'
2285 '403':
2286 $ref: '#/components/responses/Forbidden'
2287 '404':
2288 $ref: '#/components/responses/NotFound'
2289 '405':
2290 $ref: '#/components/responses/MethodNotAllowed'
2291 '406':
2292 $ref: '#/components/responses/NotAcceptable'
2293 '409':
2294 $ref: '#/components/responses/Conflict'
2295 '422':
2296 $ref: '#/components/responses/UnprocessableEntity'
2297 '500':
2298 $ref: '#/components/responses/InternalServerError'
2299 '503':
2300 $ref: '#/components/responses/ServiceUnavailable'
2301 '5XX':
2302 $ref: '#/components/responses/UnexpectedError'
2303 default:
2304 $ref: '#/components/responses/UnexpectedError'
garciadeblasb5a065f2022-02-11 00:27:47 +01002305 '/nslcm/v1/subscriptions':
preethika.p31b3a802020-07-28 09:14:01 +00002306 get:
2307 tags:
2308 - NS instances
2309 summary: Query information about multiple NS instance subscription
2310 description: Query information about multiple NS instance subscription
2311 operationId: getNsSubcriptions
2312 responses:
2313 '200':
2314 description: OK
2315 content:
2316 application/json:
2317 schema:
2318 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2319 application/yaml:
2320 schema:
2321 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2322 '400':
2323 $ref: '#/components/responses/BadRequest'
2324 '401':
2325 $ref: '#/components/responses/Unauthorized'
2326 '403':
2327 $ref: '#/components/responses/Forbidden'
2328 '404':
2329 $ref: '#/components/responses/NotFound'
2330 '405':
2331 $ref: '#/components/responses/MethodNotAllowed'
2332 '406':
2333 $ref: '#/components/responses/NotAcceptable'
2334 '409':
2335 $ref: '#/components/responses/Conflict'
2336 '422':
2337 $ref: '#/components/responses/UnprocessableEntity'
2338 '500':
2339 $ref: '#/components/responses/InternalServerError'
2340 '503':
2341 $ref: '#/components/responses/ServiceUnavailable'
2342 5XX:
2343 $ref: '#/components/responses/UnexpectedError'
2344 default:
2345 $ref: '#/components/responses/UnexpectedError'
2346 post:
2347 tags:
2348 - NS instances
2349 summary: Create a new subscription for the Network service
2350 description: Create a new subscription for the Network service
2351 operationId: addNsSubcriptions
2352 requestBody:
2353 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2354 responses:
2355 '201':
2356 description: Created
2357 headers:
2358 Location:
2359 schema:
2360 type: object
2361 content:
2362 application/json:
2363 schema:
2364 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2365 application/yaml:
2366 schema:
2367 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2368 '400':
2369 $ref: '#/components/responses/BadRequest'
2370 '401':
2371 $ref: '#/components/responses/Unauthorized'
2372 '403':
2373 $ref: '#/components/responses/Forbidden'
2374 '404':
2375 $ref: '#/components/responses/NotFound'
2376 '405':
2377 $ref: '#/components/responses/MethodNotAllowed'
2378 '406':
2379 $ref: '#/components/responses/NotAcceptable'
2380 '409':
2381 $ref: '#/components/responses/Conflict'
2382 '422':
2383 $ref: '#/components/responses/UnprocessableEntity'
2384 '500':
2385 $ref: '#/components/responses/InternalServerError'
2386 '503':
2387 $ref: '#/components/responses/ServiceUnavailable'
2388 5XX:
2389 $ref: '#/components/responses/UnexpectedError'
2390 default:
2391 $ref: '#/components/responses/UnexpectedError'
2392 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2393 parameters:
2394 - name: nsSubscriptionsId
2395 in: path
2396 required: true
2397 description: Network Service Subscription ID
2398 schema:
2399 type: string
2400 get:
2401 tags:
2402 - NS instances
2403 summary: Read information about an individual Network Service Subscription
2404 description: Read information about an individual Network Service Subscription
2405 operationId: getNsSubcriptionId
2406 responses:
2407 '200':
2408 description: OK
2409 content:
2410 application/json:
2411 schema:
2412 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2413 application/yaml:
2414 schema:
2415 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2416 '400':
2417 $ref: '#/components/responses/BadRequest'
2418 '401':
2419 $ref: '#/components/responses/Unauthorized'
2420 '403':
2421 $ref: '#/components/responses/Forbidden'
2422 '404':
2423 $ref: '#/components/responses/NotFound'
2424 '405':
2425 $ref: '#/components/responses/MethodNotAllowed'
2426 '406':
2427 $ref: '#/components/responses/NotAcceptable'
2428 '409':
2429 $ref: '#/components/responses/Conflict'
2430 '422':
2431 $ref: '#/components/responses/UnprocessableEntity'
2432 '500':
2433 $ref: '#/components/responses/InternalServerError'
2434 '503':
2435 $ref: '#/components/responses/ServiceUnavailable'
2436 5XX:
2437 $ref: '#/components/responses/UnexpectedError'
2438 default:
2439 $ref: '#/components/responses/UnexpectedError'
2440 delete:
2441 tags:
2442 - NS instances
2443 summary: Delete an individual Network Service Subscription
2444 description: Delete an individual Network Service Subscription
2445 operationId: deleteNsSubcriptionId
2446 responses:
2447 '204':
2448 description: No Content
2449 '400':
2450 $ref: '#/components/responses/BadRequest'
2451 '401':
2452 $ref: '#/components/responses/Unauthorized'
2453 '403':
2454 $ref: '#/components/responses/Forbidden'
2455 '404':
2456 $ref: '#/components/responses/NotFound'
2457 '405':
2458 $ref: '#/components/responses/MethodNotAllowed'
2459 '406':
2460 $ref: '#/components/responses/NotAcceptable'
2461 '409':
2462 $ref: '#/components/responses/Conflict'
2463 '422':
2464 $ref: '#/components/responses/UnprocessableEntity'
2465 '500':
2466 $ref: '#/components/responses/InternalServerError'
2467 '503':
2468 $ref: '#/components/responses/ServiceUnavailable'
2469 5XX:
2470 $ref: '#/components/responses/UnexpectedError'
2471 default:
2472 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02002473# END NS Instances
2474
Atul Agarwal4cd9e952021-05-20 09:24:26 +00002475# BEGIN Alarms
2476 '/nsfm/v1/alarms':
2477 get:
2478 tags:
2479 - "Alarms"
2480 summary: Query information about multiple alarms
2481 description: Query information about multiple alarms
2482 operationId: getAlarms
2483 responses:
2484 '200':
2485 description: OK
2486 content:
2487 application/json:
2488 schema:
2489 $ref: '#/components/schemas/ArrayOfAlarm'
2490 application/yaml:
2491 schema:
2492 $ref: '#/components/schemas/ArrayOfAlarm'
2493 '400':
2494 $ref: '#/components/responses/BadRequest'
2495 '401':
2496 $ref: '#/components/responses/Unauthorized'
2497 '403':
2498 $ref: '#/components/responses/Forbidden'
2499 '404':
2500 $ref: '#/components/responses/NotFound'
2501 '405':
2502 $ref: '#/components/responses/MethodNotAllowed'
2503 '406':
2504 $ref: '#/components/responses/NotAcceptable'
2505 '409':
2506 $ref: '#/components/responses/Conflict'
2507 '422':
2508 $ref: '#/components/responses/UnprocessableEntity'
2509 '500':
2510 $ref: '#/components/responses/InternalServerError'
2511 '503':
2512 $ref: '#/components/responses/ServiceUnavailable'
2513 '5XX':
2514 $ref: '#/components/responses/UnexpectedError'
2515 default:
2516 $ref: '#/components/responses/UnexpectedError'
2517 '/nsfm/v1/alarms/{uuid}':
2518 parameters:
2519 - name: uuid
2520 in: path
2521 required: true
2522 description: Alarm UUID
2523 schema:
2524 type: string
2525 get:
2526 tags:
2527 - "Alarms"
2528 summary: Read an individual Alarm
2529 description: Read an individual Alarm
2530 operationId: getAlarm
2531 responses:
2532 '200':
2533 description: OK
2534 content:
2535 application/json:
2536 schema:
2537 $ref: '#/components/schemas/Alarm'
2538 application/yaml:
2539 schema:
2540 $ref: '#/components/schemas/Alarm'
2541 '400':
2542 $ref: '#/components/responses/BadRequest'
2543 '401':
2544 $ref: '#/components/responses/Unauthorized'
2545 '403':
2546 $ref: '#/components/responses/Forbidden'
2547 '404':
2548 $ref: '#/components/responses/NotFound'
2549 '405':
2550 $ref: '#/components/responses/MethodNotAllowed'
2551 '406':
2552 $ref: '#/components/responses/NotAcceptable'
2553 '409':
2554 $ref: '#/components/responses/Conflict'
2555 '422':
2556 $ref: '#/components/responses/UnprocessableEntity'
2557 '500':
2558 $ref: '#/components/responses/InternalServerError'
2559 '503':
2560 $ref: '#/components/responses/ServiceUnavailable'
2561 '5XX':
2562 $ref: '#/components/responses/UnexpectedError'
2563 default:
2564 $ref: '#/components/responses/UnexpectedError'
2565 patch:
2566 tags:
2567 - "Alarms"
2568 summary: Modify the data of an individual Alarm
2569 description: Modify the data of an individual Alarm
2570 operationId: updateAlarm
2571 requestBody:
2572 $ref: '#/components/requestBodies/AlarmInfoModifications'
2573 responses:
2574 '204':
2575 description: No Content
2576 '400':
2577 $ref: '#/components/responses/BadRequest'
2578 '401':
2579 $ref: '#/components/responses/Unauthorized'
2580 '403':
2581 $ref: '#/components/responses/Forbidden'
2582 '404':
2583 $ref: '#/components/responses/NotFound'
2584 '405':
2585 $ref: '#/components/responses/MethodNotAllowed'
2586 '406':
2587 $ref: '#/components/responses/NotAcceptable'
2588 '409':
2589 $ref: '#/components/responses/Conflict'
2590 '422':
2591 $ref: '#/components/responses/UnprocessableEntity'
2592 '500':
2593 $ref: '#/components/responses/InternalServerError'
2594 '503':
2595 $ref: '#/components/responses/ServiceUnavailable'
2596 '5XX':
2597 $ref: '#/components/responses/UnexpectedError'
2598 default:
2599 $ref: '#/components/responses/UnexpectedError'
2600# END Alarms
2601
delacruzramfb52ade2019-10-07 16:46:59 +02002602# BEGIN NetSlice Templates
2603 '/nst/v1/netslice_templates':
2604 get:
2605 tags:
2606 - "NetSlice templates"
2607 summary: Query information about multiple NetSlice template resources
2608 description: Query information about multiple NetSlice template resources
2609 operationId: getNSTs
2610 responses:
2611 '200':
2612 description: OK
2613 content:
2614 application/json:
2615 schema:
2616 $ref: '#/components/schemas/ArrayOfNstInfo'
2617 application/yaml:
2618 schema:
2619 $ref: '#/components/schemas/ArrayOfNstInfo'
2620 '400':
2621 $ref: '#/components/responses/BadRequest'
2622 '401':
2623 $ref: '#/components/responses/Unauthorized'
2624 '403':
2625 $ref: '#/components/responses/Forbidden'
2626 '404':
2627 $ref: '#/components/responses/NotFound'
2628 '405':
2629 $ref: '#/components/responses/MethodNotAllowed'
2630 '406':
2631 $ref: '#/components/responses/NotAcceptable'
2632 '409':
2633 $ref: '#/components/responses/Conflict'
2634 '422':
2635 $ref: '#/components/responses/UnprocessableEntity'
2636 '500':
2637 $ref: '#/components/responses/InternalServerError'
2638 '503':
2639 $ref: '#/components/responses/ServiceUnavailable'
2640 '5XX':
2641 $ref: '#/components/responses/UnexpectedError'
2642 default:
2643 $ref: '#/components/responses/UnexpectedError'
2644 post:
2645 tags:
2646 - "NetSlice templates"
2647 summary: Create a new NetSlice template resource
2648 description: Create a new NetSlice template resource
2649 operationId: addNST
2650 requestBody:
2651 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2652 responses:
2653 '201':
2654 description: Created
2655 headers:
2656 Location:
2657 schema:
2658 type: string
2659 format: uri
2660 content:
2661 application/json:
2662 schema:
2663 $ref: '#/components/schemas/ObjectId'
2664 application/yaml:
2665 schema:
2666 $ref: '#/components/schemas/ObjectId'
2667 '400':
2668 $ref: '#/components/responses/BadRequest'
2669 '401':
2670 $ref: '#/components/responses/Unauthorized'
2671 '403':
2672 $ref: '#/components/responses/Forbidden'
2673 '404':
2674 $ref: '#/components/responses/NotFound'
2675 '405':
2676 $ref: '#/components/responses/MethodNotAllowed'
2677 '406':
2678 $ref: '#/components/responses/NotAcceptable'
2679 '409':
2680 $ref: '#/components/responses/Conflict'
2681 '422':
2682 $ref: '#/components/responses/UnprocessableEntity'
2683 '500':
2684 $ref: '#/components/responses/InternalServerError'
2685 '503':
2686 $ref: '#/components/responses/ServiceUnavailable'
2687 '5XX':
2688 $ref: '#/components/responses/UnexpectedError'
2689 default:
2690 $ref: '#/components/responses/UnexpectedError'
2691 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2692 parameters:
2693 - name: netsliceTemplateId
2694 in: path
2695 required: true
2696 description: NetSlice Template ID
2697 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002698 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002699 get:
2700 tags:
2701 - "NetSlice templates"
2702 summary: Read information about an individual NetSlice template resource
2703 description: Read information about an individual NetSlice template resource
2704 operationId: getNST
2705 responses:
2706 '200':
2707 description: OK
2708 content:
2709 application/json:
2710 schema:
2711 $ref: '#/components/schemas/NstInfo'
2712 application/yaml:
2713 schema:
2714 $ref: '#/components/schemas/NstInfo'
2715 '400':
2716 $ref: '#/components/responses/BadRequest'
2717 '401':
2718 $ref: '#/components/responses/Unauthorized'
2719 '403':
2720 $ref: '#/components/responses/Forbidden'
2721 '404':
2722 $ref: '#/components/responses/NotFound'
2723 '405':
2724 $ref: '#/components/responses/MethodNotAllowed'
2725 '406':
2726 $ref: '#/components/responses/NotAcceptable'
2727 '409':
2728 $ref: '#/components/responses/Conflict'
2729 '422':
2730 $ref: '#/components/responses/UnprocessableEntity'
2731 '500':
2732 $ref: '#/components/responses/InternalServerError'
2733 '503':
2734 $ref: '#/components/responses/ServiceUnavailable'
2735 '5XX':
2736 $ref: '#/components/responses/UnexpectedError'
2737 default:
2738 $ref: '#/components/responses/UnexpectedError'
2739 delete:
2740 tags:
2741 - "NetSlice templates"
2742 summary: Delete an individual NetSlice template resource
2743 description: Delete an individual NetSlice template resource
2744 operationId: deleteNST
2745 responses:
2746 '204':
2747 description: No Content
2748 '400':
2749 $ref: '#/components/responses/BadRequest'
2750 '401':
2751 $ref: '#/components/responses/Unauthorized'
2752 '403':
2753 $ref: '#/components/responses/Forbidden'
2754 '404':
2755 $ref: '#/components/responses/NotFound'
2756 '405':
2757 $ref: '#/components/responses/MethodNotAllowed'
2758 '406':
2759 $ref: '#/components/responses/NotAcceptable'
2760 '409':
2761 $ref: '#/components/responses/Conflict'
2762 '422':
2763 $ref: '#/components/responses/UnprocessableEntity'
2764 '500':
2765 $ref: '#/components/responses/InternalServerError'
2766 '503':
2767 $ref: '#/components/responses/ServiceUnavailable'
2768 '5XX':
2769 $ref: '#/components/responses/UnexpectedError'
2770 default:
2771 $ref: '#/components/responses/UnexpectedError'
2772 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2773 parameters:
2774 - name: netsliceTemplateId
2775 in: path
2776 required: true
2777 description: NetSlice Template ID
2778 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002779 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002780 - name: artifactPath
2781 in: path
2782 required: true
2783 description: Artifact Path
2784 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002785 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002786 get:
2787 tags:
2788 - "NetSlice templates"
2789 summary: Fetch individual NetSlice Template artifact
2790 description: Fetch individual NetSlice Template artifact
2791 operationId: getNstArtifact
2792 responses:
2793 '200':
2794 description: OK
2795 content:
2796 application/octet-stream:
2797 schema:
2798 type: string
2799 format: binary
2800 '206':
2801 description: Partial Content
2802 headers:
2803 Content-Range:
2804 schema:
2805 type: string
2806 content:
2807 application/octet-stream:
2808 schema:
2809 type: string
2810 format: binary
2811 '400':
2812 $ref: '#/components/responses/BadRequest'
2813 '401':
2814 $ref: '#/components/responses/Unauthorized'
2815 '403':
2816 $ref: '#/components/responses/Forbidden'
2817 '404':
2818 $ref: '#/components/responses/NotFound'
2819 '405':
2820 $ref: '#/components/responses/MethodNotAllowed'
2821 '406':
2822 $ref: '#/components/responses/NotAcceptable'
2823 '409':
2824 $ref: '#/components/responses/Conflict'
2825 '422':
2826 $ref: '#/components/responses/UnprocessableEntity'
2827 '500':
2828 $ref: '#/components/responses/InternalServerError'
2829 '503':
2830 $ref: '#/components/responses/ServiceUnavailable'
2831 '5XX':
2832 $ref: '#/components/responses/UnexpectedError'
2833 default:
2834 $ref: '#/components/responses/UnexpectedError'
2835 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2836 parameters:
2837 - name: netsliceTemplateId
2838 in: path
2839 required: true
2840 description: NetSlice Template ID
2841 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002842 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002843 get:
2844 tags:
2845 - "NetSlice templates"
2846 summary: Read NST of an on-boarded NetSlice Template
2847 description: Read NST of an on-boarded NetSlice Template
2848 operationId: getNstNst
2849 responses:
2850 '200':
2851 description: OK
2852 content:
2853 text/plain:
2854 schema:
2855 $ref: '#/components/schemas/NetSliceTemplate'
2856 '400':
2857 $ref: '#/components/responses/BadRequest'
2858 '401':
2859 $ref: '#/components/responses/Unauthorized'
2860 '403':
2861 $ref: '#/components/responses/Forbidden'
2862 '404':
2863 $ref: '#/components/responses/NotFound'
2864 '405':
2865 $ref: '#/components/responses/MethodNotAllowed'
2866 '406':
2867 $ref: '#/components/responses/NotAcceptable'
2868 '409':
2869 $ref: '#/components/responses/Conflict'
2870 '422':
2871 $ref: '#/components/responses/UnprocessableEntity'
2872 '500':
2873 $ref: '#/components/responses/InternalServerError'
2874 '503':
2875 $ref: '#/components/responses/ServiceUnavailable'
2876 '5XX':
2877 $ref: '#/components/responses/UnexpectedError'
2878 default:
2879 $ref: '#/components/responses/UnexpectedError'
2880 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2881 parameters:
2882 - name: netsliceTemplateId
2883 in: path
2884 required: true
2885 description: NetSlice Template ID
2886 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02002887 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02002888 get:
2889 tags:
2890 - "NetSlice templates"
2891 summary: Fetch the content of a NST
2892 description: Fetch the content of a NST
2893 operationId: getNSTcontent
2894 responses:
2895 '200':
2896 description: OK
2897 content:
2898 application/zip:
2899 schema:
2900 $ref: '#/components/schemas/NetSlicePackage'
2901 '206':
2902 description: Partial Content
2903 headers:
2904 Content-Range:
2905 schema:
2906 type: string
2907 content:
2908 application/zip:
2909 schema:
2910 $ref: '#/components/schemas/NetSlicePackage'
2911 '400':
2912 $ref: '#/components/responses/BadRequest'
2913 '401':
2914 $ref: '#/components/responses/Unauthorized'
2915 '403':
2916 $ref: '#/components/responses/Forbidden'
2917 '404':
2918 $ref: '#/components/responses/NotFound'
2919 '405':
2920 $ref: '#/components/responses/MethodNotAllowed'
2921 '406':
2922 $ref: '#/components/responses/NotAcceptable'
2923 '409':
2924 $ref: '#/components/responses/Conflict'
2925 '422':
2926 $ref: '#/components/responses/UnprocessableEntity'
2927 '500':
2928 $ref: '#/components/responses/InternalServerError'
2929 '503':
2930 $ref: '#/components/responses/ServiceUnavailable'
2931 '5XX':
2932 $ref: '#/components/responses/UnexpectedError'
2933 default:
2934 $ref: '#/components/responses/UnexpectedError'
2935 put:
2936 tags:
2937 - "NetSlice templates"
2938 summary: Upload the content of a NST
2939 description: Upload the content of a NST
2940 operationId: updateNSTcontent
2941 requestBody:
2942 $ref: '#/components/requestBodies/NetSlicePackage'
2943 responses:
2944 '202':
2945 description: Accepted
2946 '204':
2947 description: No Content
2948 '400':
2949 $ref: '#/components/responses/BadRequest'
2950 '401':
2951 $ref: '#/components/responses/Unauthorized'
2952 '403':
2953 $ref: '#/components/responses/Forbidden'
2954 '404':
2955 $ref: '#/components/responses/NotFound'
2956 '405':
2957 $ref: '#/components/responses/MethodNotAllowed'
2958 '406':
2959 $ref: '#/components/responses/NotAcceptable'
2960 '409':
2961 $ref: '#/components/responses/Conflict'
2962 '422':
2963 $ref: '#/components/responses/UnprocessableEntity'
2964 '500':
2965 $ref: '#/components/responses/InternalServerError'
2966 '503':
2967 $ref: '#/components/responses/ServiceUnavailable'
2968 '5XX':
2969 $ref: '#/components/responses/UnexpectedError'
2970 default:
2971 $ref: '#/components/responses/UnexpectedError'
2972 '/nst/v1/netslice_templates_content':
2973 post:
2974 tags:
2975 - "NetSlice templates"
2976 summary: Upload a NetSlice package by providing the content of the NetSlice package
2977 description: Upload a NetSlice package by providing the content of the NetSlice package
2978 operationId: uploadNstContent
2979 requestBody:
2980 content:
2981 application/zip:
2982 schema:
2983 $ref: '#/components/schemas/NetSlicePackage'
2984 responses:
2985 '201':
2986 description: Created
2987 headers:
2988 Location:
2989 schema:
2990 type: string
2991 format: uri
2992 content:
2993 application/json:
2994 schema:
2995 $ref: '#/components/schemas/ObjectId'
2996 application/yaml:
2997 schema:
2998 $ref: '#/components/schemas/ObjectId'
2999 '202':
3000 description: Accepted
3001 '204':
3002 description: No Content
3003 '400':
3004 $ref: '#/components/responses/BadRequest'
3005 '401':
3006 $ref: '#/components/responses/Unauthorized'
3007 '403':
3008 $ref: '#/components/responses/Forbidden'
3009 '404':
3010 $ref: '#/components/responses/NotFound'
3011 '405':
3012 $ref: '#/components/responses/MethodNotAllowed'
3013 '406':
3014 $ref: '#/components/responses/NotAcceptable'
3015 '409':
3016 $ref: '#/components/responses/Conflict'
3017 '422':
3018 $ref: '#/components/responses/UnprocessableEntity'
3019 '500':
3020 $ref: '#/components/responses/InternalServerError'
3021 '503':
3022 $ref: '#/components/responses/ServiceUnavailable'
3023 '5XX':
3024 $ref: '#/components/responses/UnexpectedError'
3025 default:
3026 $ref: '#/components/responses/UnexpectedError'
3027 get:
3028 tags:
3029 - "NetSlice templates"
3030 summary: Query information about multiple NetSlice Template resources
3031 description: Query information about multiple NetSlice Template resources
3032 operationId: getNstContent
3033 responses:
3034 '200':
3035 description: OK
3036 content:
3037 application/json:
3038 schema:
3039 $ref: '#/components/schemas/ArrayOfNstInfo'
3040 application/yaml:
3041 schema:
3042 $ref: '#/components/schemas/ArrayOfNstInfo'
3043 '206':
3044 description: Partial Content
3045 headers:
3046 Content-Range:
3047 schema:
3048 type: string
3049 content:
3050 application/octet-stream:
3051 schema:
3052 type: string
3053 format: binary
3054 '400':
3055 $ref: '#/components/responses/BadRequest'
3056 '401':
3057 $ref: '#/components/responses/Unauthorized'
3058 '403':
3059 $ref: '#/components/responses/Forbidden'
3060 '404':
3061 $ref: '#/components/responses/NotFound'
3062 '405':
3063 $ref: '#/components/responses/MethodNotAllowed'
3064 '406':
3065 $ref: '#/components/responses/NotAcceptable'
3066 '409':
3067 $ref: '#/components/responses/Conflict'
3068 '422':
3069 $ref: '#/components/responses/UnprocessableEntity'
3070 '500':
3071 $ref: '#/components/responses/InternalServerError'
3072 '503':
3073 $ref: '#/components/responses/ServiceUnavailable'
3074 '5XX':
3075 $ref: '#/components/responses/UnexpectedError'
3076 default:
3077 $ref: '#/components/responses/UnexpectedError'
3078 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
3079 parameters:
3080 - name: netsliceTemplateContentId
3081 in: path
3082 required: true
3083 description: NetSlice Template ID
3084 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003085 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003086 get:
3087 tags:
3088 - "NetSlice templates"
3089 summary: Read information about an individual NetSlice Template resource
3090 description: Read information about an individual NetSlice Template resource
3091 operationId: getNstIdContent
3092 responses:
3093 '200':
3094 description: OK
3095 content:
3096 application/json:
3097 schema:
3098 $ref: '#/components/schemas/NstInfo'
3099 application/yaml:
3100 schema:
3101 $ref: '#/components/schemas/NstInfo'
3102 '400':
3103 $ref: '#/components/responses/BadRequest'
3104 '401':
3105 $ref: '#/components/responses/Unauthorized'
3106 '403':
3107 $ref: '#/components/responses/Forbidden'
3108 '404':
3109 $ref: '#/components/responses/NotFound'
3110 '405':
3111 $ref: '#/components/responses/MethodNotAllowed'
3112 '406':
3113 $ref: '#/components/responses/NotAcceptable'
3114 '409':
3115 $ref: '#/components/responses/Conflict'
3116 '422':
3117 $ref: '#/components/responses/UnprocessableEntity'
3118 '500':
3119 $ref: '#/components/responses/InternalServerError'
3120 '503':
3121 $ref: '#/components/responses/ServiceUnavailable'
3122 '5XX':
3123 $ref: '#/components/responses/UnexpectedError'
3124 default:
3125 $ref: '#/components/responses/UnexpectedError'
3126 put:
3127 tags:
3128 - "NetSlice templates"
3129 summary: Modify an individual NetSlice Template resource
3130 description: Modify an individual NetSlice Template resource
3131 operationId: updateNstIdContent
3132 requestBody:
3133 $ref: '#/components/requestBodies/NstInfoModifications'
3134 responses:
3135 '204':
3136 description: No Content
3137 '400':
3138 $ref: '#/components/responses/BadRequest'
3139 '401':
3140 $ref: '#/components/responses/Unauthorized'
3141 '403':
3142 $ref: '#/components/responses/Forbidden'
3143 '404':
3144 $ref: '#/components/responses/NotFound'
3145 '405':
3146 $ref: '#/components/responses/MethodNotAllowed'
3147 '406':
3148 $ref: '#/components/responses/NotAcceptable'
3149 '409':
3150 $ref: '#/components/responses/Conflict'
3151 '422':
3152 $ref: '#/components/responses/UnprocessableEntity'
3153 '500':
3154 $ref: '#/components/responses/InternalServerError'
3155 '503':
3156 $ref: '#/components/responses/ServiceUnavailable'
3157 '5XX':
3158 $ref: '#/components/responses/UnexpectedError'
3159 default:
3160 $ref: '#/components/responses/UnexpectedError'
3161 delete:
3162 tags:
3163 - "NetSlice templates"
3164 summary: Delete an individual NetSlice Template resource
3165 description: Delete an individual NetSlice Template resource
3166 operationId: deleteNstIdContent
3167 responses:
3168 '204':
3169 description: No Content
3170 '400':
3171 $ref: '#/components/responses/BadRequest'
3172 '401':
3173 $ref: '#/components/responses/Unauthorized'
3174 '403':
3175 $ref: '#/components/responses/Forbidden'
3176 '404':
3177 $ref: '#/components/responses/NotFound'
3178 '405':
3179 $ref: '#/components/responses/MethodNotAllowed'
3180 '406':
3181 $ref: '#/components/responses/NotAcceptable'
3182 '409':
3183 $ref: '#/components/responses/Conflict'
3184 '422':
3185 $ref: '#/components/responses/UnprocessableEntity'
3186 '500':
3187 $ref: '#/components/responses/InternalServerError'
3188 '503':
3189 $ref: '#/components/responses/ServiceUnavailable'
3190 '5XX':
3191 $ref: '#/components/responses/UnexpectedError'
3192 default:
3193 $ref: '#/components/responses/UnexpectedError'
3194# END NetSlice Templates
3195
3196# BEGIN NetSlice Instances
3197 '/nsilcm/v1/netslice_instances':
3198 get:
3199 tags:
3200 - "NetSlice instances"
3201 summary: Query information about multiple NetSlice instances
3202 description: Query information about multiple NetSlice isntances
3203 operationId: getNSIs
3204 responses:
3205 '200':
3206 description: OK
3207 content:
3208 application/json:
3209 schema:
3210 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3211 application/yaml:
3212 schema:
3213 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3214 '400':
3215 $ref: '#/components/responses/BadRequest'
3216 '401':
3217 $ref: '#/components/responses/Unauthorized'
3218 '403':
3219 $ref: '#/components/responses/Forbidden'
3220 '404':
3221 $ref: '#/components/responses/NotFound'
3222 '405':
3223 $ref: '#/components/responses/MethodNotAllowed'
3224 '406':
3225 $ref: '#/components/responses/NotAcceptable'
3226 '409':
3227 $ref: '#/components/responses/Conflict'
3228 '422':
3229 $ref: '#/components/responses/UnprocessableEntity'
3230 '500':
3231 $ref: '#/components/responses/InternalServerError'
3232 '503':
3233 $ref: '#/components/responses/ServiceUnavailable'
3234 '5XX':
3235 $ref: '#/components/responses/UnexpectedError'
3236 default:
3237 $ref: '#/components/responses/UnexpectedError'
3238 post:
3239 tags:
3240 - "NetSlice instances"
3241 summary: Create a new NetSlice instance resource
3242 description: Create a new NetSlice instance resource
3243 operationId: addNSI
3244 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02003245 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02003246 responses:
3247 '201':
3248 description: Created
3249 headers:
3250 Location:
3251 schema:
3252 type: string
3253 format: uri
3254 content:
3255 application/json:
3256 schema:
3257 $ref: '#/components/schemas/ObjectId'
3258 application/yaml:
3259 schema:
3260 $ref: '#/components/schemas/ObjectId'
3261 '400':
3262 $ref: '#/components/responses/BadRequest'
3263 '401':
3264 $ref: '#/components/responses/Unauthorized'
3265 '403':
3266 $ref: '#/components/responses/Forbidden'
3267 '404':
3268 $ref: '#/components/responses/NotFound'
3269 '405':
3270 $ref: '#/components/responses/MethodNotAllowed'
3271 '406':
3272 $ref: '#/components/responses/NotAcceptable'
3273 '409':
3274 $ref: '#/components/responses/Conflict'
3275 '422':
3276 $ref: '#/components/responses/UnprocessableEntity'
3277 '500':
3278 $ref: '#/components/responses/InternalServerError'
3279 '503':
3280 $ref: '#/components/responses/ServiceUnavailable'
3281 '5XX':
3282 $ref: '#/components/responses/UnexpectedError'
3283 default:
3284 $ref: '#/components/responses/UnexpectedError'
3285 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3286 parameters:
3287 - name: netsliceInstanceId
3288 in: path
3289 required: true
3290 description: NetSlice Instance ID
3291 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003292 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003293 get:
3294 tags:
3295 - "NetSlice instances"
3296 summary: Read an individual NetSlice instance resource
3297 description: Read an individual NetSlice instance resource
3298 operationId: getNSI
3299 responses:
3300 '200':
3301 description: OK
3302 content:
3303 application/json:
3304 schema:
3305 $ref: '#/components/schemas/NetSliceInstance'
3306 application/yaml:
3307 schema:
3308 $ref: '#/components/schemas/NetSliceInstance'
3309 '400':
3310 $ref: '#/components/responses/BadRequest'
3311 '401':
3312 $ref: '#/components/responses/Unauthorized'
3313 '403':
3314 $ref: '#/components/responses/Forbidden'
3315 '404':
3316 $ref: '#/components/responses/NotFound'
3317 '405':
3318 $ref: '#/components/responses/MethodNotAllowed'
3319 '406':
3320 $ref: '#/components/responses/NotAcceptable'
3321 '409':
3322 $ref: '#/components/responses/Conflict'
3323 '422':
3324 $ref: '#/components/responses/UnprocessableEntity'
3325 '500':
3326 $ref: '#/components/responses/InternalServerError'
3327 '503':
3328 $ref: '#/components/responses/ServiceUnavailable'
3329 '5XX':
3330 $ref: '#/components/responses/UnexpectedError'
3331 default:
3332 $ref: '#/components/responses/UnexpectedError'
3333 delete:
3334 tags:
3335 - "NetSlice instances"
3336 summary: Delete an individual NetSlice instance resource
3337 description: Delete an individual NetSlice instance resource
3338 operationId: deleteNSI
3339 responses:
3340 '204':
3341 description: No Content
3342 '400':
3343 $ref: '#/components/responses/BadRequest'
3344 '401':
3345 $ref: '#/components/responses/Unauthorized'
3346 '403':
3347 $ref: '#/components/responses/Forbidden'
3348 '404':
3349 $ref: '#/components/responses/NotFound'
3350 '405':
3351 $ref: '#/components/responses/MethodNotAllowed'
3352 '406':
3353 $ref: '#/components/responses/NotAcceptable'
3354 '409':
3355 $ref: '#/components/responses/Conflict'
3356 '422':
3357 $ref: '#/components/responses/UnprocessableEntity'
3358 '500':
3359 $ref: '#/components/responses/InternalServerError'
3360 '503':
3361 $ref: '#/components/responses/ServiceUnavailable'
3362 '5XX':
3363 $ref: '#/components/responses/UnexpectedError'
3364 default:
3365 $ref: '#/components/responses/UnexpectedError'
3366 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3367 parameters:
3368 - name: netsliceInstanceId
3369 in: path
3370 required: true
3371 description: NetSlice Instance ID
3372 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003373 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003374 post:
3375 tags:
3376 - "NetSlice instances"
3377 summary: Instantiate a NetSlice
3378 description: |
3379 Instantiate a NetSlice. The precondition is that the NetSlice instance
3380 must have been created and must be in NOT_INSTANTIATED state. As a result
3381 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3382 Operation Occurrence" resource for the request, and the NS instance state
3383 becomes INSTANTIATED.
3384 operationId: instantiateNSI
3385 requestBody:
3386 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3387 responses:
3388 '202':
3389 description: Accepted
3390 headers:
3391 Location:
3392 description: |
3393 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3394 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3395 schema:
3396 type: string
3397 format: uri
3398 content:
3399 application/json:
3400 schema:
3401 $ref: '#/components/schemas/ObjectId'
3402 application/yaml:
3403 schema:
3404 $ref: '#/components/schemas/ObjectId'
3405 '400':
3406 $ref: '#/components/responses/BadRequest'
3407 '401':
3408 $ref: '#/components/responses/Unauthorized'
3409 '403':
3410 $ref: '#/components/responses/Forbidden'
3411 '404':
3412 $ref: '#/components/responses/NotFound'
3413 '405':
3414 $ref: '#/components/responses/MethodNotAllowed'
3415 '406':
3416 $ref: '#/components/responses/NotAcceptable'
3417 '409':
3418 $ref: '#/components/responses/Conflict'
3419 '422':
3420 $ref: '#/components/responses/UnprocessableEntity'
3421 '500':
3422 $ref: '#/components/responses/InternalServerError'
3423 '503':
3424 $ref: '#/components/responses/ServiceUnavailable'
3425 '5XX':
3426 $ref: '#/components/responses/UnexpectedError'
3427 default:
3428 $ref: '#/components/responses/UnexpectedError'
3429 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3430 parameters:
3431 - name: netsliceInstanceId
3432 in: path
3433 required: true
3434 description: NetSlice Instance ID
3435 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003436 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003437 post:
3438 tags:
3439 - "NetSlice instances"
3440 summary: Terminate a NetSlice instance
3441 description: |
3442 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3443 must have been created and must be in INSTANTIATED state. As a result of the
3444 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3445 Occurrence" resource for the request, and the NetSlice instance state becomes
3446 NOT_INSTANTIATED.
3447 operationId: terminateNSI
3448 requestBody:
3449 # Request data is not required
3450 $ref: '#/components/requestBodies/TerminateNsiRequest'
3451 responses:
3452 '202':
3453 description: Accepted
3454 headers:
3455 Location:
3456 description: |
3457 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3458 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3459 schema:
3460 type: string
3461 format: uri
3462 content:
3463 application/json:
3464 schema:
3465 $ref: '#/components/schemas/ObjectId'
3466 application/yaml:
3467 schema:
3468 $ref: '#/components/schemas/ObjectId'
3469 '400':
3470 $ref: '#/components/responses/BadRequest'
3471 '401':
3472 $ref: '#/components/responses/Unauthorized'
3473 '403':
3474 $ref: '#/components/responses/Forbidden'
3475 '404':
3476 $ref: '#/components/responses/NotFound'
3477 '405':
3478 $ref: '#/components/responses/MethodNotAllowed'
3479 '406':
3480 $ref: '#/components/responses/NotAcceptable'
3481 '409':
3482 $ref: '#/components/responses/Conflict'
3483 '422':
3484 $ref: '#/components/responses/UnprocessableEntity'
3485 '500':
3486 $ref: '#/components/responses/InternalServerError'
3487 '503':
3488 $ref: '#/components/responses/ServiceUnavailable'
3489 '5XX':
3490 $ref: '#/components/responses/UnexpectedError'
3491 default:
3492 $ref: '#/components/responses/UnexpectedError'
3493 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3494 parameters:
3495 - name: netsliceInstanceId
3496 in: path
3497 required: true
3498 description: NetSlice Instance ID
3499 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003500 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003501 post:
3502 tags:
3503 - "NetSlice instances"
3504 summary: Execute an action on a NetSlice instance
3505 description: |
3506 Execute an action on a NetSlice instance.
3507 The NetSlice instance must have been created and must be in INSTANTIATED state.
3508 operationId: actionOnNSI
3509 requestBody:
3510 content:
3511 application/json:
3512 schema:
3513 $ref: '#/components/schemas/NsiActionRequest'
3514 application/yaml:
3515 schema:
3516 $ref: '#/components/schemas/NsiActionRequest'
3517 responses:
3518 '202':
3519 description: Accepted
3520 headers:
3521 Location:
3522 description: |
3523 It must point to the new "NS Lifecycle Operation Occurrence"
3524 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3525 schema:
3526 type: string
3527 format: uri
3528 content:
3529 application/json:
3530 schema:
3531 $ref: '#/components/schemas/ObjectId'
3532 application/yaml:
3533 schema:
3534 $ref: '#/components/schemas/ObjectId'
3535 '400':
3536 $ref: '#/components/responses/BadRequest'
3537 '401':
3538 $ref: '#/components/responses/Unauthorized'
3539 '403':
3540 $ref: '#/components/responses/Forbidden'
3541 '404':
3542 $ref: '#/components/responses/NotFound'
3543 '405':
3544 $ref: '#/components/responses/MethodNotAllowed'
3545 '406':
3546 $ref: '#/components/responses/NotAcceptable'
3547 '409':
3548 $ref: '#/components/responses/Conflict'
3549 '422':
3550 $ref: '#/components/responses/UnprocessableEntity'
3551 '500':
3552 $ref: '#/components/responses/InternalServerError'
3553 '503':
3554 $ref: '#/components/responses/ServiceUnavailable'
3555 '5XX':
3556 $ref: '#/components/responses/UnexpectedError'
3557 default:
3558 $ref: '#/components/responses/UnexpectedError'
3559 '/nsilcm/v1/netslice_instances_content':
3560 get:
3561 tags:
3562 - "NetSlice instances"
3563 summary: Query information about multiple NetSlice instances
3564 description: Query information about multiple NetSlice isntances
3565 operationId: getNSIsContent
3566 responses:
3567 '200':
3568 description: OK
3569 content:
3570 application/json:
3571 schema:
3572 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3573 application/yaml:
3574 schema:
3575 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3576 '400':
3577 $ref: '#/components/responses/BadRequest'
3578 '401':
3579 $ref: '#/components/responses/Unauthorized'
3580 '403':
3581 $ref: '#/components/responses/Forbidden'
3582 '404':
3583 $ref: '#/components/responses/NotFound'
3584 '405':
3585 $ref: '#/components/responses/MethodNotAllowed'
3586 '406':
3587 $ref: '#/components/responses/NotAcceptable'
3588 '409':
3589 $ref: '#/components/responses/Conflict'
3590 '422':
3591 $ref: '#/components/responses/UnprocessableEntity'
3592 '500':
3593 $ref: '#/components/responses/InternalServerError'
3594 '503':
3595 $ref: '#/components/responses/ServiceUnavailable'
3596 '5XX':
3597 $ref: '#/components/responses/UnexpectedError'
3598 default:
3599 $ref: '#/components/responses/UnexpectedError'
3600 post:
3601 tags:
3602 - "NetSlice instances"
3603 summary: Create a new NetSlice instance
3604 description: Create a new NetSlice instance
3605 operationId: createNSIContent
3606 requestBody:
delacruzramaf79f3c2019-10-22 13:13:01 +02003607 $ref: '#/components/requestBodies/InstantiateNsiRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02003608 responses:
3609 '201':
3610 description: Created
3611 headers:
3612 Location:
3613 schema:
3614 type: string
3615 format: uri
3616 content:
3617 application/json:
3618 schema:
3619 $ref: '#/components/schemas/CreateNsiContentResponse'
3620 application/yaml:
3621 schema:
3622 $ref: '#/components/schemas/CreateNsiContentResponse'
3623 '400':
3624 $ref: '#/components/responses/BadRequest'
3625 '401':
3626 $ref: '#/components/responses/Unauthorized'
3627 '403':
3628 $ref: '#/components/responses/Forbidden'
3629 '404':
3630 $ref: '#/components/responses/NotFound'
3631 '405':
3632 $ref: '#/components/responses/MethodNotAllowed'
3633 '406':
3634 $ref: '#/components/responses/NotAcceptable'
3635 '409':
3636 $ref: '#/components/responses/Conflict'
3637 '422':
3638 $ref: '#/components/responses/UnprocessableEntity'
3639 '500':
3640 $ref: '#/components/responses/InternalServerError'
3641 '503':
3642 $ref: '#/components/responses/ServiceUnavailable'
3643 '5XX':
3644 $ref: '#/components/responses/UnexpectedError'
3645 default:
3646 $ref: '#/components/responses/UnexpectedError'
3647 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3648 parameters:
3649 - name: netsliceInstanceContentId
3650 in: path
3651 required: true
3652 description: NetSlice Instance Content ID
3653 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003654 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003655 get:
3656 tags:
3657 - "NetSlice instances"
3658 summary: Read an individual NetSlice instance resource
3659 description: Read an individual NetSlice instance resource
3660 operationId: getNSIContent
3661 responses:
3662 '200':
3663 description: OK
3664 content:
3665 application/json:
3666 schema:
3667 $ref: '#/components/schemas/NetSliceInstance'
3668 application/yaml:
3669 schema:
3670 $ref: '#/components/schemas/NetSliceInstance'
3671 '400':
3672 $ref: '#/components/responses/BadRequest'
3673 '401':
3674 $ref: '#/components/responses/Unauthorized'
3675 '403':
3676 $ref: '#/components/responses/Forbidden'
3677 '404':
3678 $ref: '#/components/responses/NotFound'
3679 '405':
3680 $ref: '#/components/responses/MethodNotAllowed'
3681 '406':
3682 $ref: '#/components/responses/NotAcceptable'
3683 '409':
3684 $ref: '#/components/responses/Conflict'
3685 '422':
3686 $ref: '#/components/responses/UnprocessableEntity'
3687 '500':
3688 $ref: '#/components/responses/InternalServerError'
3689 '503':
3690 $ref: '#/components/responses/ServiceUnavailable'
3691 '5XX':
3692 $ref: '#/components/responses/UnexpectedError'
3693 default:
3694 $ref: '#/components/responses/UnexpectedError'
3695 delete:
3696 tags:
3697 - "NetSlice instances"
3698 summary: Delete an individual NS instance resource
3699 description: Delete an individual NS instance resource
3700 operationId: deleteNSIContent
3701 responses:
3702 '202':
3703 description: Accepted
3704 content:
3705 application/json:
3706 schema:
3707 $ref: '#/components/schemas/ObjectId'
3708 application/yaml:
3709 schema:
3710 $ref: '#/components/schemas/ObjectId'
3711 '204':
3712 description: No Content
3713 '400':
3714 $ref: '#/components/responses/BadRequest'
3715 '401':
3716 $ref: '#/components/responses/Unauthorized'
3717 '403':
3718 $ref: '#/components/responses/Forbidden'
3719 '404':
3720 $ref: '#/components/responses/NotFound'
3721 '405':
3722 $ref: '#/components/responses/MethodNotAllowed'
3723 '406':
3724 $ref: '#/components/responses/NotAcceptable'
3725 '409':
3726 $ref: '#/components/responses/Conflict'
3727 '422':
3728 $ref: '#/components/responses/UnprocessableEntity'
3729 '500':
3730 $ref: '#/components/responses/InternalServerError'
3731 '503':
3732 $ref: '#/components/responses/ServiceUnavailable'
3733 '5XX':
3734 $ref: '#/components/responses/UnexpectedError'
3735 default:
3736 $ref: '#/components/responses/UnexpectedError'
3737 '/nsilcm/v1/nsi_lcm_op_occs':
3738 get:
3739 tags:
3740 - "NetSlice instances"
3741 summary: Query information about multiple NetSlice LCM Operation Occurrences
3742 description: Query information about multiple NetSlice LCM Operation Occurrences
3743 operationId: getNsiLcmOpOccs
3744 responses:
3745 '200':
3746 description: OK
3747 content:
3748 application/json:
3749 schema:
3750 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3751 application/yaml:
3752 schema:
3753 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3754 '400':
3755 $ref: '#/components/responses/BadRequest'
3756 '401':
3757 $ref: '#/components/responses/Unauthorized'
3758 '403':
3759 $ref: '#/components/responses/Forbidden'
3760 '404':
3761 $ref: '#/components/responses/NotFound'
3762 '405':
3763 $ref: '#/components/responses/MethodNotAllowed'
3764 '406':
3765 $ref: '#/components/responses/NotAcceptable'
3766 '409':
3767 $ref: '#/components/responses/Conflict'
3768 '422':
3769 $ref: '#/components/responses/UnprocessableEntity'
3770 '500':
3771 $ref: '#/components/responses/InternalServerError'
3772 '503':
3773 $ref: '#/components/responses/ServiceUnavailable'
3774 '5XX':
3775 $ref: '#/components/responses/UnexpectedError'
3776 default:
3777 $ref: '#/components/responses/UnexpectedError'
3778 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3779 parameters:
3780 - name: nsiLcmOpOccId
3781 in: path
3782 required: true
3783 description: NetSlice LCM Operation Occurrence ID
3784 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02003785 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02003786 get:
3787 tags:
3788 - "NetSlice instances"
3789 summary: Query information about an individual NetSlice LCM Operation Occurrence
3790 description: Query information about an individual NetSlice LCM Operation Occurrence
3791 operationId: getNsiLcmOpOcc
3792 responses:
3793 '200':
3794 description: OK
3795 content:
3796 application/json:
3797 schema:
3798 $ref: '#/components/schemas/NsiLcmOpOcc'
3799 application/yaml:
3800 schema:
3801 $ref: '#/components/schemas/NsiLcmOpOcc'
3802 '400':
3803 $ref: '#/components/responses/BadRequest'
3804 '401':
3805 $ref: '#/components/responses/Unauthorized'
3806 '403':
3807 $ref: '#/components/responses/Forbidden'
3808 '404':
3809 $ref: '#/components/responses/NotFound'
3810 '405':
3811 $ref: '#/components/responses/MethodNotAllowed'
3812 '406':
3813 $ref: '#/components/responses/NotAcceptable'
3814 '409':
3815 $ref: '#/components/responses/Conflict'
3816 '422':
3817 $ref: '#/components/responses/UnprocessableEntity'
3818 '500':
3819 $ref: '#/components/responses/InternalServerError'
3820 '503':
3821 $ref: '#/components/responses/ServiceUnavailable'
3822 '5XX':
3823 $ref: '#/components/responses/UnexpectedError'
3824 default:
3825 $ref: '#/components/responses/UnexpectedError'
3826# END NetSlice Instances
3827
3828# BEGIN NSPM
delacruzramaf79f3c2019-10-22 13:13:01 +02003829 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3830 parameters:
3831 - name: pmJobId
3832 in: path
3833 required: true
3834 description: NS PM Job ID
3835 schema:
3836 type: string
3837 - name: nsId
3838 in: path
3839 required: true
3840 description: NS ID
3841 schema:
3842 type: string
3843 get:
3844 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01003845 - "NS Performance Management"
delacruzramaf79f3c2019-10-22 13:13:01 +02003846 summary: Query information about an individual NS PM Job Report
3847 description: Query information about an individual NS PM Job Report
3848 operationId: getNsPmJobReport
3849 responses:
3850 '200':
3851 description: OK
3852 content:
3853 application/json:
3854 schema:
3855 $ref: '#/components/schemas/NsPmJobReportInfo'
3856 application/yaml:
3857 schema:
3858 $ref: '#/components/schemas/NsPmJobReportInfo'
3859 '400':
3860 $ref: '#/components/responses/BadRequest'
3861 '401':
3862 $ref: '#/components/responses/Unauthorized'
3863 '403':
3864 $ref: '#/components/responses/Forbidden'
3865 '404':
3866 $ref: '#/components/responses/NotFound'
3867 '405':
3868 $ref: '#/components/responses/MethodNotAllowed'
3869 '406':
3870 $ref: '#/components/responses/NotAcceptable'
3871 '409':
3872 $ref: '#/components/responses/Conflict'
3873 '422':
3874 $ref: '#/components/responses/UnprocessableEntity'
3875 '500':
3876 $ref: '#/components/responses/InternalServerError'
3877 '503':
3878 $ref: '#/components/responses/ServiceUnavailable'
3879 '5XX':
3880 $ref: '#/components/responses/UnexpectedError'
3881 default:
3882 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02003883# END NSPM
3884
3885# BEGIN PDU
delacruzramaf79f3c2019-10-22 13:13:01 +02003886 '/pdu/v1/pdu_descriptors':
3887 get:
3888 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01003889 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02003890 summary: Query information about multiple PDU Descriptors
3891 description: Query information about multiple PDU Descriptors
3892 operationId: getPDUs
3893 responses:
3894 '200':
3895 description: OK
3896 content:
3897 application/json:
3898 schema:
3899 $ref: '#/components/schemas/ArrayOfPduInfo'
3900 application/yaml:
3901 schema:
3902 $ref: '#/components/schemas/ArrayOfPduInfo'
3903 '400':
3904 $ref: '#/components/responses/BadRequest'
3905 '401':
3906 $ref: '#/components/responses/Unauthorized'
3907 '403':
3908 $ref: '#/components/responses/Forbidden'
3909 '404':
3910 $ref: '#/components/responses/NotFound'
3911 '405':
3912 $ref: '#/components/responses/MethodNotAllowed'
3913 '406':
3914 $ref: '#/components/responses/NotAcceptable'
3915 '409':
3916 $ref: '#/components/responses/Conflict'
3917 '422':
3918 $ref: '#/components/responses/UnprocessableEntity'
3919 '500':
3920 $ref: '#/components/responses/InternalServerError'
3921 '503':
3922 $ref: '#/components/responses/ServiceUnavailable'
3923 '5XX':
3924 $ref: '#/components/responses/UnexpectedError'
3925 default:
3926 $ref: '#/components/responses/UnexpectedError'
3927 post:
3928 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01003929 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02003930 summary: Create a new PDU
3931 description: Create a new PDU Descriptor
3932 operationId: createPDU
3933 requestBody:
3934 $ref: '#/components/requestBodies/CreatePduRequest'
3935 responses:
3936 '200':
3937 description: OK
3938 headers:
3939 Location:
3940 schema:
3941 type: string
3942 format: uri
3943 content:
3944 application/json:
3945 schema:
3946 $ref: '#/components/schemas/ObjectId'
3947 application/yaml:
3948 schema:
3949 $ref: '#/components/schemas/ObjectId'
3950 '400':
3951 $ref: '#/components/responses/BadRequest'
3952 '401':
3953 $ref: '#/components/responses/Unauthorized'
3954 '403':
3955 $ref: '#/components/responses/Forbidden'
3956 '404':
3957 $ref: '#/components/responses/NotFound'
3958 '405':
3959 $ref: '#/components/responses/MethodNotAllowed'
3960 '406':
3961 $ref: '#/components/responses/NotAcceptable'
3962 '409':
3963 $ref: '#/components/responses/Conflict'
3964 '422':
3965 $ref: '#/components/responses/UnprocessableEntity'
3966 '500':
3967 $ref: '#/components/responses/InternalServerError'
3968 '503':
3969 $ref: '#/components/responses/ServiceUnavailable'
3970 '5XX':
3971 $ref: '#/components/responses/UnexpectedError'
3972 default:
3973 $ref: '#/components/responses/UnexpectedError'
3974 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3975 parameters:
3976 - name: pduDescriptorId
3977 in: path
3978 required: true
3979 description: PDU Descriptor ID
3980 schema:
3981 type: string
3982 get:
3983 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01003984 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02003985 summary: Query information about an individual PDU Descriptor
3986 description: Query information about an individual PDU Descriptor
3987 operationId: getPDU
3988 responses:
3989 '200':
3990 description: OK
3991 content:
3992 application/json:
3993 schema:
3994 $ref: '#/components/schemas/PduInfo'
3995 application/yaml:
3996 schema:
3997 $ref: '#/components/schemas/PduInfo'
3998 '400':
3999 $ref: '#/components/responses/BadRequest'
4000 '401':
4001 $ref: '#/components/responses/Unauthorized'
4002 '403':
4003 $ref: '#/components/responses/Forbidden'
4004 '404':
4005 $ref: '#/components/responses/NotFound'
4006 '405':
4007 $ref: '#/components/responses/MethodNotAllowed'
4008 '406':
4009 $ref: '#/components/responses/NotAcceptable'
4010 '409':
4011 $ref: '#/components/responses/Conflict'
4012 '422':
4013 $ref: '#/components/responses/UnprocessableEntity'
4014 '500':
4015 $ref: '#/components/responses/InternalServerError'
4016 '503':
4017 $ref: '#/components/responses/ServiceUnavailable'
4018 '5XX':
4019 $ref: '#/components/responses/UnexpectedError'
4020 default:
4021 $ref: '#/components/responses/UnexpectedError'
4022 patch:
4023 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004024 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004025 summary: Modify an individual PDU Descriptor
4026 description: Modify an individual PDU Descriptor
4027 operationId: editPDU
4028 requestBody:
4029 $ref: '#/components/requestBodies/EditPduRequest'
4030 responses:
4031 '204':
4032 description: No Content
4033 '400':
4034 $ref: '#/components/responses/BadRequest'
4035 '401':
4036 $ref: '#/components/responses/Unauthorized'
4037 '403':
4038 $ref: '#/components/responses/Forbidden'
4039 '404':
4040 $ref: '#/components/responses/NotFound'
4041 '405':
4042 $ref: '#/components/responses/MethodNotAllowed'
4043 '406':
4044 $ref: '#/components/responses/NotAcceptable'
4045 '409':
4046 $ref: '#/components/responses/Conflict'
4047 '422':
4048 $ref: '#/components/responses/UnprocessableEntity'
4049 '500':
4050 $ref: '#/components/responses/InternalServerError'
4051 '503':
4052 $ref: '#/components/responses/ServiceUnavailable'
4053 '5XX':
4054 $ref: '#/components/responses/UnexpectedError'
4055 default:
4056 $ref: '#/components/responses/UnexpectedError'
4057 delete:
4058 tags:
garciadeblasb9ceba32020-02-28 15:32:50 +01004059 - "Physical Data Units (PDU)"
delacruzramaf79f3c2019-10-22 13:13:01 +02004060 summary: Delete an individual PDU Descriptor
4061 description: Delete an individual PDU Descriptor
4062 operationId: deletePDU
4063 responses:
4064 '204':
4065 description: No Content
4066 '400':
4067 $ref: '#/components/responses/BadRequest'
4068 '401':
4069 $ref: '#/components/responses/Unauthorized'
4070 '403':
4071 $ref: '#/components/responses/Forbidden'
4072 '404':
4073 $ref: '#/components/responses/NotFound'
4074 '405':
4075 $ref: '#/components/responses/MethodNotAllowed'
4076 '406':
4077 $ref: '#/components/responses/NotAcceptable'
4078 '409':
4079 $ref: '#/components/responses/Conflict'
4080 '422':
4081 $ref: '#/components/responses/UnprocessableEntity'
4082 '500':
4083 $ref: '#/components/responses/InternalServerError'
4084 '503':
4085 $ref: '#/components/responses/ServiceUnavailable'
4086 '5XX':
4087 $ref: '#/components/responses/UnexpectedError'
4088 default:
4089 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02004090# END PDU
4091
4092# BEGIN Admin
delacruzramaf79f3c2019-10-22 13:13:01 +02004093 '/admin/v1/tokens':
4094 get:
4095 tags:
garciadeblas77849982020-02-28 15:41:43 +01004096 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004097 - "Admin"
4098 summary: Query information about multiple Tokens
4099 description: Query information about multiple Tokens
4100 operationId: getTokens
4101 responses:
4102 '200':
4103 description: OK
4104 content:
4105 application/json:
4106 schema:
4107 $ref: '#/components/schemas/ArrayOfTokenInfo'
4108 application/yaml:
4109 schema:
4110 $ref: '#/components/schemas/ArrayOfTokenInfo'
4111 '400':
4112 $ref: '#/components/responses/BadRequest'
4113 '401':
4114 $ref: '#/components/responses/Unauthorized'
4115 '403':
4116 $ref: '#/components/responses/Forbidden'
4117 '404':
4118 $ref: '#/components/responses/NotFound'
4119 '405':
4120 $ref: '#/components/responses/MethodNotAllowed'
4121 '406':
4122 $ref: '#/components/responses/NotAcceptable'
4123 '409':
4124 $ref: '#/components/responses/Conflict'
4125 '422':
4126 $ref: '#/components/responses/UnprocessableEntity'
4127 '500':
4128 $ref: '#/components/responses/InternalServerError'
4129 '503':
4130 $ref: '#/components/responses/ServiceUnavailable'
4131 '5XX':
4132 $ref: '#/components/responses/UnexpectedError'
4133 default:
4134 $ref: '#/components/responses/UnexpectedError'
4135 post:
4136 tags:
garciadeblas77849982020-02-28 15:41:43 +01004137 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004138 - "Admin"
4139 summary: Request a new Token
4140 description: Request a new Token
4141 operationId: createToken
4142 requestBody:
4143 $ref: '#/components/requestBodies/CreateTokenRequest'
4144 responses:
4145 '200':
4146 description: OK
4147 headers:
4148 Location:
4149 schema:
4150 type: string
4151 format: uri
4152 content:
4153 application/json:
4154 schema:
selvi.ja6f638b2022-03-23 12:27:35 +00004155 oneOf:
4156 - $ref: '#/components/schemas/TokenInfo'
4157 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02004158 application/yaml:
4159 schema:
selvi.ja6f638b2022-03-23 12:27:35 +00004160 oneOf:
4161 - $ref: '#/components/schemas/TokenInfo'
4162 - $ref: '#/components/schemas/PasswordExpiryInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02004163 '400':
4164 $ref: '#/components/responses/BadRequest'
4165 '401':
4166 $ref: '#/components/responses/Unauthorized'
4167 '403':
4168 $ref: '#/components/responses/Forbidden'
4169 '404':
4170 $ref: '#/components/responses/NotFound'
4171 '405':
4172 $ref: '#/components/responses/MethodNotAllowed'
4173 '406':
4174 $ref: '#/components/responses/NotAcceptable'
4175 '409':
4176 $ref: '#/components/responses/Conflict'
4177 '422':
4178 $ref: '#/components/responses/UnprocessableEntity'
4179 '500':
4180 $ref: '#/components/responses/InternalServerError'
4181 '503':
4182 $ref: '#/components/responses/ServiceUnavailable'
4183 '5XX':
4184 $ref: '#/components/responses/UnexpectedError'
4185 default:
4186 $ref: '#/components/responses/UnexpectedError'
4187 delete:
4188 tags:
garciadeblas77849982020-02-28 15:41:43 +01004189 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004190 - "Admin"
4191 summary: Delete the Token indicated in the Authorization Header
4192 description: Delete the Token indicated in the Authorization Header
4193 operationId: deleteAuthToken
4194 responses:
4195 '200':
4196 description: OK
4197 content:
4198 application/json:
4199 schema:
4200 type: string
4201 application/yaml:
4202 schema:
4203 type: string
4204 '400':
4205 $ref: '#/components/responses/BadRequest'
4206 '401':
4207 $ref: '#/components/responses/Unauthorized'
4208 '403':
4209 $ref: '#/components/responses/Forbidden'
4210 '404':
4211 $ref: '#/components/responses/NotFound'
4212 '405':
4213 $ref: '#/components/responses/MethodNotAllowed'
4214 '406':
4215 $ref: '#/components/responses/NotAcceptable'
4216 '409':
4217 $ref: '#/components/responses/Conflict'
4218 '422':
4219 $ref: '#/components/responses/UnprocessableEntity'
4220 '500':
4221 $ref: '#/components/responses/InternalServerError'
4222 '503':
4223 $ref: '#/components/responses/ServiceUnavailable'
4224 '5XX':
4225 $ref: '#/components/responses/UnexpectedError'
4226 default:
4227 $ref: '#/components/responses/UnexpectedError'
4228 '/admin/v1/tokens/{tokenId}':
4229 parameters:
4230 - name: tokenId
4231 in: path
4232 required: true
4233 description: Token ID
4234 schema:
4235 type: string
4236 get:
4237 tags:
garciadeblas77849982020-02-28 15:41:43 +01004238 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004239 - "Admin"
4240 summary: Query information about an individual Token
4241 description: Query information about an individual Token
4242 operationId: getToken
4243 responses:
4244 '200':
4245 description: OK
4246 content:
4247 application/json:
4248 schema:
4249 $ref: '#/components/schemas/TokenInfo'
4250 application/yaml:
4251 schema:
4252 $ref: '#/components/schemas/TokenInfo'
4253 '400':
4254 $ref: '#/components/responses/BadRequest'
4255 '401':
4256 $ref: '#/components/responses/Unauthorized'
4257 '403':
4258 $ref: '#/components/responses/Forbidden'
4259 '404':
4260 $ref: '#/components/responses/NotFound'
4261 '405':
4262 $ref: '#/components/responses/MethodNotAllowed'
4263 '406':
4264 $ref: '#/components/responses/NotAcceptable'
4265 '409':
4266 $ref: '#/components/responses/Conflict'
4267 '422':
4268 $ref: '#/components/responses/UnprocessableEntity'
4269 '500':
4270 $ref: '#/components/responses/InternalServerError'
4271 '503':
4272 $ref: '#/components/responses/ServiceUnavailable'
4273 '5XX':
4274 $ref: '#/components/responses/UnexpectedError'
4275 default:
4276 $ref: '#/components/responses/UnexpectedError'
4277 delete:
4278 tags:
garciadeblas77849982020-02-28 15:41:43 +01004279 - "Authentication"
delacruzramaf79f3c2019-10-22 13:13:01 +02004280 - "Admin"
4281 summary: Delete the Token indicated as parameter
4282 description: Delete the Token indicated as parameter
4283 operationId: deleteToken
4284 responses:
4285 '200':
4286 description: OK
4287 content:
4288 application/json:
4289 schema:
4290 type: string
4291 application/yaml:
4292 schema:
4293 type: string
4294 '400':
4295 $ref: '#/components/responses/BadRequest'
4296 '401':
4297 $ref: '#/components/responses/Unauthorized'
4298 '403':
4299 $ref: '#/components/responses/Forbidden'
4300 '404':
4301 $ref: '#/components/responses/NotFound'
4302 '405':
4303 $ref: '#/components/responses/MethodNotAllowed'
4304 '406':
4305 $ref: '#/components/responses/NotAcceptable'
4306 '409':
4307 $ref: '#/components/responses/Conflict'
4308 '422':
4309 $ref: '#/components/responses/UnprocessableEntity'
4310 '500':
4311 $ref: '#/components/responses/InternalServerError'
4312 '503':
4313 $ref: '#/components/responses/ServiceUnavailable'
4314 '5XX':
4315 $ref: '#/components/responses/UnexpectedError'
4316 default:
4317 $ref: '#/components/responses/UnexpectedError'
4318 '/admin/v1/users':
4319 get:
4320 tags:
garciadeblas77849982020-02-28 15:41:43 +01004321 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004322 - "Admin"
4323 summary: Query information about multiple Users
4324 description: Query information about multiple Users
4325 operationId: getUsers
4326 responses:
4327 '200':
4328 description: OK
4329 content:
4330 application/json:
4331 schema:
4332 $ref: '#/components/schemas/ArrayOfUserInfo'
4333 application/yaml:
4334 schema:
4335 $ref: '#/components/schemas/ArrayOfUserInfo'
4336 '400':
4337 $ref: '#/components/responses/BadRequest'
4338 '401':
4339 $ref: '#/components/responses/Unauthorized'
4340 '403':
4341 $ref: '#/components/responses/Forbidden'
4342 '404':
4343 $ref: '#/components/responses/NotFound'
4344 '405':
4345 $ref: '#/components/responses/MethodNotAllowed'
4346 '406':
4347 $ref: '#/components/responses/NotAcceptable'
4348 '409':
4349 $ref: '#/components/responses/Conflict'
4350 '422':
4351 $ref: '#/components/responses/UnprocessableEntity'
4352 '500':
4353 $ref: '#/components/responses/InternalServerError'
4354 '503':
4355 $ref: '#/components/responses/ServiceUnavailable'
4356 '5XX':
4357 $ref: '#/components/responses/UnexpectedError'
4358 default:
4359 $ref: '#/components/responses/UnexpectedError'
4360 post:
4361 tags:
garciadeblas77849982020-02-28 15:41:43 +01004362 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004363 - "Admin"
4364 summary: Create a new User
4365 description: Create a new User
4366 operationId: createUser
4367 requestBody:
4368 $ref: '#/components/requestBodies/CreateUserRequest'
4369 responses:
4370 '201':
4371 description: Created
4372 headers:
4373 Location:
4374 schema:
4375 type: string
4376 format: uri
4377 content:
4378 application/json:
4379 schema:
4380 $ref: '#/components/schemas/ObjectId'
4381 application/yaml:
4382 schema:
4383 $ref: '#/components/schemas/ObjectId'
4384 '400':
4385 $ref: '#/components/responses/BadRequest'
4386 '401':
4387 $ref: '#/components/responses/Unauthorized'
4388 '403':
4389 $ref: '#/components/responses/Forbidden'
4390 '404':
4391 $ref: '#/components/responses/NotFound'
4392 '405':
4393 $ref: '#/components/responses/MethodNotAllowed'
4394 '406':
4395 $ref: '#/components/responses/NotAcceptable'
4396 '409':
4397 $ref: '#/components/responses/Conflict'
4398 '422':
4399 $ref: '#/components/responses/UnprocessableEntity'
4400 '500':
4401 $ref: '#/components/responses/InternalServerError'
4402 '503':
4403 $ref: '#/components/responses/ServiceUnavailable'
4404 '5XX':
4405 $ref: '#/components/responses/UnexpectedError'
4406 default:
4407 $ref: '#/components/responses/UnexpectedError'
4408 '/admin/v1/users/{userId}':
4409 parameters:
4410 - name: userId
4411 in: path
4412 required: true
4413 description: User ID/Name
4414 schema:
4415 type: string
4416 get:
4417 tags:
garciadeblas77849982020-02-28 15:41:43 +01004418 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004419 - "Admin"
4420 summary: Query information about an individual User
4421 description: Query information about an individual User
4422 operationId: getUser
4423 responses:
4424 '200':
4425 description: OK
4426 content:
4427 application/json:
4428 schema:
4429 $ref: '#/components/schemas/UserInfo'
4430 application/yaml:
4431 schema:
4432 $ref: '#/components/schemas/UserInfo'
4433 '400':
4434 $ref: '#/components/responses/BadRequest'
4435 '401':
4436 $ref: '#/components/responses/Unauthorized'
4437 '403':
4438 $ref: '#/components/responses/Forbidden'
4439 '404':
4440 $ref: '#/components/responses/NotFound'
4441 '405':
4442 $ref: '#/components/responses/MethodNotAllowed'
4443 '406':
4444 $ref: '#/components/responses/NotAcceptable'
4445 '409':
4446 $ref: '#/components/responses/Conflict'
4447 '422':
4448 $ref: '#/components/responses/UnprocessableEntity'
4449 '500':
4450 $ref: '#/components/responses/InternalServerError'
4451 '503':
4452 $ref: '#/components/responses/ServiceUnavailable'
4453 '5XX':
4454 $ref: '#/components/responses/UnexpectedError'
4455 default:
4456 $ref: '#/components/responses/UnexpectedError'
4457 patch:
4458 tags:
garciadeblas77849982020-02-28 15:41:43 +01004459 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004460 - "Admin"
4461 summary: Modify a User
4462 description: Modify a User
4463 operationId: editUser
4464 requestBody:
4465 $ref: '#/components/requestBodies/EditUserRequest'
4466 responses:
4467 '204':
4468 description: No Content
4469 '400':
4470 $ref: '#/components/responses/BadRequest'
4471 '401':
4472 $ref: '#/components/responses/Unauthorized'
4473 '403':
4474 $ref: '#/components/responses/Forbidden'
4475 '404':
4476 $ref: '#/components/responses/NotFound'
4477 '405':
4478 $ref: '#/components/responses/MethodNotAllowed'
4479 '406':
4480 $ref: '#/components/responses/NotAcceptable'
4481 '409':
4482 $ref: '#/components/responses/Conflict'
4483 '422':
4484 $ref: '#/components/responses/UnprocessableEntity'
4485 '500':
4486 $ref: '#/components/responses/InternalServerError'
4487 '503':
4488 $ref: '#/components/responses/ServiceUnavailable'
4489 '5XX':
4490 $ref: '#/components/responses/UnexpectedError'
4491 default:
4492 $ref: '#/components/responses/UnexpectedError'
4493 delete:
4494 tags:
garciadeblas77849982020-02-28 15:41:43 +01004495 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004496 - "Admin"
4497 summary: Delete a User
4498 description: Delete a User
4499 operationId: deleteUser
4500 responses:
4501 '204':
4502 description: No Content
4503 '400':
4504 $ref: '#/components/responses/BadRequest'
4505 '401':
4506 $ref: '#/components/responses/Unauthorized'
4507 '403':
4508 $ref: '#/components/responses/Forbidden'
4509 '404':
4510 $ref: '#/components/responses/NotFound'
4511 '405':
4512 $ref: '#/components/responses/MethodNotAllowed'
4513 '406':
4514 $ref: '#/components/responses/NotAcceptable'
4515 '409':
4516 $ref: '#/components/responses/Conflict'
4517 '422':
4518 $ref: '#/components/responses/UnprocessableEntity'
4519 '500':
4520 $ref: '#/components/responses/InternalServerError'
4521 '503':
4522 $ref: '#/components/responses/ServiceUnavailable'
4523 '5XX':
4524 $ref: '#/components/responses/UnexpectedError'
4525 default:
4526 $ref: '#/components/responses/UnexpectedError'
4527 '/admin/v1/projects':
4528 get:
4529 tags:
garciadeblas77849982020-02-28 15:41:43 +01004530 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004531 - "Admin"
4532 summary: Query information about multiple Projects
4533 description: Query information about multiple Projects
4534 operationId: getProjects
4535 responses:
4536 '200':
4537 description: OK
4538 content:
4539 application/json:
4540 schema:
4541 $ref: '#/components/schemas/ArrayOfProjectInfo'
4542 application/yaml:
4543 schema:
4544 $ref: '#/components/schemas/ArrayOfProjectInfo'
4545 '400':
4546 $ref: '#/components/responses/BadRequest'
4547 '401':
4548 $ref: '#/components/responses/Unauthorized'
4549 '403':
4550 $ref: '#/components/responses/Forbidden'
4551 '404':
4552 $ref: '#/components/responses/NotFound'
4553 '405':
4554 $ref: '#/components/responses/MethodNotAllowed'
4555 '406':
4556 $ref: '#/components/responses/NotAcceptable'
4557 '409':
4558 $ref: '#/components/responses/Conflict'
4559 '422':
4560 $ref: '#/components/responses/UnprocessableEntity'
4561 '500':
4562 $ref: '#/components/responses/InternalServerError'
4563 '503':
4564 $ref: '#/components/responses/ServiceUnavailable'
4565 '5XX':
4566 $ref: '#/components/responses/UnexpectedError'
4567 default:
4568 $ref: '#/components/responses/UnexpectedError'
4569 post:
4570 tags:
garciadeblas77849982020-02-28 15:41:43 +01004571 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004572 - "Admin"
4573 summary: Create a new Project
4574 description: Create a new Project
4575 operationId: createProject
4576 requestBody:
4577 $ref: '#/components/requestBodies/CreateProjectRequest'
4578 responses:
4579 '201':
4580 description: Created
4581 headers:
4582 Location:
4583 schema:
4584 type: string
4585 format: uri
4586 content:
4587 application/json:
4588 schema:
4589 $ref: '#/components/schemas/ObjectId'
4590 application/yaml:
4591 schema:
4592 $ref: '#/components/schemas/ObjectId'
4593 '400':
4594 $ref: '#/components/responses/BadRequest'
4595 '401':
4596 $ref: '#/components/responses/Unauthorized'
4597 '403':
4598 $ref: '#/components/responses/Forbidden'
4599 '404':
4600 $ref: '#/components/responses/NotFound'
4601 '405':
4602 $ref: '#/components/responses/MethodNotAllowed'
4603 '406':
4604 $ref: '#/components/responses/NotAcceptable'
4605 '409':
4606 $ref: '#/components/responses/Conflict'
4607 '422':
4608 $ref: '#/components/responses/UnprocessableEntity'
4609 '500':
4610 $ref: '#/components/responses/InternalServerError'
4611 '503':
4612 $ref: '#/components/responses/ServiceUnavailable'
4613 '5XX':
4614 $ref: '#/components/responses/UnexpectedError'
4615 default:
4616 $ref: '#/components/responses/UnexpectedError'
4617 '/admin/v1/projects/{projectId}':
4618 parameters:
4619 - name: projectId
4620 in: path
4621 required: true
4622 description: Project ID/Name
4623 schema:
4624 type: string
4625 get:
4626 tags:
garciadeblas77849982020-02-28 15:41:43 +01004627 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004628 - "Admin"
4629 summary: Query information about an individual Project
4630 description: Query information about an individual Project
4631 operationId: getProject
4632 responses:
4633 '200':
4634 description: OK
4635 content:
4636 application/json:
4637 schema:
4638 $ref: '#/components/schemas/ProjectInfo'
4639 application/yaml:
4640 schema:
4641 $ref: '#/components/schemas/ProjectInfo'
4642 '400':
4643 $ref: '#/components/responses/BadRequest'
4644 '401':
4645 $ref: '#/components/responses/Unauthorized'
4646 '403':
4647 $ref: '#/components/responses/Forbidden'
4648 '404':
4649 $ref: '#/components/responses/NotFound'
4650 '405':
4651 $ref: '#/components/responses/MethodNotAllowed'
4652 '406':
4653 $ref: '#/components/responses/NotAcceptable'
4654 '409':
4655 $ref: '#/components/responses/Conflict'
4656 '422':
4657 $ref: '#/components/responses/UnprocessableEntity'
4658 '500':
4659 $ref: '#/components/responses/InternalServerError'
4660 '503':
4661 $ref: '#/components/responses/ServiceUnavailable'
4662 '5XX':
4663 $ref: '#/components/responses/UnexpectedError'
4664 default:
4665 $ref: '#/components/responses/UnexpectedError'
4666 patch:
4667 tags:
garciadeblas77849982020-02-28 15:41:43 +01004668 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004669 - "Admin"
4670 summary: Modify a Project
4671 description: Modify a Project
4672 operationId: editProject
4673 requestBody:
4674 $ref: '#/components/requestBodies/EditProjectRequest'
4675 responses:
4676 '204':
4677 description: No Content
4678 '400':
4679 $ref: '#/components/responses/BadRequest'
4680 '401':
4681 $ref: '#/components/responses/Unauthorized'
4682 '403':
4683 $ref: '#/components/responses/Forbidden'
4684 '404':
4685 $ref: '#/components/responses/NotFound'
4686 '405':
4687 $ref: '#/components/responses/MethodNotAllowed'
4688 '406':
4689 $ref: '#/components/responses/NotAcceptable'
4690 '409':
4691 $ref: '#/components/responses/Conflict'
4692 '422':
4693 $ref: '#/components/responses/UnprocessableEntity'
4694 '500':
4695 $ref: '#/components/responses/InternalServerError'
4696 '503':
4697 $ref: '#/components/responses/ServiceUnavailable'
4698 '5XX':
4699 $ref: '#/components/responses/UnexpectedError'
4700 default:
4701 $ref: '#/components/responses/UnexpectedError'
4702 delete:
4703 tags:
garciadeblas77849982020-02-28 15:41:43 +01004704 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004705 - "Admin"
4706 summary: Delete a Project
4707 description: Delete a Project
4708 operationId: deleteProject
4709 responses:
4710 '204':
4711 description: No Content
4712 '400':
4713 $ref: '#/components/responses/BadRequest'
4714 '401':
4715 $ref: '#/components/responses/Unauthorized'
4716 '403':
4717 $ref: '#/components/responses/Forbidden'
4718 '404':
4719 $ref: '#/components/responses/NotFound'
4720 '405':
4721 $ref: '#/components/responses/MethodNotAllowed'
4722 '406':
4723 $ref: '#/components/responses/NotAcceptable'
4724 '409':
4725 $ref: '#/components/responses/Conflict'
4726 '422':
4727 $ref: '#/components/responses/UnprocessableEntity'
4728 '500':
4729 $ref: '#/components/responses/InternalServerError'
4730 '503':
4731 $ref: '#/components/responses/ServiceUnavailable'
4732 '5XX':
4733 $ref: '#/components/responses/UnexpectedError'
4734 default:
4735 $ref: '#/components/responses/UnexpectedError'
4736 '/admin/v1/roles':
4737 get:
4738 tags:
garciadeblas77849982020-02-28 15:41:43 +01004739 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004740 - "Admin"
4741 summary: Query information about multiple Roles
4742 description: Query information about multiple Roles
4743 operationId: getRoles
4744 responses:
4745 '200':
4746 description: OK
4747 content:
4748 application/json:
4749 schema:
4750 $ref: '#/components/schemas/ArrayOfRoleInfo'
4751 application/yaml:
4752 schema:
4753 $ref: '#/components/schemas/ArrayOfRoleInfo'
4754 '400':
4755 $ref: '#/components/responses/BadRequest'
4756 '401':
4757 $ref: '#/components/responses/Unauthorized'
4758 '403':
4759 $ref: '#/components/responses/Forbidden'
4760 '404':
4761 $ref: '#/components/responses/NotFound'
4762 '405':
4763 $ref: '#/components/responses/MethodNotAllowed'
4764 '406':
4765 $ref: '#/components/responses/NotAcceptable'
4766 '409':
4767 $ref: '#/components/responses/Conflict'
4768 '422':
4769 $ref: '#/components/responses/UnprocessableEntity'
4770 '500':
4771 $ref: '#/components/responses/InternalServerError'
4772 '503':
4773 $ref: '#/components/responses/ServiceUnavailable'
4774 '5XX':
4775 $ref: '#/components/responses/UnexpectedError'
4776 default:
4777 $ref: '#/components/responses/UnexpectedError'
4778 post:
4779 tags:
garciadeblas77849982020-02-28 15:41:43 +01004780 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004781 - "Admin"
4782 summary: Create a new Role
4783 description: Create a new Role
4784 operationId: createRole
4785 requestBody:
4786 $ref: '#/components/requestBodies/CreateRoleRequest'
4787 responses:
4788 '201':
4789 description: Created
4790 headers:
4791 Location:
4792 schema:
4793 type: string
4794 format: uri
4795 content:
4796 application/json:
4797 schema:
4798 $ref: '#/components/schemas/ObjectId'
4799 application/yaml:
4800 schema:
4801 $ref: '#/components/schemas/ObjectId'
4802 '400':
4803 $ref: '#/components/responses/BadRequest'
4804 '401':
4805 $ref: '#/components/responses/Unauthorized'
4806 '403':
4807 $ref: '#/components/responses/Forbidden'
4808 '404':
4809 $ref: '#/components/responses/NotFound'
4810 '405':
4811 $ref: '#/components/responses/MethodNotAllowed'
4812 '406':
4813 $ref: '#/components/responses/NotAcceptable'
4814 '409':
4815 $ref: '#/components/responses/Conflict'
4816 '422':
4817 $ref: '#/components/responses/UnprocessableEntity'
4818 '500':
4819 $ref: '#/components/responses/InternalServerError'
4820 '503':
4821 $ref: '#/components/responses/ServiceUnavailable'
4822 '5XX':
4823 $ref: '#/components/responses/UnexpectedError'
4824 default:
4825 $ref: '#/components/responses/UnexpectedError'
4826 '/admin/v1/roles/{roleId}':
4827 parameters:
4828 - name: roleId
4829 in: path
4830 required: true
4831 description: Role ID/Name
4832 schema:
4833 type: string
4834 get:
4835 tags:
garciadeblas77849982020-02-28 15:41:43 +01004836 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004837 - "Admin"
4838 summary: Query information about an individual Role
4839 description: Query information about an individual Role
4840 operationId: getRole
4841 responses:
4842 '200':
4843 description: OK
4844 content:
4845 application/json:
4846 schema:
4847 $ref: '#/components/schemas/RoleInfo'
4848 application/yaml:
4849 schema:
4850 $ref: '#/components/schemas/RoleInfo'
4851 '400':
4852 $ref: '#/components/responses/BadRequest'
4853 '401':
4854 $ref: '#/components/responses/Unauthorized'
4855 '403':
4856 $ref: '#/components/responses/Forbidden'
4857 '404':
4858 $ref: '#/components/responses/NotFound'
4859 '405':
4860 $ref: '#/components/responses/MethodNotAllowed'
4861 '406':
4862 $ref: '#/components/responses/NotAcceptable'
4863 '409':
4864 $ref: '#/components/responses/Conflict'
4865 '422':
4866 $ref: '#/components/responses/UnprocessableEntity'
4867 '500':
4868 $ref: '#/components/responses/InternalServerError'
4869 '503':
4870 $ref: '#/components/responses/ServiceUnavailable'
4871 '5XX':
4872 $ref: '#/components/responses/UnexpectedError'
4873 default:
4874 $ref: '#/components/responses/UnexpectedError'
4875 patch:
4876 tags:
garciadeblas77849982020-02-28 15:41:43 +01004877 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004878 - "Admin"
4879 summary: Modify a Role
4880 description: Modify a Role
4881 operationId: editRole
4882 requestBody:
4883 $ref: '#/components/requestBodies/EditRoleRequest'
4884 responses:
4885 '204':
4886 description: No Content
4887 '400':
4888 $ref: '#/components/responses/BadRequest'
4889 '401':
4890 $ref: '#/components/responses/Unauthorized'
4891 '403':
4892 $ref: '#/components/responses/Forbidden'
4893 '404':
4894 $ref: '#/components/responses/NotFound'
4895 '405':
4896 $ref: '#/components/responses/MethodNotAllowed'
4897 '406':
4898 $ref: '#/components/responses/NotAcceptable'
4899 '409':
4900 $ref: '#/components/responses/Conflict'
4901 '422':
4902 $ref: '#/components/responses/UnprocessableEntity'
4903 '500':
4904 $ref: '#/components/responses/InternalServerError'
4905 '503':
4906 $ref: '#/components/responses/ServiceUnavailable'
4907 '5XX':
4908 $ref: '#/components/responses/UnexpectedError'
4909 default:
4910 $ref: '#/components/responses/UnexpectedError'
4911 delete:
4912 tags:
garciadeblas77849982020-02-28 15:41:43 +01004913 - "Identity"
delacruzramaf79f3c2019-10-22 13:13:01 +02004914 - "Admin"
4915 summary: Delete a Role
4916 description: Delete a Role
4917 operationId: deleteRole
4918 responses:
4919 '204':
4920 description: No Content
4921 '400':
4922 $ref: '#/components/responses/BadRequest'
4923 '401':
4924 $ref: '#/components/responses/Unauthorized'
4925 '403':
4926 $ref: '#/components/responses/Forbidden'
4927 '404':
4928 $ref: '#/components/responses/NotFound'
4929 '405':
4930 $ref: '#/components/responses/MethodNotAllowed'
4931 '406':
4932 $ref: '#/components/responses/NotAcceptable'
4933 '409':
4934 $ref: '#/components/responses/Conflict'
4935 '422':
4936 $ref: '#/components/responses/UnprocessableEntity'
4937 '500':
4938 $ref: '#/components/responses/InternalServerError'
4939 '503':
4940 $ref: '#/components/responses/ServiceUnavailable'
4941 '5XX':
4942 $ref: '#/components/responses/UnexpectedError'
4943 default:
4944 $ref: '#/components/responses/UnexpectedError'
4945 '/admin/v1/vims':
4946 get:
4947 tags:
garciadeblas77849982020-02-28 15:41:43 +01004948 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02004949 - "Admin"
4950 summary: Query information about multiple VIMs
4951 description: Query information about multiple VIMs
4952 operationId: getVIMs
4953 responses:
4954 '200':
4955 description: OK
4956 content:
4957 application/json:
4958 schema:
4959 $ref: '#/components/schemas/ArrayOfVimInfo'
4960 application/yaml:
4961 schema:
4962 $ref: '#/components/schemas/ArrayOfVimInfo'
4963 '400':
4964 $ref: '#/components/responses/BadRequest'
4965 '401':
4966 $ref: '#/components/responses/Unauthorized'
4967 '403':
4968 $ref: '#/components/responses/Forbidden'
4969 '404':
4970 $ref: '#/components/responses/NotFound'
4971 '405':
4972 $ref: '#/components/responses/MethodNotAllowed'
4973 '406':
4974 $ref: '#/components/responses/NotAcceptable'
4975 '409':
4976 $ref: '#/components/responses/Conflict'
4977 '422':
4978 $ref: '#/components/responses/UnprocessableEntity'
4979 '500':
4980 $ref: '#/components/responses/InternalServerError'
4981 '503':
4982 $ref: '#/components/responses/ServiceUnavailable'
4983 '5XX':
4984 $ref: '#/components/responses/UnexpectedError'
4985 default:
4986 $ref: '#/components/responses/UnexpectedError'
4987 post:
4988 tags:
garciadeblas77849982020-02-28 15:41:43 +01004989 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02004990 - "Admin"
4991 summary: Create a new VIM
4992 description: Create a new VIM
4993 operationId: createVIM
4994 requestBody:
4995 $ref: '#/components/requestBodies/CreateVimRequest'
4996 responses:
4997 '202':
4998 description: Accepted
4999 content:
5000 application/json:
5001 schema:
5002 $ref: '#/components/schemas/ObjectId_plus_OpId'
5003 application/yaml:
5004 schema:
5005 $ref: '#/components/schemas/ObjectId_plus_OpId'
5006 '400':
5007 $ref: '#/components/responses/BadRequest'
5008 '401':
5009 $ref: '#/components/responses/Unauthorized'
5010 '403':
5011 $ref: '#/components/responses/Forbidden'
5012 '404':
5013 $ref: '#/components/responses/NotFound'
5014 '405':
5015 $ref: '#/components/responses/MethodNotAllowed'
5016 '406':
5017 $ref: '#/components/responses/NotAcceptable'
5018 '409':
5019 $ref: '#/components/responses/Conflict'
5020 '422':
5021 $ref: '#/components/responses/UnprocessableEntity'
5022 '500':
5023 $ref: '#/components/responses/InternalServerError'
5024 '503':
5025 $ref: '#/components/responses/ServiceUnavailable'
5026 '5XX':
5027 $ref: '#/components/responses/UnexpectedError'
5028 default:
5029 $ref: '#/components/responses/UnexpectedError'
5030 '/admin/v1/vims/{vimId}':
5031 parameters:
5032 - name: vimId
5033 in: path
5034 required: true
5035 description: VIM ID
5036 schema:
5037 type: string
5038 format: uuid
5039 get:
5040 tags:
garciadeblas77849982020-02-28 15:41:43 +01005041 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005042 - "Admin"
5043 summary: Query information about an individual VIM
5044 description: Query information about an individual VIM
5045 operationId: getVIM
5046 responses:
5047 '200':
5048 description: OK
5049 content:
5050 application/json:
5051 schema:
5052 $ref: '#/components/schemas/VimInfo'
5053 application/yaml:
5054 schema:
5055 $ref: '#/components/schemas/VimInfo'
5056 '400':
5057 $ref: '#/components/responses/BadRequest'
5058 '401':
5059 $ref: '#/components/responses/Unauthorized'
5060 '403':
5061 $ref: '#/components/responses/Forbidden'
5062 '404':
5063 $ref: '#/components/responses/NotFound'
5064 '405':
5065 $ref: '#/components/responses/MethodNotAllowed'
5066 '406':
5067 $ref: '#/components/responses/NotAcceptable'
5068 '409':
5069 $ref: '#/components/responses/Conflict'
5070 '422':
5071 $ref: '#/components/responses/UnprocessableEntity'
5072 '500':
5073 $ref: '#/components/responses/InternalServerError'
5074 '503':
5075 $ref: '#/components/responses/ServiceUnavailable'
5076 '5XX':
5077 $ref: '#/components/responses/UnexpectedError'
5078 default:
5079 $ref: '#/components/responses/UnexpectedError'
5080 patch:
5081 tags:
garciadeblas77849982020-02-28 15:41:43 +01005082 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005083 - "Admin"
5084 summary: Modify a VIM
5085 description: Modify a VIM
5086 operationId: editVIM
5087 requestBody:
5088 $ref: '#/components/requestBodies/EditVimRequest'
5089 responses:
5090 '202':
5091 description: Accepted
5092 content:
5093 application/json:
5094 schema:
5095 $ref: '#/components/schemas/OpId'
5096 application/yaml:
5097 schema:
5098 $ref: '#/components/schemas/OpId'
5099 '400':
5100 $ref: '#/components/responses/BadRequest'
5101 '401':
5102 $ref: '#/components/responses/Unauthorized'
5103 '403':
5104 $ref: '#/components/responses/Forbidden'
5105 '404':
5106 $ref: '#/components/responses/NotFound'
5107 '405':
5108 $ref: '#/components/responses/MethodNotAllowed'
5109 '406':
5110 $ref: '#/components/responses/NotAcceptable'
5111 '409':
5112 $ref: '#/components/responses/Conflict'
5113 '422':
5114 $ref: '#/components/responses/UnprocessableEntity'
5115 '500':
5116 $ref: '#/components/responses/InternalServerError'
5117 '503':
5118 $ref: '#/components/responses/ServiceUnavailable'
5119 '5XX':
5120 $ref: '#/components/responses/UnexpectedError'
5121 default:
5122 $ref: '#/components/responses/UnexpectedError'
5123 delete:
5124 tags:
garciadeblas77849982020-02-28 15:41:43 +01005125 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005126 - "Admin"
5127 summary: Delete a VIM
5128 description: Delete a VIM
5129 operationId: deleteVIM
5130 responses:
5131 '202':
5132 description: Accepted
5133 '400':
5134 $ref: '#/components/responses/BadRequest'
5135 '401':
5136 $ref: '#/components/responses/Unauthorized'
5137 '403':
5138 $ref: '#/components/responses/Forbidden'
5139 '404':
5140 $ref: '#/components/responses/NotFound'
5141 '405':
5142 $ref: '#/components/responses/MethodNotAllowed'
5143 '406':
5144 $ref: '#/components/responses/NotAcceptable'
5145 '409':
5146 $ref: '#/components/responses/Conflict'
5147 '422':
5148 $ref: '#/components/responses/UnprocessableEntity'
5149 '500':
5150 $ref: '#/components/responses/InternalServerError'
5151 '503':
5152 $ref: '#/components/responses/ServiceUnavailable'
5153 '5XX':
5154 $ref: '#/components/responses/UnexpectedError'
5155 default:
5156 $ref: '#/components/responses/UnexpectedError'
5157 '/admin/v1/vim_accounts':
5158 get:
5159 tags:
garciadeblas77849982020-02-28 15:41:43 +01005160 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005161 - "Admin"
5162 summary: Query information about multiple VIM Accounts
5163 description: Query information about multiple VIM Accounts
5164 operationId: getVimAccounts
5165 responses:
5166 '200':
5167 description: OK
5168 content:
5169 application/json:
5170 schema:
5171 $ref: '#/components/schemas/ArrayOfVimInfo'
5172 application/yaml:
5173 schema:
5174 $ref: '#/components/schemas/ArrayOfVimInfo'
5175 '400':
5176 $ref: '#/components/responses/BadRequest'
5177 '401':
5178 $ref: '#/components/responses/Unauthorized'
5179 '403':
5180 $ref: '#/components/responses/Forbidden'
5181 '404':
5182 $ref: '#/components/responses/NotFound'
5183 '405':
5184 $ref: '#/components/responses/MethodNotAllowed'
5185 '406':
5186 $ref: '#/components/responses/NotAcceptable'
5187 '409':
5188 $ref: '#/components/responses/Conflict'
5189 '422':
5190 $ref: '#/components/responses/UnprocessableEntity'
5191 '500':
5192 $ref: '#/components/responses/InternalServerError'
5193 '503':
5194 $ref: '#/components/responses/ServiceUnavailable'
5195 '5XX':
5196 $ref: '#/components/responses/UnexpectedError'
5197 default:
5198 $ref: '#/components/responses/UnexpectedError'
5199 post:
5200 tags:
garciadeblas77849982020-02-28 15:41:43 +01005201 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005202 - "Admin"
5203 summary: Create a new VIM Account
5204 description: Create a new VIM Account
5205 operationId: createVimAccount
5206 requestBody:
5207 $ref: '#/components/requestBodies/CreateVimRequest'
5208 responses:
5209 '202':
5210 description: Accepted
5211 content:
5212 application/json:
5213 schema:
5214 $ref: '#/components/schemas/ObjectId_plus_OpId'
5215 application/yaml:
5216 schema:
5217 $ref: '#/components/schemas/ObjectId_plus_OpId'
5218 '400':
5219 $ref: '#/components/responses/BadRequest'
5220 '401':
5221 $ref: '#/components/responses/Unauthorized'
5222 '403':
5223 $ref: '#/components/responses/Forbidden'
5224 '404':
5225 $ref: '#/components/responses/NotFound'
5226 '405':
5227 $ref: '#/components/responses/MethodNotAllowed'
5228 '406':
5229 $ref: '#/components/responses/NotAcceptable'
5230 '409':
5231 $ref: '#/components/responses/Conflict'
5232 '422':
5233 $ref: '#/components/responses/UnprocessableEntity'
5234 '500':
5235 $ref: '#/components/responses/InternalServerError'
5236 '503':
5237 $ref: '#/components/responses/ServiceUnavailable'
5238 '5XX':
5239 $ref: '#/components/responses/UnexpectedError'
5240 default:
5241 $ref: '#/components/responses/UnexpectedError'
5242 '/admin/v1/vim_accounts/{vimAccountId}':
5243 parameters:
5244 - name: vimAccountId
5245 in: path
5246 required: true
5247 description: VIM Account ID
5248 schema:
5249 type: string
5250 format: uuid
5251 get:
5252 tags:
garciadeblas77849982020-02-28 15:41:43 +01005253 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005254 - "Admin"
5255 summary: Query information about an individual VIM Account
5256 description: Query information about an individual VIM Account
5257 operationId: getVimAccount
5258 responses:
5259 '200':
5260 description: OK
5261 content:
5262 application/json:
5263 schema:
5264 $ref: '#/components/schemas/VimInfo'
5265 application/yaml:
5266 schema:
5267 $ref: '#/components/schemas/VimInfo'
5268 '400':
5269 $ref: '#/components/responses/BadRequest'
5270 '401':
5271 $ref: '#/components/responses/Unauthorized'
5272 '403':
5273 $ref: '#/components/responses/Forbidden'
5274 '404':
5275 $ref: '#/components/responses/NotFound'
5276 '405':
5277 $ref: '#/components/responses/MethodNotAllowed'
5278 '406':
5279 $ref: '#/components/responses/NotAcceptable'
5280 '409':
5281 $ref: '#/components/responses/Conflict'
5282 '422':
5283 $ref: '#/components/responses/UnprocessableEntity'
5284 '500':
5285 $ref: '#/components/responses/InternalServerError'
5286 '503':
5287 $ref: '#/components/responses/ServiceUnavailable'
5288 '5XX':
5289 $ref: '#/components/responses/UnexpectedError'
5290 default:
5291 $ref: '#/components/responses/UnexpectedError'
5292 patch:
5293 tags:
garciadeblas77849982020-02-28 15:41:43 +01005294 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005295 - "Admin"
5296 summary: Modify a VIM Account
5297 description: Modify a VIM Account
5298 operationId: editVimAccount
5299 requestBody:
5300 $ref: '#/components/requestBodies/EditVimRequest'
5301 responses:
5302 '202':
5303 description: Accepted
5304 content:
5305 application/json:
5306 schema:
5307 $ref: '#/components/schemas/OpId'
5308 application/yaml:
5309 schema:
5310 $ref: '#/components/schemas/OpId'
5311 '400':
5312 $ref: '#/components/responses/BadRequest'
5313 '401':
5314 $ref: '#/components/responses/Unauthorized'
5315 '403':
5316 $ref: '#/components/responses/Forbidden'
5317 '404':
5318 $ref: '#/components/responses/NotFound'
5319 '405':
5320 $ref: '#/components/responses/MethodNotAllowed'
5321 '406':
5322 $ref: '#/components/responses/NotAcceptable'
5323 '409':
5324 $ref: '#/components/responses/Conflict'
5325 '422':
5326 $ref: '#/components/responses/UnprocessableEntity'
5327 '500':
5328 $ref: '#/components/responses/InternalServerError'
5329 '503':
5330 $ref: '#/components/responses/ServiceUnavailable'
5331 '5XX':
5332 $ref: '#/components/responses/UnexpectedError'
5333 default:
5334 $ref: '#/components/responses/UnexpectedError'
5335 delete:
5336 tags:
garciadeblas77849982020-02-28 15:41:43 +01005337 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005338 - "Admin"
5339 summary: Delete a VIM Account
5340 description: Delete a VIM Account
5341 operationId: deleteVimAccount
5342 responses:
5343 '202':
5344 description: Accepted
5345 '400':
5346 $ref: '#/components/responses/BadRequest'
5347 '401':
5348 $ref: '#/components/responses/Unauthorized'
5349 '403':
5350 $ref: '#/components/responses/Forbidden'
5351 '404':
5352 $ref: '#/components/responses/NotFound'
5353 '405':
5354 $ref: '#/components/responses/MethodNotAllowed'
5355 '406':
5356 $ref: '#/components/responses/NotAcceptable'
5357 '409':
5358 $ref: '#/components/responses/Conflict'
5359 '422':
5360 $ref: '#/components/responses/UnprocessableEntity'
5361 '500':
5362 $ref: '#/components/responses/InternalServerError'
5363 '503':
5364 $ref: '#/components/responses/ServiceUnavailable'
5365 '5XX':
5366 $ref: '#/components/responses/UnexpectedError'
5367 default:
5368 $ref: '#/components/responses/UnexpectedError'
5369 '/admin/v1/wim_accounts':
5370 get:
5371 tags:
garciadeblas77849982020-02-28 15:41:43 +01005372 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005373 - "Admin"
5374 summary: Query information about multiple WIM Accounts
5375 description: Query information about multiple WIM Accounts
5376 operationId: getWimAccounts
5377 responses:
5378 '200':
5379 description: OK
5380 content:
5381 application/json:
5382 schema:
5383 $ref: '#/components/schemas/ArrayOfWimInfo'
5384 application/yaml:
5385 schema:
5386 $ref: '#/components/schemas/ArrayOfWimInfo'
5387 '400':
5388 $ref: '#/components/responses/BadRequest'
5389 '401':
5390 $ref: '#/components/responses/Unauthorized'
5391 '403':
5392 $ref: '#/components/responses/Forbidden'
5393 '404':
5394 $ref: '#/components/responses/NotFound'
5395 '405':
5396 $ref: '#/components/responses/MethodNotAllowed'
5397 '406':
5398 $ref: '#/components/responses/NotAcceptable'
5399 '409':
5400 $ref: '#/components/responses/Conflict'
5401 '422':
5402 $ref: '#/components/responses/UnprocessableEntity'
5403 '500':
5404 $ref: '#/components/responses/InternalServerError'
5405 '503':
5406 $ref: '#/components/responses/ServiceUnavailable'
5407 '5XX':
5408 $ref: '#/components/responses/UnexpectedError'
5409 default:
5410 $ref: '#/components/responses/UnexpectedError'
5411 post:
5412 tags:
garciadeblas77849982020-02-28 15:41:43 +01005413 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005414 - "Admin"
5415 summary: Create a new WIM Account
5416 description: Create a new WIM Account
5417 operationId: createWimAccount
5418 requestBody:
5419 $ref: '#/components/requestBodies/CreateWimRequest'
5420 responses:
5421 '202':
5422 description: Accepted
5423 content:
5424 application/json:
5425 schema:
5426 $ref: '#/components/schemas/ObjectId_plus_OpId'
5427 application/yaml:
5428 schema:
5429 $ref: '#/components/schemas/ObjectId_plus_OpId'
5430 '400':
5431 $ref: '#/components/responses/BadRequest'
5432 '401':
5433 $ref: '#/components/responses/Unauthorized'
5434 '403':
5435 $ref: '#/components/responses/Forbidden'
5436 '404':
5437 $ref: '#/components/responses/NotFound'
5438 '405':
5439 $ref: '#/components/responses/MethodNotAllowed'
5440 '406':
5441 $ref: '#/components/responses/NotAcceptable'
5442 '409':
5443 $ref: '#/components/responses/Conflict'
5444 '422':
5445 $ref: '#/components/responses/UnprocessableEntity'
5446 '500':
5447 $ref: '#/components/responses/InternalServerError'
5448 '503':
5449 $ref: '#/components/responses/ServiceUnavailable'
5450 '5XX':
5451 $ref: '#/components/responses/UnexpectedError'
5452 default:
5453 $ref: '#/components/responses/UnexpectedError'
5454 '/admin/v1/wim_accounts/{wimAccountId}':
5455 parameters:
5456 - name: wimAccountId
5457 in: path
5458 required: true
5459 description: WIM Account ID
5460 schema:
5461 type: string
5462 format: uuid
5463 get:
5464 tags:
garciadeblas77849982020-02-28 15:41:43 +01005465 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005466 - "Admin"
5467 summary: Query information about an individual WIM Account
5468 description: Query information about an individual WIM Account
5469 operationId: getWimAccount
5470 responses:
5471 '200':
5472 description: OK
5473 content:
5474 application/json:
5475 schema:
5476 $ref: '#/components/schemas/WimInfo'
5477 application/yaml:
5478 schema:
5479 $ref: '#/components/schemas/WimInfo'
5480 '400':
5481 $ref: '#/components/responses/BadRequest'
5482 '401':
5483 $ref: '#/components/responses/Unauthorized'
5484 '403':
5485 $ref: '#/components/responses/Forbidden'
5486 '404':
5487 $ref: '#/components/responses/NotFound'
5488 '405':
5489 $ref: '#/components/responses/MethodNotAllowed'
5490 '406':
5491 $ref: '#/components/responses/NotAcceptable'
5492 '409':
5493 $ref: '#/components/responses/Conflict'
5494 '422':
5495 $ref: '#/components/responses/UnprocessableEntity'
5496 '500':
5497 $ref: '#/components/responses/InternalServerError'
5498 '503':
5499 $ref: '#/components/responses/ServiceUnavailable'
5500 '5XX':
5501 $ref: '#/components/responses/UnexpectedError'
5502 default:
5503 $ref: '#/components/responses/UnexpectedError'
5504 patch:
5505 tags:
garciadeblas77849982020-02-28 15:41:43 +01005506 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005507 - "Admin"
5508 summary: Modify a WIM Account
5509 description: Modify a WIM Account
5510 operationId: editWimAccount
5511 requestBody:
5512 $ref: '#/components/requestBodies/EditWimRequest'
5513 responses:
5514 '202':
5515 description: Accepted
5516 content:
5517 application/json:
5518 schema:
5519 $ref: '#/components/schemas/OpId'
5520 application/yaml:
5521 schema:
5522 $ref: '#/components/schemas/OpId'
5523 '400':
5524 $ref: '#/components/responses/BadRequest'
5525 '401':
5526 $ref: '#/components/responses/Unauthorized'
5527 '403':
5528 $ref: '#/components/responses/Forbidden'
5529 '404':
5530 $ref: '#/components/responses/NotFound'
5531 '405':
5532 $ref: '#/components/responses/MethodNotAllowed'
5533 '406':
5534 $ref: '#/components/responses/NotAcceptable'
5535 '409':
5536 $ref: '#/components/responses/Conflict'
5537 '422':
5538 $ref: '#/components/responses/UnprocessableEntity'
5539 '500':
5540 $ref: '#/components/responses/InternalServerError'
5541 '503':
5542 $ref: '#/components/responses/ServiceUnavailable'
5543 '5XX':
5544 $ref: '#/components/responses/UnexpectedError'
5545 default:
5546 $ref: '#/components/responses/UnexpectedError'
5547 delete:
5548 tags:
garciadeblas77849982020-02-28 15:41:43 +01005549 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005550 - "Admin"
5551 summary: Delete a WIM Account
5552 description: Delete a WIM Account
5553 operationId: deleteWimAccount
5554 responses:
5555 '202':
5556 description: Accepted
5557 '400':
5558 $ref: '#/components/responses/BadRequest'
5559 '401':
5560 $ref: '#/components/responses/Unauthorized'
5561 '403':
5562 $ref: '#/components/responses/Forbidden'
5563 '404':
5564 $ref: '#/components/responses/NotFound'
5565 '405':
5566 $ref: '#/components/responses/MethodNotAllowed'
5567 '406':
5568 $ref: '#/components/responses/NotAcceptable'
5569 '409':
5570 $ref: '#/components/responses/Conflict'
5571 '422':
5572 $ref: '#/components/responses/UnprocessableEntity'
5573 '500':
5574 $ref: '#/components/responses/InternalServerError'
5575 '503':
5576 $ref: '#/components/responses/ServiceUnavailable'
5577 '5XX':
5578 $ref: '#/components/responses/UnexpectedError'
5579 default:
5580 $ref: '#/components/responses/UnexpectedError'
5581 '/admin/v1/sdns':
5582 get:
5583 tags:
garciadeblas77849982020-02-28 15:41:43 +01005584 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005585 - "Admin"
5586 summary: Query information about multiple SDNs
5587 description: Query information about multiple SDNs
5588 operationId: getSDNs
5589 responses:
5590 '200':
5591 description: OK
5592 content:
5593 application/json:
5594 schema:
5595 $ref: '#/components/schemas/ArrayOfSdnInfo'
5596 application/yaml:
5597 schema:
5598 $ref: '#/components/schemas/ArrayOfSdnInfo'
5599 '400':
5600 $ref: '#/components/responses/BadRequest'
5601 '401':
5602 $ref: '#/components/responses/Unauthorized'
5603 '403':
5604 $ref: '#/components/responses/Forbidden'
5605 '404':
5606 $ref: '#/components/responses/NotFound'
5607 '405':
5608 $ref: '#/components/responses/MethodNotAllowed'
5609 '406':
5610 $ref: '#/components/responses/NotAcceptable'
5611 '409':
5612 $ref: '#/components/responses/Conflict'
5613 '422':
5614 $ref: '#/components/responses/UnprocessableEntity'
5615 '500':
5616 $ref: '#/components/responses/InternalServerError'
5617 '503':
5618 $ref: '#/components/responses/ServiceUnavailable'
5619 '5XX':
5620 $ref: '#/components/responses/UnexpectedError'
5621 default:
5622 $ref: '#/components/responses/UnexpectedError'
5623 post:
5624 tags:
garciadeblas77849982020-02-28 15:41:43 +01005625 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005626 - "Admin"
5627 summary: Create a new SDN
5628 description: Create a new SDN
5629 operationId: createSDN
5630 requestBody:
5631 $ref: '#/components/requestBodies/CreateSdnRequest'
5632 responses:
5633 '202':
5634 description: Accepted
5635 content:
5636 application/json:
5637 schema:
5638 $ref: '#/components/schemas/ObjectId_plus_OpId'
5639 application/yaml:
5640 schema:
5641 $ref: '#/components/schemas/ObjectId_plus_OpId'
5642 '400':
5643 $ref: '#/components/responses/BadRequest'
5644 '401':
5645 $ref: '#/components/responses/Unauthorized'
5646 '403':
5647 $ref: '#/components/responses/Forbidden'
5648 '404':
5649 $ref: '#/components/responses/NotFound'
5650 '405':
5651 $ref: '#/components/responses/MethodNotAllowed'
5652 '406':
5653 $ref: '#/components/responses/NotAcceptable'
5654 '409':
5655 $ref: '#/components/responses/Conflict'
5656 '422':
5657 $ref: '#/components/responses/UnprocessableEntity'
5658 '500':
5659 $ref: '#/components/responses/InternalServerError'
5660 '503':
5661 $ref: '#/components/responses/ServiceUnavailable'
5662 '5XX':
5663 $ref: '#/components/responses/UnexpectedError'
5664 default:
5665 $ref: '#/components/responses/UnexpectedError'
5666 '/admin/v1/sdns/{sdnId}':
5667 parameters:
5668 - name: sdnId
5669 in: path
5670 required: true
5671 description: SDN ID
5672 schema:
5673 type: string
5674 format: uuid
5675 get:
5676 tags:
garciadeblas77849982020-02-28 15:41:43 +01005677 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005678 - "Admin"
5679 summary: Query information about an individual SDN
5680 description: Query information about an individual SDN
5681 operationId: getSDN
5682 responses:
5683 '200':
5684 description: OK
5685 content:
5686 application/json:
5687 schema:
5688 $ref: '#/components/schemas/SdnInfo'
5689 application/yaml:
5690 schema:
5691 $ref: '#/components/schemas/SdnInfo'
5692 '400':
5693 $ref: '#/components/responses/BadRequest'
5694 '401':
5695 $ref: '#/components/responses/Unauthorized'
5696 '403':
5697 $ref: '#/components/responses/Forbidden'
5698 '404':
5699 $ref: '#/components/responses/NotFound'
5700 '405':
5701 $ref: '#/components/responses/MethodNotAllowed'
5702 '406':
5703 $ref: '#/components/responses/NotAcceptable'
5704 '409':
5705 $ref: '#/components/responses/Conflict'
5706 '422':
5707 $ref: '#/components/responses/UnprocessableEntity'
5708 '500':
5709 $ref: '#/components/responses/InternalServerError'
5710 '503':
5711 $ref: '#/components/responses/ServiceUnavailable'
5712 '5XX':
5713 $ref: '#/components/responses/UnexpectedError'
5714 default:
5715 $ref: '#/components/responses/UnexpectedError'
5716 patch:
5717 tags:
garciadeblas77849982020-02-28 15:41:43 +01005718 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005719 - "Admin"
5720 summary: Modify a SDN
5721 description: Modify a SDN
5722 operationId: editSDN
5723 requestBody:
5724 $ref: '#/components/requestBodies/EditSdnRequest'
5725 responses:
5726 '202':
5727 description: Accepted
5728 content:
5729 application/json:
5730 schema:
5731 $ref: '#/components/schemas/OpId'
5732 application/yaml:
5733 schema:
5734 $ref: '#/components/schemas/OpId'
5735 '400':
5736 $ref: '#/components/responses/BadRequest'
5737 '401':
5738 $ref: '#/components/responses/Unauthorized'
5739 '403':
5740 $ref: '#/components/responses/Forbidden'
5741 '404':
5742 $ref: '#/components/responses/NotFound'
5743 '405':
5744 $ref: '#/components/responses/MethodNotAllowed'
5745 '406':
5746 $ref: '#/components/responses/NotAcceptable'
5747 '409':
5748 $ref: '#/components/responses/Conflict'
5749 '422':
5750 $ref: '#/components/responses/UnprocessableEntity'
5751 '500':
5752 $ref: '#/components/responses/InternalServerError'
5753 '503':
5754 $ref: '#/components/responses/ServiceUnavailable'
5755 '5XX':
5756 $ref: '#/components/responses/UnexpectedError'
5757 default:
5758 $ref: '#/components/responses/UnexpectedError'
5759 delete:
5760 tags:
garciadeblas77849982020-02-28 15:41:43 +01005761 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005762 - "Admin"
5763 summary: Delete a SDN
5764 description: Delete a SDN
5765 operationId: deleteSDN
5766 responses:
5767 '202':
5768 description: Accepted
5769 '400':
5770 $ref: '#/components/responses/BadRequest'
5771 '401':
5772 $ref: '#/components/responses/Unauthorized'
5773 '403':
5774 $ref: '#/components/responses/Forbidden'
5775 '404':
5776 $ref: '#/components/responses/NotFound'
5777 '405':
5778 $ref: '#/components/responses/MethodNotAllowed'
5779 '406':
5780 $ref: '#/components/responses/NotAcceptable'
5781 '409':
5782 $ref: '#/components/responses/Conflict'
5783 '422':
5784 $ref: '#/components/responses/UnprocessableEntity'
5785 '500':
5786 $ref: '#/components/responses/InternalServerError'
5787 '503':
5788 $ref: '#/components/responses/ServiceUnavailable'
5789 '5XX':
5790 $ref: '#/components/responses/UnexpectedError'
5791 default:
5792 $ref: '#/components/responses/UnexpectedError'
5793 '/admin/v1/k8sclusters':
5794 get:
5795 tags:
garciadeblas77849982020-02-28 15:41:43 +01005796 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005797 - "Admin"
5798 summary: Query information about multiple K8s Clusters
5799 description: Query information about multiple K8s Clusters
5800 operationId: getK8sClusters
5801 responses:
5802 '200':
5803 description: OK
5804 content:
5805 application/json:
5806 schema:
5807 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5808 application/yaml:
5809 schema:
5810 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5811 '400':
5812 $ref: '#/components/responses/BadRequest'
5813 '401':
5814 $ref: '#/components/responses/Unauthorized'
5815 '403':
5816 $ref: '#/components/responses/Forbidden'
5817 '404':
5818 $ref: '#/components/responses/NotFound'
5819 '405':
5820 $ref: '#/components/responses/MethodNotAllowed'
5821 '406':
5822 $ref: '#/components/responses/NotAcceptable'
5823 '409':
5824 $ref: '#/components/responses/Conflict'
5825 '422':
5826 $ref: '#/components/responses/UnprocessableEntity'
5827 '500':
5828 $ref: '#/components/responses/InternalServerError'
5829 '503':
5830 $ref: '#/components/responses/ServiceUnavailable'
5831 '5XX':
5832 $ref: '#/components/responses/UnexpectedError'
5833 default:
5834 $ref: '#/components/responses/UnexpectedError'
5835 post:
5836 tags:
garciadeblas77849982020-02-28 15:41:43 +01005837 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005838 - "Admin"
5839 summary: Create a new K8s Cluster
5840 description: Create a new K8s Cluster
5841 operationId: createK8sCluster
5842 requestBody:
5843 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5844 responses:
5845 '202':
5846 description: Accepted
5847 content:
5848 application/json:
5849 schema:
5850 $ref: '#/components/schemas/ObjectId_plus_OpId'
5851 application/yaml:
5852 schema:
5853 $ref: '#/components/schemas/ObjectId_plus_OpId'
5854 '400':
5855 $ref: '#/components/responses/BadRequest'
5856 '401':
5857 $ref: '#/components/responses/Unauthorized'
5858 '403':
5859 $ref: '#/components/responses/Forbidden'
5860 '404':
5861 $ref: '#/components/responses/NotFound'
5862 '405':
5863 $ref: '#/components/responses/MethodNotAllowed'
5864 '406':
5865 $ref: '#/components/responses/NotAcceptable'
5866 '409':
5867 $ref: '#/components/responses/Conflict'
5868 '422':
5869 $ref: '#/components/responses/UnprocessableEntity'
5870 '500':
5871 $ref: '#/components/responses/InternalServerError'
5872 '503':
5873 $ref: '#/components/responses/ServiceUnavailable'
5874 '5XX':
5875 $ref: '#/components/responses/UnexpectedError'
5876 default:
5877 $ref: '#/components/responses/UnexpectedError'
5878 '/admin/v1/k8sclusters/{k8sClusterId}':
5879 parameters:
5880 - name: k8sClusterId
5881 in: path
5882 required: true
5883 description: K8s Cluster ID
5884 schema:
5885 type: string
5886 format: uuid
5887 get:
5888 tags:
garciadeblas77849982020-02-28 15:41:43 +01005889 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005890 - "Admin"
5891 summary: Query information about an individual K8s Cluster
5892 description: Query information about an individual K8s Cluster
5893 operationId: getK8sCluster
5894 responses:
5895 '200':
5896 description: OK
5897 content:
5898 application/json:
5899 schema:
5900 $ref: '#/components/schemas/K8sClusterInfo'
5901 application/yaml:
5902 schema:
5903 $ref: '#/components/schemas/K8sClusterInfo'
5904 '400':
5905 $ref: '#/components/responses/BadRequest'
5906 '401':
5907 $ref: '#/components/responses/Unauthorized'
5908 '403':
5909 $ref: '#/components/responses/Forbidden'
5910 '404':
5911 $ref: '#/components/responses/NotFound'
5912 '405':
5913 $ref: '#/components/responses/MethodNotAllowed'
5914 '406':
5915 $ref: '#/components/responses/NotAcceptable'
5916 '409':
5917 $ref: '#/components/responses/Conflict'
5918 '422':
5919 $ref: '#/components/responses/UnprocessableEntity'
5920 '500':
5921 $ref: '#/components/responses/InternalServerError'
5922 '503':
5923 $ref: '#/components/responses/ServiceUnavailable'
5924 '5XX':
5925 $ref: '#/components/responses/UnexpectedError'
5926 default:
5927 $ref: '#/components/responses/UnexpectedError'
5928 patch:
5929 tags:
garciadeblas77849982020-02-28 15:41:43 +01005930 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005931 - "Admin"
5932 summary: Modify a K8s Cluster
5933 description: Modify a K8s Cluster
5934 operationId: editK8sCluster
5935 requestBody:
5936 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5937 responses:
5938 '202':
5939 description: Accepted
5940 content:
5941 application/json:
5942 schema:
5943 $ref: '#/components/schemas/OpId'
5944 application/yaml:
5945 schema:
5946 $ref: '#/components/schemas/OpId'
5947 '400':
5948 $ref: '#/components/responses/BadRequest'
5949 '401':
5950 $ref: '#/components/responses/Unauthorized'
5951 '403':
5952 $ref: '#/components/responses/Forbidden'
5953 '404':
5954 $ref: '#/components/responses/NotFound'
5955 '405':
5956 $ref: '#/components/responses/MethodNotAllowed'
5957 '406':
5958 $ref: '#/components/responses/NotAcceptable'
5959 '409':
5960 $ref: '#/components/responses/Conflict'
5961 '422':
5962 $ref: '#/components/responses/UnprocessableEntity'
5963 '500':
5964 $ref: '#/components/responses/InternalServerError'
5965 '503':
5966 $ref: '#/components/responses/ServiceUnavailable'
5967 '5XX':
5968 $ref: '#/components/responses/UnexpectedError'
5969 default:
5970 $ref: '#/components/responses/UnexpectedError'
5971 delete:
5972 tags:
garciadeblas77849982020-02-28 15:41:43 +01005973 - "Infrastructure"
delacruzramaf79f3c2019-10-22 13:13:01 +02005974 - "Admin"
5975 summary: Delete a K8s Cluster
5976 description: Delete a K8s Cluster
5977 operationId: deleteK8sCluster
5978 responses:
5979 '202':
5980 description: Accepted
5981 '400':
5982 $ref: '#/components/responses/BadRequest'
5983 '401':
5984 $ref: '#/components/responses/Unauthorized'
5985 '403':
5986 $ref: '#/components/responses/Forbidden'
5987 '404':
5988 $ref: '#/components/responses/NotFound'
5989 '405':
5990 $ref: '#/components/responses/MethodNotAllowed'
5991 '406':
5992 $ref: '#/components/responses/NotAcceptable'
5993 '409':
5994 $ref: '#/components/responses/Conflict'
5995 '422':
5996 $ref: '#/components/responses/UnprocessableEntity'
5997 '500':
5998 $ref: '#/components/responses/InternalServerError'
5999 '503':
6000 $ref: '#/components/responses/ServiceUnavailable'
6001 '5XX':
6002 $ref: '#/components/responses/UnexpectedError'
6003 default:
6004 $ref: '#/components/responses/UnexpectedError'
David Garciaaf38fce2021-05-04 12:48:04 +02006005 '/admin/v1/vca':
6006 get:
6007 tags:
6008 - "Infrastructure"
6009 - "Admin"
6010 summary: Query information about multiple VCAs
6011 description: Query information about multiple VCAs
6012 operationId: getVcas
6013 responses:
6014 '200':
6015 description: OK
6016 content:
6017 application/json:
6018 schema:
6019 $ref: '#/components/schemas/ArrayOfVcaInfo'
6020 application/yaml:
6021 schema:
6022 $ref: '#/components/schemas/ArrayOfVcaInfo'
6023 '400':
6024 $ref: '#/components/responses/BadRequest'
6025 '401':
6026 $ref: '#/components/responses/Unauthorized'
6027 '403':
6028 $ref: '#/components/responses/Forbidden'
6029 '404':
6030 $ref: '#/components/responses/NotFound'
6031 '405':
6032 $ref: '#/components/responses/MethodNotAllowed'
6033 '406':
6034 $ref: '#/components/responses/NotAcceptable'
6035 '409':
6036 $ref: '#/components/responses/Conflict'
6037 '422':
6038 $ref: '#/components/responses/UnprocessableEntity'
6039 '500':
6040 $ref: '#/components/responses/InternalServerError'
6041 '503':
6042 $ref: '#/components/responses/ServiceUnavailable'
6043 '5XX':
6044 $ref: '#/components/responses/UnexpectedError'
6045 default:
6046 $ref: '#/components/responses/UnexpectedError'
6047 post:
6048 tags:
6049 - "Infrastructure"
6050 - "Admin"
6051 summary: Create a new VCA
6052 description: Create a new VCA
6053 operationId: createVca
6054 requestBody:
6055 $ref: '#/components/requestBodies/CreateVcaRequest'
6056 responses:
6057 '202':
6058 description: Accepted
6059 content:
6060 application/json:
6061 schema:
6062 $ref: '#/components/schemas/ObjectId_plus_OpId'
6063 application/yaml:
6064 schema:
6065 $ref: '#/components/schemas/ObjectId_plus_OpId'
6066 '400':
6067 $ref: '#/components/responses/BadRequest'
6068 '401':
6069 $ref: '#/components/responses/Unauthorized'
6070 '403':
6071 $ref: '#/components/responses/Forbidden'
6072 '404':
6073 $ref: '#/components/responses/NotFound'
6074 '405':
6075 $ref: '#/components/responses/MethodNotAllowed'
6076 '406':
6077 $ref: '#/components/responses/NotAcceptable'
6078 '409':
6079 $ref: '#/components/responses/Conflict'
6080 '422':
6081 $ref: '#/components/responses/UnprocessableEntity'
6082 '500':
6083 $ref: '#/components/responses/InternalServerError'
6084 '503':
6085 $ref: '#/components/responses/ServiceUnavailable'
6086 '5XX':
6087 $ref: '#/components/responses/UnexpectedError'
6088 default:
6089 $ref: '#/components/responses/UnexpectedError'
6090 '/admin/v1/vca/{vcaId}':
6091 parameters:
6092 - name: vcaId
6093 in: path
6094 required: true
6095 description: VCA ID
6096 schema:
6097 type: string
6098 format: uuid
6099 get:
6100 tags:
6101 - "Infrastructure"
6102 - "Admin"
6103 summary: Query information about an individual VCA
6104 description: Query information about an individual VCA
6105 operationId: getVca
6106 responses:
6107 '200':
6108 description: OK
6109 content:
6110 application/json:
6111 schema:
6112 $ref: '#/components/schemas/VcaInfo'
6113 application/yaml:
6114 schema:
6115 $ref: '#/components/schemas/VcaInfo'
6116 '400':
6117 $ref: '#/components/responses/BadRequest'
6118 '401':
6119 $ref: '#/components/responses/Unauthorized'
6120 '403':
6121 $ref: '#/components/responses/Forbidden'
6122 '404':
6123 $ref: '#/components/responses/NotFound'
6124 '405':
6125 $ref: '#/components/responses/MethodNotAllowed'
6126 '406':
6127 $ref: '#/components/responses/NotAcceptable'
6128 '409':
6129 $ref: '#/components/responses/Conflict'
6130 '422':
6131 $ref: '#/components/responses/UnprocessableEntity'
6132 '500':
6133 $ref: '#/components/responses/InternalServerError'
6134 '503':
6135 $ref: '#/components/responses/ServiceUnavailable'
6136 '5XX':
6137 $ref: '#/components/responses/UnexpectedError'
6138 default:
6139 $ref: '#/components/responses/UnexpectedError'
6140 patch:
6141 tags:
6142 - "Infrastructure"
6143 - "Admin"
6144 summary: Modify a VCA
6145 description: Modify a VCA
6146 operationId: editVca
6147 requestBody:
6148 $ref: '#/components/requestBodies/EditVcaRequest'
6149 responses:
6150 '202':
6151 description: Accepted
6152 content:
6153 application/json:
6154 schema:
6155 $ref: '#/components/schemas/OpId'
6156 application/yaml:
6157 schema:
6158 $ref: '#/components/schemas/OpId'
6159 '400':
6160 $ref: '#/components/responses/BadRequest'
6161 '401':
6162 $ref: '#/components/responses/Unauthorized'
6163 '403':
6164 $ref: '#/components/responses/Forbidden'
6165 '404':
6166 $ref: '#/components/responses/NotFound'
6167 '405':
6168 $ref: '#/components/responses/MethodNotAllowed'
6169 '406':
6170 $ref: '#/components/responses/NotAcceptable'
6171 '409':
6172 $ref: '#/components/responses/Conflict'
6173 '422':
6174 $ref: '#/components/responses/UnprocessableEntity'
6175 '500':
6176 $ref: '#/components/responses/InternalServerError'
6177 '503':
6178 $ref: '#/components/responses/ServiceUnavailable'
6179 '5XX':
6180 $ref: '#/components/responses/UnexpectedError'
6181 default:
6182 $ref: '#/components/responses/UnexpectedError'
6183 delete:
6184 tags:
6185 - "Infrastructure"
6186 - "Admin"
6187 summary: Delete a VCA
6188 description: Delete a VCA
6189 operationId: deleteVca
6190 responses:
6191 '202':
6192 description: Accepted
6193 '400':
6194 $ref: '#/components/responses/BadRequest'
6195 '401':
6196 $ref: '#/components/responses/Unauthorized'
6197 '403':
6198 $ref: '#/components/responses/Forbidden'
6199 '404':
6200 $ref: '#/components/responses/NotFound'
6201 '405':
6202 $ref: '#/components/responses/MethodNotAllowed'
6203 '406':
6204 $ref: '#/components/responses/NotAcceptable'
6205 '409':
6206 $ref: '#/components/responses/Conflict'
6207 '422':
6208 $ref: '#/components/responses/UnprocessableEntity'
6209 '500':
6210 $ref: '#/components/responses/InternalServerError'
6211 '503':
6212 $ref: '#/components/responses/ServiceUnavailable'
6213 '5XX':
6214 $ref: '#/components/responses/UnexpectedError'
6215 default:
6216 $ref: '#/components/responses/UnexpectedError'
delacruzramaf79f3c2019-10-22 13:13:01 +02006217 '/admin/v1/k8srepos':
6218 get:
6219 tags:
garciadeblas77849982020-02-28 15:41:43 +01006220 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006221 - "Admin"
6222 summary: Query information about multiple K8s Repos
6223 description: Query information about multiple K8s Repos
6224 operationId: getK8sRepos
6225 responses:
6226 '200':
6227 description: OK
6228 content:
6229 application/json:
6230 schema:
6231 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6232 application/yaml:
6233 schema:
6234 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6235 '400':
6236 $ref: '#/components/responses/BadRequest'
6237 '401':
6238 $ref: '#/components/responses/Unauthorized'
6239 '403':
6240 $ref: '#/components/responses/Forbidden'
6241 '404':
6242 $ref: '#/components/responses/NotFound'
6243 '405':
6244 $ref: '#/components/responses/MethodNotAllowed'
6245 '406':
6246 $ref: '#/components/responses/NotAcceptable'
6247 '409':
6248 $ref: '#/components/responses/Conflict'
6249 '422':
6250 $ref: '#/components/responses/UnprocessableEntity'
6251 '500':
6252 $ref: '#/components/responses/InternalServerError'
6253 '503':
6254 $ref: '#/components/responses/ServiceUnavailable'
6255 '5XX':
6256 $ref: '#/components/responses/UnexpectedError'
6257 default:
6258 $ref: '#/components/responses/UnexpectedError'
6259 post:
6260 tags:
garciadeblas77849982020-02-28 15:41:43 +01006261 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006262 - "Admin"
6263 summary: Create a new K8s Repo
6264 description: Create a new K8s Repo
6265 operationId: createK8sRepo
6266 requestBody:
6267 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6268 responses:
6269 '202':
6270 description: Accepted
6271 content:
6272 application/json:
6273 schema:
6274 $ref: '#/components/schemas/ObjectId_plus_OpId'
6275 application/yaml:
6276 schema:
6277 $ref: '#/components/schemas/ObjectId_plus_OpId'
6278 '400':
6279 $ref: '#/components/responses/BadRequest'
6280 '401':
6281 $ref: '#/components/responses/Unauthorized'
6282 '403':
6283 $ref: '#/components/responses/Forbidden'
6284 '404':
6285 $ref: '#/components/responses/NotFound'
6286 '405':
6287 $ref: '#/components/responses/MethodNotAllowed'
6288 '406':
6289 $ref: '#/components/responses/NotAcceptable'
6290 '409':
6291 $ref: '#/components/responses/Conflict'
6292 '422':
6293 $ref: '#/components/responses/UnprocessableEntity'
6294 '500':
6295 $ref: '#/components/responses/InternalServerError'
6296 '503':
6297 $ref: '#/components/responses/ServiceUnavailable'
6298 '5XX':
6299 $ref: '#/components/responses/UnexpectedError'
6300 default:
6301 $ref: '#/components/responses/UnexpectedError'
6302 '/admin/v1/k8srepos/{k8sRepoId}':
6303 parameters:
6304 - name: k8sRepoId
6305 in: path
6306 required: true
6307 description: K8s Repo ID
6308 schema:
6309 type: string
6310 format: uuid
6311 get:
6312 tags:
garciadeblas77849982020-02-28 15:41:43 +01006313 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006314 - "Admin"
6315 summary: Query information about an individual K8s Repo
6316 description: Query information about an individual K8s Repo
6317 operationId: getK8sRepo
6318 responses:
6319 '200':
6320 description: OK
6321 content:
6322 application/json:
6323 schema:
6324 $ref: '#/components/schemas/K8sRepoInfo'
6325 application/yaml:
6326 schema:
6327 $ref: '#/components/schemas/K8sRepoInfo'
6328 '400':
6329 $ref: '#/components/responses/BadRequest'
6330 '401':
6331 $ref: '#/components/responses/Unauthorized'
6332 '403':
6333 $ref: '#/components/responses/Forbidden'
6334 '404':
6335 $ref: '#/components/responses/NotFound'
6336 '405':
6337 $ref: '#/components/responses/MethodNotAllowed'
6338 '406':
6339 $ref: '#/components/responses/NotAcceptable'
6340 '409':
6341 $ref: '#/components/responses/Conflict'
6342 '422':
6343 $ref: '#/components/responses/UnprocessableEntity'
6344 '500':
6345 $ref: '#/components/responses/InternalServerError'
6346 '503':
6347 $ref: '#/components/responses/ServiceUnavailable'
6348 '5XX':
6349 $ref: '#/components/responses/UnexpectedError'
6350 default:
6351 $ref: '#/components/responses/UnexpectedError'
6352 delete:
6353 tags:
garciadeblas77849982020-02-28 15:41:43 +01006354 - "Repositories"
delacruzramaf79f3c2019-10-22 13:13:01 +02006355 - "Admin"
6356 summary: Delete a K8s Repo
6357 description: Delete a K8s Repo
6358 operationId: deleteK8sRepo
6359 responses:
6360 '202':
6361 description: Accepted
6362 '400':
6363 $ref: '#/components/responses/BadRequest'
6364 '401':
6365 $ref: '#/components/responses/Unauthorized'
6366 '403':
6367 $ref: '#/components/responses/Forbidden'
6368 '404':
6369 $ref: '#/components/responses/NotFound'
6370 '405':
6371 $ref: '#/components/responses/MethodNotAllowed'
6372 '406':
6373 $ref: '#/components/responses/NotAcceptable'
6374 '409':
6375 $ref: '#/components/responses/Conflict'
6376 '422':
6377 $ref: '#/components/responses/UnprocessableEntity'
6378 '500':
6379 $ref: '#/components/responses/InternalServerError'
6380 '503':
6381 $ref: '#/components/responses/ServiceUnavailable'
6382 '5XX':
6383 $ref: '#/components/responses/UnexpectedError'
6384 default:
6385 $ref: '#/components/responses/UnexpectedError'
delacruzramfb52ade2019-10-07 16:46:59 +02006386# END Admin
6387
garciadeblas60e2ee92018-02-27 19:09:51 +01006388externalDocs:
delacruzramaf79f3c2019-10-22 13:13:01 +02006389 description: Find out more about OSM
garciadeblas00c2eb92020-02-28 15:24:27 +01006390 url: 'https://osm.etsi.org/docs/user-guide/'
delacruzramfb52ade2019-10-07 16:46:59 +02006391
garciadeblas60e2ee92018-02-27 19:09:51 +01006392components:
6393 responses:
6394 BadRequest:
6395 description: Bad request. The server cannot process the request due to a client error.
6396 content:
6397 application/json:
6398 schema:
6399 $ref: '#/components/schemas/ProblemDetails'
6400 Unauthorized:
6401 description: Authorization information is missing or invalid.
6402 content:
6403 application/json:
6404 schema:
6405 $ref: '#/components/schemas/ProblemDetails'
6406 Forbidden:
6407 description: Not enough permissions to do this operation.
6408 content:
6409 application/json:
6410 schema:
6411 $ref: '#/components/schemas/ProblemDetails'
6412 NotFound:
6413 description: The specified resource was not found.
6414 content:
6415 application/json:
6416 schema:
6417 $ref: '#/components/schemas/ProblemDetails'
6418 MethodNotAllowed:
6419 description: This method is not supported for the requested resource.
6420 content:
6421 application/json:
6422 schema:
6423 $ref: '#/components/schemas/ProblemDetails'
6424 NotAcceptable:
6425 description: The requested resource content cannot match the Accept headers sent in the request.
6426 content:
6427 application/json:
6428 schema:
6429 $ref: '#/components/schemas/ProblemDetails'
6430 Conflict:
6431 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6432 content:
6433 application/json:
6434 schema:
6435 $ref: '#/components/schemas/ProblemDetails'
6436 UnprocessableEntity:
6437 description: The request was well-formed but was unable to be followed due to semantic errors.
6438 content:
6439 application/json:
6440 schema:
6441 $ref: '#/components/schemas/ProblemDetails'
6442 InternalServerError:
6443 description: Internal server error.
6444 content:
6445 application/json:
6446 schema:
6447 $ref: '#/components/schemas/ProblemDetails'
6448 ServiceUnavailable:
6449 description: Service temporarily unavailable.
6450 content:
6451 application/json:
6452 schema:
6453 $ref: '#/components/schemas/ProblemDetails'
6454 UnexpectedError:
6455 description: Unexpected error.
6456 content:
6457 application/json:
6458 schema:
6459 $ref: '#/components/schemas/ProblemDetails'
delacruzramfb52ade2019-10-07 16:46:59 +02006460 VnfDescriptor:
6461 description: VNF Descriptor (plaintext)
6462 content:
6463 text/plain:
6464 schema:
6465 $ref: '#/components/schemas/VnfDescriptor'
6466 VnfPackage:
6467 description: VNF Package (compressed)
6468 content:
6469 application/zip:
6470 schema:
6471 $ref: '#/components/schemas/VnfPackage'
garciadeblas60e2ee92018-02-27 19:09:51 +01006472 NsDescriptor:
delacruzramfb52ade2019-10-07 16:46:59 +02006473 description: NS Descriptor (plaintext)
6474 content:
6475 text/plain:
6476 schema:
6477 $ref: '#/components/schemas/NsDescriptor'
garciadeblas60e2ee92018-02-27 19:09:51 +01006478 NsPackage:
delacruzramfb52ade2019-10-07 16:46:59 +02006479 description: NS Package (compressed)
6480 content:
6481 application/zip:
6482 schema:
6483 $ref: '#/components/schemas/NsPackage'
6484 NetSliceTemplate:
6485 description: NetSlice Template (plaintext)
6486 content:
6487 text/plain:
6488 schema:
6489 $ref: '#/components/schemas/NetSliceTemplate'
6490 NetSlicePackage:
6491 description: NetSlice Package (compressed)
6492 content:
6493 application/zip:
6494 schema:
6495 $ref: '#/components/schemas/NetSlicePackage'
preethika.p31b3a802020-07-28 09:14:01 +00006496 NslcmSubscriptionResponse:
6497 description: NslcmSubscriptionResponse
6498 content:
6499 application/json:
6500 schema:
6501 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6502 application/yaml:
6503 schema:
6504 $ref: '#/components/schemas/NslcmSubscriptionResponse'
delacruzramfb52ade2019-10-07 16:46:59 +02006505 # END RESPONSES
6506
6507 schemas:
6508 ObjectId:
garciadeblas60e2ee92018-02-27 19:09:51 +01006509 type: object
6510 properties:
6511 id:
delacruzramfb52ade2019-10-07 16:46:59 +02006512 type: string
6513 format: uuid
6514 KeyValuePairs:
6515 # A free list of key:value pairs
6516 type: object
6517 additionalProperties: true
6518 NsDescriptor:
6519 type: string
6520 format: yaml|json
6521 NsPackage:
6522 type: string
6523 format: binary
6524 CreateNsdInfoRequest:
6525 # A free list of key:value pairs
6526 type: object
6527 additionalProperties: true
6528 NsdInfoModifications:
6529 description: |
6530 NS Descriptor Information
6531 Only generic fields (id, name, description) are described
6532 For a full specification of the NS Descriptor see:
6533 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6534 type: object
6535 properties:
6536 id:
6537 description: NSD Identifier
6538 type: string
6539 name:
6540 description: NSD Name
6541 type: string
6542 description:
6543 description: NSD Description
6544 type: string
Atul Agarwal4cd9e952021-05-20 09:24:26 +00006545 AlarmInfoModifications:
6546 description: |
6547 Alarm Information
6548 type: object
6549 properties:
6550 id:
6551 description: UUID
6552 type: string
6553 is_enable:
6554 description: To enable/disable the alarm.
6555 type: string
6556 threshold:
6557 description: Threshold value of the Alarm
6558 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006559 NsdInfo:
6560 description: |
6561 NS Descriptor Information
6562 Only generic fields (_id, id, name, description) are described
6563 For a full specification of the NS Descriptor see:
6564 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6565 type: object
6566 properties:
6567 _id:
garciadeblas60e2ee92018-02-27 19:09:51 +01006568 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +01006569 Identifier of the onboarded individual NS descriptor
6570 resource. This identifier is allocated by the NFVO.
garciadeblas60e2ee92018-02-27 19:09:51 +01006571 type: string
6572 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02006573 id:
garciadeblas60e2ee92018-02-27 19:09:51 +01006574 description: |
6575 This identifier, which is allocated by the NSD
6576 designer, identifies the NSD in a globally unique
6577 way. It is copied from the NSD content and shall be
6578 present after the NSD content is on-boarded.
6579 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006580 name:
garciadeblas60e2ee92018-02-27 19:09:51 +01006581 description: |
6582 Name of the onboarded NSD. This information is
6583 copied from the NSD content and shall be present
garciadeblas60e2ee92018-02-27 19:09:51 +01006584 after the NSD content is on-boarded.
6585 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006586 description:
garciadeblas60e2ee92018-02-27 19:09:51 +01006587 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02006588 Description of the onboarded NSD.
6589 This information is copied from the NSD content.
garciadeblas60e2ee92018-02-27 19:09:51 +01006590 type: string
garciadeblas60e2ee92018-02-27 19:09:51 +01006591 required:
delacruzramfb52ade2019-10-07 16:46:59 +02006592 - _id
garciadeblas60e2ee92018-02-27 19:09:51 +01006593 - id
6594 ArrayOfNsdInfo:
6595 type: array
6596 items:
6597 $ref: '#/components/schemas/NsdInfo'
garciadeblas60e2ee92018-02-27 19:09:51 +01006598 ProblemDetails:
6599 type: object
6600 properties:
6601 type:
6602 type: string
6603 format: uri
6604 title:
6605 type: string
6606 status:
6607 type: integer
6608 detail:
6609 type: string
6610 instance:
6611 type: string
6612 format: uri
6613 additionalProperties: true
6614 required:
6615 - status
6616 - detail
garciadeblas63fe88c2018-02-28 19:32:41 +01006617 VnfDescriptor:
6618 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006619 format: yaml|json
garciadeblas63fe88c2018-02-28 19:32:41 +01006620 VnfPackage:
6621 type: string
6622 format: binary
6623 CreateVnfPkgInfoRequest:
delacruzramfb52ade2019-10-07 16:46:59 +02006624 # A free list of key:value pairs
garciadeblas63fe88c2018-02-28 19:32:41 +01006625 type: object
6626 additionalProperties: true
6627 VnfPkgInfoModifications:
delacruzramfb52ade2019-10-07 16:46:59 +02006628 description: |
6629 VNF Package Information
6630 Only generic fields (id, name, description) are described
6631 For a full specification of the VNF Descriptor see:
6632 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
garciadeblas63fe88c2018-02-28 19:32:41 +01006633 type: object
6634 properties:
6635 id:
delacruzramfb52ade2019-10-07 16:46:59 +02006636 description: VNF Package Identifier
6637 type: string
6638 name:
6639 description: VNF Package Name
6640 type: string
6641 description:
6642 description: VNF Package description
6643 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006644 VnfPkgInfo:
6645 description: |
6646 VNF Package Information
6647 Only generic fields (_id, id, name, description) are described
6648 For a full specification of the VNF Descriptor see:
6649 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6650 type: object
6651 properties:
6652 _id:
garciadeblas63fe88c2018-02-28 19:32:41 +01006653 description: |
garciadeblas12fcc4b2018-03-02 16:12:02 +01006654 Identifier of the VNF package. This identifier is allocated by the NFVO.
garciadeblas63fe88c2018-02-28 19:32:41 +01006655 type: string
6656 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02006657 id:
6658 description: VNF Package Identifier
garciadeblas63fe88c2018-02-28 19:32:41 +01006659 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006660 name:
6661 description: VNF Package Name
garciadeblas63fe88c2018-02-28 19:32:41 +01006662 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006663 description:
6664 description: VNF Package description
garciadeblas63fe88c2018-02-28 19:32:41 +01006665 type: string
garciadeblas63fe88c2018-02-28 19:32:41 +01006666 required:
delacruzramfb52ade2019-10-07 16:46:59 +02006667 - _id
garciadeblas63fe88c2018-02-28 19:32:41 +01006668 - id
garciadeblas63fe88c2018-02-28 19:32:41 +01006669 ArrayOfVnfPkgInfo:
6670 type: array
6671 items:
6672 $ref: '#/components/schemas/VnfPkgInfo'
delacruzramaf79f3c2019-10-22 13:13:01 +02006673 # CreateNsRequest:
6674 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +01006675 NsInstance:
delacruzramfb52ade2019-10-07 16:46:59 +02006676 description: |
6677 NS Instance Information
6678 Only generic fields (_id, id, name, description) are described
6679 For a full specification of the NS Instance see:
6680 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
garciadeblas12fcc4b2018-03-02 16:12:02 +01006681 type: object
6682 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02006683 _id:
6684 description: Identifier of the NS instance.
6685 type: string
6686 format: uuid
garciadeblas12fcc4b2018-03-02 16:12:02 +01006687 id:
6688 description: Identifier of the NS instance.
6689 type: string
6690 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02006691 name:
garciadeblas12fcc4b2018-03-02 16:12:02 +01006692 description: Human readable name of the NS instance.
6693 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006694 description:
garciadeblas12fcc4b2018-03-02 16:12:02 +01006695 description: Human readable description of the NS instance.
6696 type: string
garciadeblas12fcc4b2018-03-02 16:12:02 +01006697 required:
delacruzramfb52ade2019-10-07 16:46:59 +02006698 - _id
garciadeblas12fcc4b2018-03-02 16:12:02 +01006699 - id
delacruzramfb52ade2019-10-07 16:46:59 +02006700 - name
garciadeblas12fcc4b2018-03-02 16:12:02 +01006701 InstantiateNsRequest:
6702 type: object
6703 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02006704 nsName:
6705 description: |
6706 Human-readable name of the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01006707 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006708 nsdId:
garciadeblas12fcc4b2018-03-02 16:12:02 +01006709 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02006710 Identifier of the NSD that defines the NS instance to be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01006711 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006712 format: uuid
6713 vimAccountId:
garciadeblas12fcc4b2018-03-02 16:12:02 +01006714 description: |
delacruzramfb52ade2019-10-07 16:46:59 +02006715 Identifier of the VIM Account where the NS instance shall be created.
garciadeblas12fcc4b2018-03-02 16:12:02 +01006716 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02006717 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02006718 lcmOperationType:
6719 type: string
6720 nsInstanceId:
6721 type: string
6722 format: uuid
6723 netsliceInstanceId:
6724 type: string
6725 format: uuid
6726 nsDescription:
6727 type: string
6728 nullable: true
6729 wimAccountId:
6730 oneOf:
6731 - type: string
6732 - type: boolean
6733 nullable: true
6734 additionalParamsForNs:
6735 type: object
6736 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00006737 additionalParamsForVnf: &additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +02006738 type: array
6739 items:
6740 type: object
6741 properties:
6742 member-vnf-index:
6743 type: string
6744 additionalParams:
6745 type: object
6746 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00006747 k8s-namespace:
6748 type: string
6749 description: |
6750 use this namespace for all the KDU deployed in this VNF
6751 (if any). By default it is used the id of the project
delacruzramaf79f3c2019-10-22 13:13:01 +02006752 additionalParamsForVdu:
6753 type: array
6754 items:
6755 type: object
6756 properties:
6757 vdu_id:
6758 type: string
6759 additionalParams:
6760 type: object
6761 additionalProperties: true
6762 required:
6763 - vdu_id
6764 - additionalParams
6765 additionalProperties: false
6766 additionalParamsForKdu:
6767 type: array
6768 items:
6769 type: object
6770 properties:
6771 kdu_name:
6772 type: string
tiernof2c14402020-04-24 13:55:01 +00006773 k8s-namespace:
6774 type: string
6775 description: use this namespace for this KDU
6776 kdu_model:
6777 type: string
delacruzramaf79f3c2019-10-22 13:13:01 +02006778 additionalParams:
6779 type: object
6780 additionalProperties: true
6781 required:
6782 - kdu_name
tiernof2c14402020-04-24 13:55:01 +00006783 minProperties: 2
delacruzramaf79f3c2019-10-22 13:13:01 +02006784 additionalProperties: false
6785 required:
6786 - member-vnf-index
6787 minProperties: 2
6788 additionalProperties: false
6789 ssh_keys:
6790 type: array
6791 items:
6792 type: string
6793 nsr_id:
6794 type: string
6795 format: uuid
6796 vduImage:
6797 type: string
tiernof2c14402020-04-24 13:55:01 +00006798 placement-engine:
6799 type: string
6800 description: |
6801 To compute automatically the target VIM for each VNF based on
6802 constrains, e.g. latency. Currently only 'PLA' is supported
6803 placement-constraints:
6804 type: object
6805 additionalProperties: true
6806 k8s-namespace:
6807 type: string
6808 timeout_ns_deploy:
6809 type: integer
delacruzramaf79f3c2019-10-22 13:13:01 +02006810 vnf:
6811 type: array
6812 items:
6813 type: object
6814 properties:
6815 member-vnf-index:
6816 type: string
6817 vimAccountId:
6818 type: string
6819 format: uuid
6820 vdu:
6821 type: array
6822 items:
6823 type: object
6824 properties:
6825 id:
6826 type: string
6827 volume:
6828 type: array
6829 items:
6830 type: object
6831 properties:
6832 name:
6833 type: string
6834 vim-volume-id:
6835 type: string
6836 required:
6837 - name
6838 - vim-volume-id
6839 additionalProperties: false
6840 minItems: 1
6841 interface:
6842 type: array
6843 items:
6844 type: object
6845 properties:
6846 name:
6847 type: string
6848 ip-address:
6849 type: string
6850 format: ipv4
6851 mac-address:
6852 type: string
6853 format: mac_address
6854 floating-ip-required:
6855 type: boolean
6856 required:
6857 - name
6858 additionalProperties: false
6859 minItems: 1
6860 required:
6861 - id
6862 additionalProperties: false
6863 minItems: 1
6864 internal-vld:
6865 type: array
6866 items:
6867 type: object
6868 properties:
6869 name:
6870 type: string
6871 vim-network-name:
6872 type: string
6873 vim-network-id:
6874 type: string
6875 ip-profile:
6876 type: object
6877 properties:
6878 ip-version:
6879 type: string
6880 enum:
6881 - ipv4
6882 - ipv6
6883 subnet-address:
6884 type: string
6885 format: ip_prefix
6886 nullable: true
6887 gateway-address:
6888 type: string
6889 format: ipv4
6890 nullable: true
6891 dns-server:
6892 type: array
6893 items:
6894 type: object
6895 properties:
6896 address:
6897 type: string
6898 format: ipv4
6899 required:
6900 - address
6901 additionalProperties: false
6902 minItems: 1
6903 nullable: true
6904 dhcp-params:
6905 type: object
6906 properties:
6907 enabled:
6908 type: boolean
6909 count:
6910 type: integer
6911 minimum: 1
6912 start-address:
6913 type: string
6914 format: ipv4
6915 additionalProperties: false
6916 nullable: true
6917 additionalProperties: false
6918 provider-network:
6919 type: object
6920 properties:
6921 physical-network:
6922 type: string
6923 segmentation-id:
6924 type: string
tiernof2c14402020-04-24 13:55:01 +00006925 network-type:
6926 type: string
6927 sdn-ports:
6928 description: |
6929 connect additional ports to the created underlay SDN connectivity.
6930 Normally for external connectivy.
6931 type: array
6932 items:
6933 type: object
6934 properties:
6935 switch_id:
6936 type: string
6937 switch_port:
6938 type: string
6939 mac_address:
6940 type: string
6941 format: mac_address
6942 vlan:
6943 type: integer
6944 additionalProperties: true
6945 required:
6946 - switch_id
6947 - switch_port
6948 minItems: 1
delacruzramaf79f3c2019-10-22 13:13:01 +02006949 additionalProperties: false
6950 internal-connection-point:
6951 type: array
6952 items:
6953 type: object
6954 properties:
6955 id-ref:
6956 type: string
6957 ip-address:
6958 type: string
6959 format: ipv4
6960 required:
6961 - id-ref
6962 minProperties: 2
6963 additionalProperties: False
6964 minItems: 1
6965 required:
6966 - name
6967 minProperties: 2
6968 additionalProperties: false
6969 minItems: 1
6970 required:
6971 - member-vnf-index
6972 minProperties: 2
6973 additionalProperties: false
6974 minItems: 1
6975 vld:
6976 type: array
6977 items:
6978 type: object
6979 properties:
6980 name:
6981 type: string
6982 vim-network-name:
6983 oneOf:
6984 - type: string
6985 - type: object
6986 vim-network-id:
6987 oneOf:
6988 - type: string
6989 - type: object
6990 ns-net:
6991 type: object
6992 additionalProperties: true
6993 wimAccountId:
6994 oneOf:
6995 - type: string
6996 - type: boolean
6997 nullable: true
6998 ip-profile:
6999 type: object
7000 additionalProperties: true
7001 provider-network:
7002 type: object
7003 properties:
7004 physical-network:
7005 type: string
7006 segmentation-id:
7007 type: string
7008 additionalProperties: false
7009 vnfd-connection-point-ref:
7010 type: array
7011 items:
7012 type: object
7013 properties:
7014 member-vnf-index-ref:
7015 type: string
7016 vnfd-connection-point-ref:
7017 type: string
7018 ip-address:
7019 type: string
7020 format: ipv4
7021 required:
7022 - member-vnf-index-ref
7023 - vnfd-connection-point-ref
7024 minProperties: 3
7025 additionalProperties: false
7026 minItems: 1
7027 required:
7028 - name
7029 additionalProperties: false
7030 minItems: 1
garciadeblas12fcc4b2018-03-02 16:12:02 +01007031 required:
delacruzramfb52ade2019-10-07 16:46:59 +02007032 - nsName
7033 - nsdId
7034 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +02007035 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007036 ScaleNsRequest:
7037 type: object
garciadeblas12fcc4b2018-03-02 16:12:02 +01007038 properties:
delacruzramfb52ade2019-10-07 16:46:59 +02007039 scaleType:
7040 type: string
7041 enum:
7042 - SCALE_VNF
tiernof2c14402020-04-24 13:55:01 +00007043 timeout_ns_scale:
7044 description: timeout for the scale operation
7045 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +02007046 scaleVnfData:
7047 type: object
7048 properties:
7049 scaleVnfType:
7050 type: string
7051 enum:
7052 - SCALE_IN
7053 - SCALE_OUT
7054 scaleByStepData:
7055 type: object
7056 properties:
7057 scaling-group-descriptor:
7058 type: string
tiernof2c14402020-04-24 13:55:01 +00007059 scaling-policy:
7060 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007061 member-vnf-index:
7062 type: string
tiernof2c14402020-04-24 13:55:01 +00007063 required:
7064 - scaling-group-descriptor
7065 - member-vnf-index
7066 additionalProperties: false
7067 required:
7068 - scaleVnfType
7069 - scaleByStepData
7070 additionalProperties: false
7071 required:
7072 - scaleType
7073 - scaleVnfData
7074 additionalProperties: false
garciadeblasb5a065f2022-02-11 00:27:47 +01007075 HealNsRequest:
7076 description: >
7077 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
7078 instance by healing one or more of the VNF that are part of this NS.
7079 type: object
7080 properties:
7081 timeout_ns_heal:
7082 description: timeout for the heal operation in seconds
7083 type: integer
7084 healVnfData:
7085 description: >
7086 List of VNF to be healed, together with the information needed to heal each.
7087 type: array
7088 items:
7089 $ref: "#/components/schemas/HealVnfData"
7090 required:
7091 - healVnfData
7092 HealVnfData:
7093 description: >
7094 This type represents the information to heal a VNF that is part of an NS.
7095 type: object
7096 required:
7097 - vnfInstanceId
7098 properties:
7099 vnfInstanceId:
7100 description: >
7101 Identifies the VNF instance, part of the NS, requiring a
7102 healing action.
7103 type: string
7104 format: uuid
7105 cause:
7106 description: >
7107 Indicates the reason why a healing procedure is required.
7108 type: string
7109 additionalParams:
7110 description: >
7111 Additional parameters passed by the NFVO as input to
7112 the healing process, specific to the VNF being healed.
7113 type: object
7114 properties:
7115 run-day1:
7116 description: >
7117 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
7118 type: boolean
7119 default: false
7120 vdu:
7121 description: >
7122 List of VDU to be healed, together with the information needed to heal each.
7123 type: array
7124 items:
7125 $ref: "#/components/schemas/HealVduData"
7126 HealVduData:
7127 description: >
7128 This type represents the information to heal a VDU that is part of a VNF.
7129 type: object
7130 required:
7131 - vdu-id
7132 properties:
7133 vdu-id:
7134 description: >
7135 Identifies the VDU id, part of the VNF, requiring a healing action.
7136 type: string
7137 format: uuid
7138 count-index:
7139 description: >
7140 Indicates the VDU number when the VDU is part of a scale-group.
7141 type: integer
7142 minimum: 0
7143 run-day1:
7144 description: >
7145 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
7146 type: boolean
7147 default: false
elumalai4b120f12022-04-28 16:44:35 +05307148 NSinstanceMigrateRequest:
7149 description: >
7150 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
7151 instance by migrating one or more of the VDUs that are part of this NS.
7152 type: object
7153 properties:
7154 vnfInstanceId:
7155 type: string
7156 migrateToHost:
7157 type: string
7158 vdu:
7159 type: object
7160 properties:
7161 vduId:
7162 type: string
7163 vduCountIndex:
7164 type: integer
7165 required:
7166 - vduId
7167 required:
7168 - vnfInstanceId
7169 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007170 TerminateNsRequest:
7171 type: object
7172 properties:
tiernof2c14402020-04-24 13:55:01 +00007173 timeout_ns_terminate:
7174 description: timeout for terminate operation
7175 type: integer
7176 autoremove:
7177 description: remove network service if termination end without error
7178 type: boolean
7179 skip_terminate_primitives:
7180 description: Do not execute network service termination primitives
7181 type: boolean
7182 additionalProperties: false
garciadeblas12fcc4b2018-03-02 16:12:02 +01007183 ArrayOfNsInstance:
7184 type: array
7185 items:
7186 $ref: '#/components/schemas/NsInstance'
delacruzramfb52ade2019-10-07 16:46:59 +02007187 NSinstanceActionRequest:
7188 type: object
7189 properties:
7190 primitive:
7191 type: string
tiernof2c14402020-04-24 13:55:01 +00007192 description: |
7193 name of the primitive in the 'config-descriptor'. If the target is
7194 a kdu it can be also 'status', 'rollback' or 'upgrade'
delacruzramfb52ade2019-10-07 16:46:59 +02007195 primitive_params:
tiernof2c14402020-04-24 13:55:01 +00007196 description: parameters of this primitive
delacruzramfb52ade2019-10-07 16:46:59 +02007197 $ref: '#/components/schemas/KeyValuePairs'
delacruzramfb52ade2019-10-07 16:46:59 +02007198 member_vnf_index:
7199 type: string
tiernof2c14402020-04-24 13:55:01 +00007200 description: provide if the target action is for a vnf, vdu or kdu
delacruzramfb52ade2019-10-07 16:46:59 +02007201 vdu_id:
7202 type: string
tiernof2c14402020-04-24 13:55:01 +00007203 description: provide if the target action is for a vdu
7204 kdu_name:
7205 type: string
7206 description: provide if the target action is for a kdu
delacruzramfb52ade2019-10-07 16:46:59 +02007207 vdu_count_index:
7208 type: integer
tiernof2c14402020-04-24 13:55:01 +00007209 timeout_ns_action:
7210 description: timeout for the day 1/2 operation
7211 type: integer
delacruzramfb52ade2019-10-07 16:46:59 +02007212 required:
7213 - primitive
7214 - primitive_params
7215 additionalProperties: false
elumalaif2eb5e72022-03-21 19:44:39 +05307216 UpdateNsRequest:
7217 description: >
7218 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
7219 instance by updating one or more of the VNFs that are part of this NS.
7220 type: object
7221 properties:
7222 updateType:
7223 type: string
7224 enum:
7225 - CHANGE_VNFPKG
7226 - REMOVE_VNF
7227 - MODIFY_VNF_INFORMATION
k4.rahul66c884c2022-06-21 06:38:49 +00007228 - OPERATE_VNF
rahulkumarr7b6daf52024-06-20 05:23:01 +00007229 - VERTICAL_SCALE
elumalaif2eb5e72022-03-21 19:44:39 +05307230 changeVnfPackageData:
7231 type: object
7232 properties:
7233 vnfInstanceId:
7234 type: string
7235 vnfdId:
7236 type: string
7237 required:
7238 - vnfInstanceId
7239 - vnfdId
7240 removeVnfInstanceId:
7241 type: string
7242 modifyVnfInfoData:
7243 type: object
7244 properties:
7245 vnfInstanceId:
7246 type: string
7247 vnfdId:
7248 type: string
7249 required:
7250 - vnfInstanceId
7251 - vnfdId
k4.rahul66c884c2022-06-21 06:38:49 +00007252 operateVnfData:
7253 type: object
7254 properties:
7255 vnfInstanceId:
7256 type: string
7257 changeStateTo:
7258 type: string
7259 additionalParam:
7260 type: object
7261 properties:
7262 run-day1:
7263 type: boolean
7264 vdu_id:
7265 type: string
7266 count-index:
7267 type: number
7268 required:
7269 - vdu_id
7270 - count-index
7271 required:
7272 - vnfInstanceId
7273 - changeStateTo
7274 additionalProperties: false
rahulkumarr7b6daf52024-06-20 05:23:01 +00007275 verticalScaleVnf:
govindarajul36a93312022-06-21 13:36:22 +05307276 type: object
7277 properties:
7278 vnfInstanceId:
7279 type: string
rahulkumarr7b6daf52024-06-20 05:23:01 +00007280 vnfdId:
7281 type: string
7282 vduId:
7283 type: string
7284 countIndex:
7285 type: number
govindarajul36a93312022-06-21 13:36:22 +05307286 required:
7287 - vnfInstanceId
rahulkumarr7b6daf52024-06-20 05:23:01 +00007288 - vnfdId
7289 - vduId
govindarajul36a93312022-06-21 13:36:22 +05307290 required:
rahulkumarr7b6daf52024-06-20 05:23:01 +00007291 - updateType
govindarajul36a93312022-06-21 13:36:22 +05307292 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02007293 # CreateNSinstanceContentRequest:
7294 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007295 CreateNSinstanceContentResponse:
7296 type: object
7297 properties:
7298 id:
7299 type: string
7300 format: uuid
7301 nslcmop_id:
7302 type: string
7303 format: uuid
7304 NsLcmOpOcc:
7305 type: object
7306 properties:
7307 _id:
7308 type: string
7309 format: uuid
7310 id:
7311 type: string
7312 format: uuid
7313 lcmOperationType:
7314 type: string
7315 nsInstanceId:
7316 type: string
7317 format: uuid
7318 isAutomaticInvocation:
7319 type: boolean
7320 isCancelPending:
7321 type: boolean
7322 startTime:
7323 type: number
7324 format: float
7325 statusEnteredTime:
7326 type: number
7327 format: float
7328 operationParams:
7329 type: object
7330 properties:
7331 nsName:
7332 type: string
7333 nsdId:
7334 type: string
7335 format: uuid
7336 vimAccountId:
7337 type: string
7338 format: uuid
7339 nsInstanceId:
7340 type: string
7341 format: uuid
7342 lcmOperationType:
7343 type: string
7344 operationState:
7345 type: string
7346 detailed-status:
7347 type: string
7348 links:
7349 type: object
7350 properties:
7351 self:
7352 type: string
7353 format: path # uri?
7354 nsInstance:
7355 type: string
7356 format: path # uri?
7357 ArrayOfNsLcmOpOcc:
7358 type: array
7359 items:
7360 $ref: '#/components/schemas/NsLcmOpOcc'
7361 VnfInstanceInfo:
7362 description: |
7363 VNF Instance Information
7364 Only generic fields (_id, id) are described
7365 For a full specification of the VNF Instance see:
7366 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7367 type: object
7368 properties:
7369 _id:
7370 type: string
7371 format: uuid
7372 id:
7373 type: string
7374 format: uuid
delacruzramfb52ade2019-10-07 16:46:59 +02007375 ArrayOfVnfInstanceInfo:
7376 type: array
7377 items:
7378 $ref: '#/components/schemas/VnfInstanceInfo'
7379 NstInfo:
7380 description: |
7381 NetSlice Template Information
7382 Only generic fields (_id, id, name) are described
7383 For a full specification of the NetSlice Template see:
7384 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7385 type: object
7386 properties:
7387 _id:
7388 description: NetSlice Template Identifier
7389 type: string
7390 format: uuid
7391 id:
7392 description: Human readable NetSlice Template Identifier
7393 type: string
7394 name:
7395 description: Human readable name of the NetSlice Template
7396 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007397 ArrayOfNstInfo:
7398 type: array
7399 items:
7400 $ref: '#/components/schemas/NstInfo'
7401 CreateNstInfoRequest:
7402 # A free list of key:value pairs
7403 type: object
7404 additionalProperties: true
7405 NetSliceTemplate:
7406 type: string
7407 format: yaml|json
7408 NetSlicePackage:
7409 type: string
7410 format: binary
7411 NstInfoModifications:
7412 description: |
7413 NetSlice Template Information
7414 Only generic fields (id, name) are described
7415 For a full specification of the NetSlice Template see:
7416 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7417 type: object
7418 properties:
7419 id:
7420 description: NST Identifier
7421 type: string
7422 name:
7423 description: NST Name
7424 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007425 NetSliceInstance:
7426 description: |
7427 NetSlice Instance Information
7428 Only generic fields (_id, id, name, description) are described
7429 For a full specification of the NetSlice Instance see:
7430 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7431 type: object
7432 properties:
7433 _id:
7434 description: Identifier of the NetSlice instance.
7435 type: string
7436 format: uuid
7437 id:
7438 description: Identifier of the NetSlice instance.
7439 type: string
7440 format: uuid
7441 name:
7442 description: Human readable name of the NetSlice instance.
7443 type: string
7444 description:
7445 description: Human readable description of the NetSlice instance.
7446 type: string
delacruzramfb52ade2019-10-07 16:46:59 +02007447 required:
7448 - _id
7449 - id
7450 - name
7451 ArrayOfNetSliceInstance:
7452 type: array
7453 items:
7454 $ref: '#/components/schemas/NetSliceInstance'
Atul Agarwal4cd9e952021-05-20 09:24:26 +00007455 Alarm:
7456 description: |
7457 Alarm Information
7458 type: object
7459 properties:
7460 _id:
7461 description: Identifier of the Alarm.
7462 type: string
7463 format: uuid
7464 id:
7465 description: Identifier of the Alarm.
7466 type: string
7467 format: uuid
7468 metric:
7469 description: Alarm metric.
7470 type: string
7471 threshold:
7472 description: Threshold value of the Alarm.
7473 type: number
7474 format: float
7475 operation:
7476 description: Operation to be applied.
7477 type: string
7478 action:
7479 description: Action to be taken.
7480 type: string
7481 status:
7482 description: Current status of the alarm.
7483 type: string
7484 required:
7485 - _id
7486 - id
7487 - metric
7488 - threshold
7489 - operation
7490 ArrayOfAlarm:
7491 type: array
7492 items:
7493 $ref: '#/components/schemas/Alarm'
delacruzramaf79f3c2019-10-22 13:13:01 +02007494 # CreateNsiRequest:
7495 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007496 InstantiateNsiRequest:
7497 type: object
7498 properties:
7499 nsiName:
7500 description: |
7501 Human-readable name of the NetSlice instance to be created.
7502 type: string
7503 nstId:
7504 description: |
7505 Identifier of the NST that defines the NetSlice instance to be created.
7506 type: string
7507 format: uuid
7508 vimAccountId:
7509 description: |
7510 Identifier of the VIM Account where the NetSlice instance shall be created.
7511 type: string
7512 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02007513 lcmOperationType:
7514 type: string
7515 netsliceInstanceId:
7516 type: string
7517 format: uuid
7518 nsiDescription:
7519 type: string
7520 nullable: true
7521 ssh_keys:
7522 type: string
7523 nsi_id:
7524 type: string
7525 format: uuid
7526 additionalParamsForNsi:
7527 type: object
7528 additionalProperties: true
7529 netslice-subnet:
7530 type: array
7531 items:
7532 type: object
7533 properties:
7534 id:
7535 type: string
7536 nsName:
7537 type: string
7538 nsdId:
7539 type: string
7540 format: uuid
7541 vimAccountId:
7542 type: string
7543 format: uuid
7544 lcmOperationType:
7545 type: string
7546 nsInstanceId:
7547 type: string
7548 format: uuid
7549 netsliceInstanceId:
7550 type: string
7551 format: uuid
7552 nsDescription:
7553 type: string
7554 nullable: true
7555 wimAccountId:
7556 oneOf:
7557 - type: string
7558 - type: boolean
7559 nullable: true
7560 additionalParamsForNs:
7561 type: object
7562 additionalProperties: true
tiernof2c14402020-04-24 13:55:01 +00007563 additionalParamsForVnf: *additionalparamsforvnf
delacruzramaf79f3c2019-10-22 13:13:01 +02007564 ssh_keys:
7565 type: array
7566 items:
7567 type: string
7568 nsr_id:
7569 type: string
7570 format: uuid
7571 vduImage:
7572 type: string
7573 vnf:
7574 type: array
7575 items:
7576 type: object
7577 properties:
7578 member-vnf-index:
7579 type: string
7580 vimAccountId:
7581 type: string
7582 format: uuid
7583 vdu:
7584 type: array
7585 items:
7586 type: object
7587 properties:
7588 id:
7589 type: string
7590 volume:
7591 type: array
7592 items:
7593 type: object
7594 properties:
7595 name:
7596 type: string
7597 vim-volume-id:
7598 type: string
7599 required:
7600 - name
7601 - vim-volume-id
7602 additionalProperties: false
7603 minItems: 1
7604 interface:
7605 type: array
7606 items:
7607 type: object
7608 properties:
7609 name:
7610 type: string
7611 ip-address:
7612 type: string
7613 format: ipv4
7614 mac-address:
7615 type: string
7616 format: mac_address
7617 floating-ip-required:
7618 type: boolean
7619 required:
7620 - name
7621 additionalProperties: false
7622 minItems: 1
7623 required:
7624 - id
7625 additionalProperties: false
7626 minItems: 1
7627 internal-vld:
7628 type: array
7629 items:
7630 type: object
7631 properties:
7632 name:
7633 type: string
7634 vim-network-name:
7635 type: string
7636 vim-network-id:
7637 type: string
7638 ip-profile:
7639 type: object
7640 properties:
7641 ip-version:
7642 type: string
7643 enum:
7644 - ipv4
7645 - ipv6
7646 subnet-address:
7647 type: string
7648 format: ip_prefix
7649 nullable: true
7650 gateway-address:
7651 type: string
7652 format: ipv4
7653 nullable: true
7654 dns-server:
7655 type: array
7656 items:
7657 type: object
7658 properties:
7659 address:
7660 type: string
7661 format: ipv4
7662 required:
7663 - address
7664 additionalProperties: false
7665 minItems: 1
7666 nullable: true
7667 dhcp-params:
7668 type: object
7669 properties:
7670 enabled:
7671 type: boolean
7672 count:
7673 type: integer
7674 minimum: 1
7675 start-address:
7676 type: string
7677 format: ipv4
7678 additionalProperties: false
7679 nullable: true
7680 additionalProperties: false
7681 provider-network:
7682 type: object
7683 properties:
7684 physical-network:
7685 type: string
7686 segmentation-id:
7687 type: string
7688 additionalProperties: false
7689 internal-connection-point:
7690 type: array
7691 items:
7692 type: object
7693 properties:
7694 id-ref:
7695 type: string
7696 ip-address:
7697 type: string
7698 format: ipv4
7699 required:
7700 - id-ref
7701 minProperties: 2
7702 additionalProperties: False
7703 minItems: 1
7704 required:
7705 - name
7706 minProperties: 2
7707 additionalProperties: false
7708 minItems: 1
7709 required:
7710 - member-vnf-index
7711 minProperties: 2
7712 additionalProperties: false
7713 minItems: 1
7714 vld:
7715 type: array
7716 items:
7717 type: object
7718 properties:
7719 name:
7720 type: string
7721 vim-network-name:
7722 oneOf:
7723 - type: string
7724 - type: object
7725 vim-network-id:
7726 oneOf:
7727 - type: string
7728 - type: object
7729 ns-net:
7730 type: object
7731 additionalProperties: true
7732 wimAccountId:
7733 oneOf:
7734 - type: string
7735 - type: boolean
7736 nullable: true
7737 ip-profile:
7738 type: object
7739 additionalProperties: true
7740 provider-network:
7741 type: object
7742 properties:
7743 physical-network:
7744 type: string
7745 segmentation-id:
7746 type: string
7747 additionalProperties: false
7748 vnfd-connection-point-ref:
7749 type: array
7750 items:
7751 type: object
7752 properties:
7753 member-vnf-index-ref:
7754 type: string
7755 vnfd-connection-point-ref:
7756 type: string
7757 ip-address:
7758 type: string
7759 format: ipv4
7760 required:
7761 - member-vnf-index-ref
7762 - vnfd-connection-point-ref
7763 minProperties: 3
7764 additionalProperties: false
7765 minItems: 1
7766 required:
7767 - name
7768 additionalProperties: false
7769 minItems: 1
7770 additionalProperties: false
7771 minItems: 1
7772 netslice-vld:
7773 type: array
7774 items:
7775 type: object
7776 properties:
7777 name:
7778 type: string
7779 vim-network-name:
7780 oneOf:
7781 - type: string
7782 - type: object
7783 vim-network-id:
7784 oneOf:
7785 - type: string
7786 - type: object
7787 ip-profile:
7788 type: object
7789 additionalProperties: true
7790 required:
7791 - name
7792 additionalProperties: false
7793 minItems: 1
delacruzramfb52ade2019-10-07 16:46:59 +02007794 required:
7795 - nsiName
7796 - nstId
7797 - vimAccountId
delacruzramaf79f3c2019-10-22 13:13:01 +02007798 additionalProperties: false
delacruzramfb52ade2019-10-07 16:46:59 +02007799 TerminateNsiRequest:
7800 type: object
7801 properties:
7802 terminationTime:
7803 description: |
7804 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7805 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7806 takes place immediately.
7807 type: string
7808 format: date-time
7809 NsiActionRequest:
7810 type: object
7811 properties:
7812 primitive:
7813 type: string
7814 primitive_params:
7815 $ref: '#/components/schemas/KeyValuePairs'
7816 lcmOperationType:
7817 type: string
7818 netsliceInstanceId:
7819 type: string
7820 format: uuid
7821 required:
7822 - primitive
7823 - primitive_params
delacruzramaf79f3c2019-10-22 13:13:01 +02007824 # CreateNsiContentRequest:
7825 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02007826 CreateNsiContentResponse:
7827 type: object
7828 properties:
7829 id:
7830 type: string
7831 format: uuid
7832 nsilcmop_id:
7833 type: string
7834 format: uuid
7835 NsiLcmOpOcc:
7836 type: object
7837 properties:
7838 _id:
7839 type: string
7840 format: uuid
7841 id:
7842 type: string
7843 format: uuid
7844 lcmOperationType:
7845 type: string
7846 netsliceInstanceId:
7847 type: string
7848 format: uuid
7849 isAutomaticInvocation:
7850 type: boolean
7851 isCancelPending:
7852 type: boolean
7853 startTime:
7854 type: number
7855 format: float
7856 statusEnteredTime:
7857 type: number
7858 format: float
7859 operationParams:
7860 type: object
7861 properties:
7862 nsiName:
7863 type: string
7864 nstId:
7865 type: string
7866 format: uuid
7867 vimAccountId:
7868 type: string
7869 format: uuid
7870 netsliceInstanceId:
7871 type: string
7872 format: uuid
7873 lcmOperationType:
7874 type: string
7875 nslcmops_ids:
7876 type: array
7877 items:
7878 type: string
7879 format: uuid
7880 operationState:
7881 type: string
7882 detailed-status:
7883 type: string
7884 links:
7885 type: object
7886 properties:
7887 self:
7888 type: string
7889 format: path # uri?
7890 netsliceInstanceId:
7891 type: string
7892 format: path # uri?
7893 ArrayOfNsiLcmOpOcc:
7894 type: array
7895 items:
7896 $ref: '#/components/schemas/NsiLcmOpOcc'
delacruzramaf79f3c2019-10-22 13:13:01 +02007897 TokenInfo:
7898 type: object
7899 properties:
7900 _id:
7901 type: string
7902 id:
7903 type: string
7904 admin:
7905 type: boolean
selvi.j9058fd92023-04-18 14:58:14 +00007906 admin_show:
7907 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +02007908 project_id:
7909 type: string
7910 format: uuid
7911 user_id:
7912 type: string
7913 format: uuid
7914 project_name:
7915 type: string
7916 username:
7917 type: string
7918 issued_at:
7919 type: number
7920 format: float
selvi.j9058fd92023-04-18 14:58:14 +00007921 user_show:
7922 type: boolean
7923 last_login:
7924 type: number
7925 format: float
7926 login_count:
7927 type: number
delacruzramaf79f3c2019-10-22 13:13:01 +02007928 expires:
7929 type: number
7930 format: float
7931 remote_host:
7932 type: string
7933 format: ipv4
7934 remote_port:
7935 type: integer
7936 roles:
7937 type: array
7938 items:
7939 type: object
7940 properties:
7941 id:
7942 type: string
7943 format: uuid
7944 name:
7945 type: string
selvi.ja6f638b2022-03-23 12:27:35 +00007946 PasswordExpiryInfo:
7947 type: object
7948 properties:
7949 id:
7950 type: string
7951 message:
7952 type: string
7953 user_id:
7954 type: string
7955 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02007956 ArrayOfTokenInfo:
7957 type: array
7958 items:
7959 $ref: '#/components/schemas/TokenInfo'
7960 CreateTokenRequest:
7961 type: object
7962 properties:
7963 username:
7964 type: string
7965 password:
7966 type: string
7967 project_id:
7968 type: string
7969 required:
7970 - username
7971 - password
7972 UserInfo:
7973 type: object
7974 properties:
7975 _id:
7976 type: string
7977 format: uuid
7978 username:
7979 type: string
7980 password:
7981 type: string
7982 project_role_mappings:
7983 type: array
7984 items:
7985 type: object
7986 properties:
7987 project:
7988 type: string
7989 format: uuid
7990 role:
7991 type: string
7992 format: uuid
7993 project_name:
7994 type: string
7995 role_name:
7996 type: string
7997 projects:
7998 type: array
7999 items:
8000 type: string
8001 ArrayOfUserInfo:
8002 type: array
8003 items:
8004 $ref: '#/components/schemas/UserInfo'
8005 ProjectRoleMappings:
8006 type: array
8007 items:
8008 type: object
8009 properties:
8010 project:
8011 type: string
8012 role:
8013 type: string
8014 required:
8015 - project
8016 - role
8017 additionalProperties: false
8018 ProjectRoleMappingsOpt:
8019 type: array
8020 items:
8021 type: object
8022 properties:
8023 project:
8024 type: string
8025 role:
8026 type: string
8027 required:
8028 - project
8029 additionalProperties: false
8030 CreateUserRequest:
8031 type: object
8032 properties:
8033 username:
8034 type: string
8035 password:
8036 type: string
8037 projects:
8038 type: array
8039 items:
8040 type: string
8041 project_role_mappings:
8042 $ref: '#/components/schemas/ProjectRoleMappings'
8043 required:
8044 - username
8045 - password
8046 additionalProperties: false
8047 ShortNameList:
8048 type: array
8049 items:
8050 type: string
8051 ArrayEditionSchema:
8052 type: object
8053 additionalProperties: true
8054 minProperties: 1
8055 description: |
8056 Array edition keys must start with '$'
8057 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
8058 EditUserRequest:
8059 type: object
8060 properties:
8061 username:
8062 type: string
8063 password:
8064 type: string
selvi.j9058fd92023-04-18 14:58:14 +00008065 old_password:
8066 type: string
8067 system_admin_id:
8068 type: string
8069 format: uuid
8070 unlock:
8071 type: boolean
8072 renew:
8073 type: boolean
delacruzramaf79f3c2019-10-22 13:13:01 +02008074 projects:
8075 oneOf:
8076 - $ref: '#/components/schemas/ShortNameList'
8077 - $ref: '#/components/schemas/ArrayEditionSchema'
8078 project_role_mappings:
8079 $ref: '#/components/schemas/ProjectRoleMappings'
8080 add_project_role_mappings:
8081 $ref: '#/components/schemas/ProjectRoleMappings'
8082 remove_project_role_mappings:
8083 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
8084 QuotasInfo:
8085 type: object
8086 properties:
8087 vnfds:
8088 type: integer
8089 minimum: 0
8090 nullable: false
8091 nsds:
8092 type: integer
8093 minimum: 0
8094 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008095 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +02008096 type: integer
8097 minimum: 0
8098 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008099 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +02008100 type: integer
8101 minimum: 0
8102 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008103 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008104 type: integer
8105 minimum: 0
8106 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008107 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008108 type: integer
8109 minimum: 0
8110 nullable: false
8111 vim_accounts:
8112 type: integer
8113 minimum: 0
8114 nullable: false
8115 wim_accounts:
8116 type: integer
8117 minimum: 0
8118 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008119 sdn_controllers:
8120 type: integer
8121 minimum: 0
8122 nullable: false
8123 k8sclusters:
8124 type: integer
8125 minimum: 0
8126 nullable: false
David Garciaaf38fce2021-05-04 12:48:04 +02008127 vca:
8128 type: integer
8129 minimum: 0
8130 nullable: false
tierno8bf88062020-06-02 11:45:11 +00008131 k8srepos:
8132 type: integer
8133 minimum: 0
8134 nullable: false
8135 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +02008136 type: integer
8137 minimum: 0
8138 nullable: false
8139 additionalProperties: false
8140 EditQuotasInfo:
8141 type: object
8142 properties:
8143 vnfds:
8144 type: integer
8145 minimum: 0
8146 nullable: true
8147 nsds:
8148 type: integer
8149 minimum: 0
8150 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008151 slice_templates:
delacruzramaf79f3c2019-10-22 13:13:01 +02008152 type: integer
8153 minimum: 0
8154 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008155 pduds:
delacruzramaf79f3c2019-10-22 13:13:01 +02008156 type: integer
8157 minimum: 0
8158 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008159 ns_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008160 type: integer
8161 minimum: 0
8162 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008163 slice_instances:
delacruzramaf79f3c2019-10-22 13:13:01 +02008164 type: integer
8165 minimum: 0
8166 nullable: true
8167 vim_accounts:
8168 type: integer
8169 minimum: 0
8170 nullable: true
8171 wim_accounts:
8172 type: integer
8173 minimum: 0
8174 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008175 sdn_controllers:
8176 type: integer
8177 minimum: 0
8178 nullable: true
8179 k8sclusters:
8180 type: integer
8181 minimum: 0
8182 nullable: true
David Garciaaf38fce2021-05-04 12:48:04 +02008183 vca:
8184 type: integer
8185 minimum: 0
8186 nullable: true
tierno8bf88062020-06-02 11:45:11 +00008187 k8srepos:
8188 type: integer
8189 minimum: 0
8190 nullable: true
8191 osmrepos:
delacruzramaf79f3c2019-10-22 13:13:01 +02008192 type: integer
8193 minimum: 0
8194 nullable: true
8195 additionalProperties: false
8196 ProjectInfo:
8197 type: object
8198 properties:
8199 _id:
8200 type: string
8201 format: uuid
8202 name:
8203 type: string
8204 quotas:
8205 $ref: '#/components/schemas/QuotasInfo'
8206 ArrayOfProjectInfo:
8207 type: array
8208 items:
8209 $ref: '#/components/schemas/ProjectInfo'
8210 CreateProjectRequest:
8211 type: object
8212 properties:
8213 name:
8214 type: string
8215 admin:
8216 type: boolean
8217 quotas:
8218 $ref: '#/components/schemas/QuotasInfo'
8219 required:
8220 - name
8221 additionalProperties: false
8222 EditProjectRequest:
8223 type: object
8224 properties:
8225 name:
8226 type: string
8227 admin:
8228 type: boolean
8229 quotas:
8230 $ref: '#/components/schemas/EditQuotasInfo'
8231 additionalProperties: false
8232 PermissionsInfo:
8233 type: object
8234 additionalProperties:
8235 type: boolean
8236 nullable: false
8237 description: |
8238 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8239 Permission values are either true or false
8240 EditPermissionsInfo:
8241 type: object
8242 additionalProperties:
8243 type: boolean
8244 nullable: true
8245 description: |
8246 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8247 Permission values are either true, false, or null
8248 RoleInfo:
8249 type: object
8250 properties:
8251 _id:
8252 type: string
8253 format: uuid
8254 name:
8255 type: string
8256 permissions:
8257 $ref: '#/components/schemas/PermissionsInfo'
8258 ArrayOfRoleInfo:
8259 type: array
8260 items:
8261 $ref: '#/components/schemas/RoleInfo'
8262 CreateRoleRequest:
8263 type: object
8264 properties:
8265 name:
8266 type: string
8267 permissions:
8268 $ref: '#/components/schemas/PermissionsInfo'
8269 required:
8270 - name
8271 additionalProperties: false
8272 EditRoleRequest:
8273 type: object
8274 properties:
8275 name:
8276 type: string
8277 permissions:
8278 $ref: '#/components/schemas/EditPermissionsInfo'
8279 additionalProperties: false
8280 VimType:
8281 type: string
8282 enum:
8283 - openvim
8284 - openstack
8285 - vmware
8286 - opennebula
8287 - aws
8288 - azure
8289 - fos
8290 VimInfo:
8291 type: object
8292 properties:
8293 _id:
8294 type: string
8295 format: uuid
8296 schema_version:
8297 type: string
8298 format: X.Y[.Z]
8299 schema_type:
8300 type: string
8301 name:
8302 type: string
8303 description:
8304 type: string
8305 vim:
8306 type: string
8307 datacenter:
8308 type: string
8309 vim_type:
8310 $ref: '#/components/schemas/VimType'
8311 vim_url:
8312 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008313 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008314 vim_tenant_name:
8315 type: string
8316 vim_user:
8317 type: string
8318 vim_password:
8319 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008320 vca:
8321 type: string
8322 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008323 config:
8324 type: object
8325 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +00008326 resources:
8327 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +02008328 ArrayOfVimInfo:
8329 type: array
8330 items:
8331 $ref: '#/components/schemas/VimInfo'
8332 CreateVimRequest:
8333 type: object
8334 properties:
8335 schema_version:
8336 type: string
8337 format: X.Y[.Z]
8338 schema_type:
8339 type: string
8340 name:
8341 type: string
8342 description:
8343 type: string
8344 vim:
8345 type: string
8346 datacenter:
8347 type: string
8348 vim_type:
8349 $ref: '#/components/schemas/VimType'
8350 vim_url:
8351 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008352 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008353 vim_tenant_name:
8354 type: string
8355 vim_user:
8356 type: string
8357 vim_password:
8358 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008359 vca:
8360 type: string
8361 format: uuid
delacruzramaf79f3c2019-10-22 13:13:01 +02008362 config:
8363 type: object
8364 additionalProperties: true
garciadeblas6229f2f2022-11-24 15:03:56 +01008365 prometheus-config:
8366 type: object
8367 additionalProperties: true
vijay.rd3f0fad2021-05-19 13:07:21 +00008368 resources:
8369 type: object
delacruzramaf79f3c2019-10-22 13:13:01 +02008370 required:
8371 - name
8372 - vim_url
8373 - vim_type
8374 - vim_user
8375 - vim_password
8376 - vim_tenant_name
8377 additionalProperties: false
8378 EditVimRequest:
8379 type: object
8380 properties:
8381 name:
8382 type: string
8383 description:
8384 type: string
8385 vim:
8386 type: string
8387 datacenter:
8388 type: string
8389 vim_type:
8390 $ref: '#/components/schemas/VimType'
8391 vim_url:
8392 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008393 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008394 vim_tenant_name:
8395 type: string
8396 vim_user:
8397 type: string
8398 vim_password:
8399 type: string
David Garciaaf38fce2021-05-04 12:48:04 +02008400 vca:
8401 type: string
8402 format: uuid
garciadeblas6229f2f2022-11-24 15:03:56 +01008403 prometheus-config:
8404 type: object
8405 additionalProperties: true
delacruzramaf79f3c2019-10-22 13:13:01 +02008406 config:
8407 type: object
8408 additionalProperties: true
8409 additionalProperties: false
8410 ObjectId_plus_OpId:
8411 type: object
8412 properties:
8413 id:
8414 type: string
8415 format: uuid
8416 op_id:
8417 type: string
8418 format: uuid
8419 OpId:
8420 type: object
8421 properties:
8422 op_id:
8423 type: string
8424 format: uuid
8425 WimType:
8426 type: string
8427 enum:
8428 - onos
8429 - odl
8430 - tapi
8431 - dynpac
8432 - fake
8433 WimInfo:
8434 type: object
8435 properties:
8436 _id:
8437 type: string
8438 format: uuid
8439 schema_version:
8440 type: string
8441 format: X.Y[.Z]
8442 schema_type:
8443 type: string
8444 name:
8445 type: string
8446 description:
8447 type: string
8448 wim:
8449 type: string
8450 wim_type:
8451 $ref: '#/components/schemas/WimType'
8452 wim_url:
8453 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008454 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008455 user:
8456 type: string
8457 password:
8458 type: string
8459 config:
8460 type: object
8461 additionalProperties: true
8462 ArrayOfWimInfo:
8463 type: array
8464 items:
8465 $ref: '#/components/schemas/WimInfo'
8466 CreateWimRequest:
8467 type: object
8468 properties:
8469 schema_version:
8470 type: string
8471 format: X.Y[.Z]
8472 schema_type:
8473 type: string
8474 name:
8475 type: string
8476 description:
8477 type: string
8478 wim:
8479 type: string
8480 wim_type:
8481 $ref: '#/components/schemas/WimType'
8482 wim_url:
8483 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008484 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008485 user:
8486 type: string
8487 password:
8488 type: string
8489 config:
8490 type: object
8491 additionalProperties: true
8492 required:
8493 - name
8494 - wim_url
8495 - wim_type
8496 additionalProperties: false
8497 EditWimRequest:
8498 type: object
8499 properties:
8500 name:
8501 type: string
8502 description:
8503 type: string
8504 wim:
8505 type: string
8506 wim_type:
8507 type: string
8508 wim_url:
8509 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008510 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008511 user:
8512 type: string
8513 password:
8514 type: string
8515 config:
8516 type: object
8517 additionalProperties: true
8518 additionalProperties: false
8519 SdnBasicProperties:
8520 type: object
8521 properties:
8522 name:
8523 type: string
8524 description:
8525 type: string
8526 dpid:
8527 type: string
8528 format: mac_address
8529 ip:
8530 type: string
8531 format: ipv4
8532 port:
8533 type: integer
8534 type:
8535 type: string
8536 enum:
8537 - floodlight
8538 - opendaylight
8539 - onos
8540 version:
8541 type: string
8542 user:
8543 type: string
8544 password:
8545 type: string
8546 SdnExtraProperties:
8547 type: object
8548 properties:
8549 _id:
8550 type: string
8551 format: uuid
8552 schema_version:
8553 type: string
8554 format: X.Y[.Z]
8555 SdnInfo:
8556 allOf:
8557 - $ref: '#/components/schemas/SdnExtraProperties'
8558 - $ref: '#/components/schemas/SdnBasicProperties'
8559 ArrayOfSdnInfo:
8560 type: array
8561 items:
8562 $ref: '#/components/schemas/SdnInfo'
8563 CreateSdnRequest:
8564 allOf:
8565 - $ref: '#/components/schemas/SdnBasicProperties'
8566 required:
8567 - name
8568 - type
8569 - ip
8570 - port
8571 - dpid
8572 additionalProperties: false
8573 EditSdnRequest:
8574 allOf:
8575 - $ref: '#/components/schemas/SdnBasicProperties'
8576 additionalProperties: false
8577 NsPmJobReportInfo:
8578 type: object
8579 properties:
8580 entries:
8581 type: array
8582 items:
8583 type: object
8584 properties:
8585 objectInstanceId:
8586 type: string
8587 format: uuid
8588 performanceMetric:
8589 type: string
8590 performanceValue:
8591 type: object
8592 properties:
8593 performanceValue:
8594 type: object
8595 properties:
8596 performanceValue:
8597 type: number
8598 vnfMemberIndex:
8599 type: string
8600 vduName:
8601 type: string
8602 timestamp:
8603 type: number
8604 PduInterfaces:
8605 type: array
8606 items:
8607 type: object
8608 properties:
8609 name:
8610 type: string
8611 mgmt:
8612 type: boolean
8613 type:
8614 type: string
8615 enum:
8616 - overlay
8617 - underlay
8618 ip-address:
8619 type: string
8620 format: ipv4
8621 mac-address:
8622 type: string
8623 format: mac_address
8624 vim-network-name:
8625 type: string
8626 vim-network-id:
8627 type: string
8628 required:
8629 - name
8630 - mgmt
8631 - ip-address
8632 additionalProperties: false
8633 PduInfo:
8634 type: object
8635 properties:
8636 _id:
8637 type: string
8638 format: uuid
8639 name:
8640 type: string
8641 type:
8642 type: string
8643 description:
8644 type: string
8645 shared:
8646 type: boolean
8647 vims:
8648 type: array
8649 items:
8650 type: string
8651 vim_accounts:
8652 type: array
8653 items:
8654 type: string
8655 interfaces:
8656 $ref: '#/components/schemas/PduInterfaces'
8657 ArrayOfPduInfo:
8658 type: array
8659 items:
8660 $ref: '#/components/schemas/PduInfo'
8661 CreatePduRequest:
8662 type: object
8663 properties:
8664 name:
8665 type: string
8666 type:
8667 type: string
8668 description:
8669 type: string
8670 shared:
8671 type: boolean
8672 vims:
8673 type: array
8674 items:
8675 type: string
8676 vim_accounts:
8677 type: array
8678 items:
8679 type: string
8680 interfaces:
8681 $ref: '#/components/schemas/PduInterfaces'
8682 required:
8683 - name
8684 - type
8685 - interfaces
8686 additionalProperties: false
8687 EditPduRequest:
8688 type: object
8689 properties:
8690 name:
8691 type: string
8692 type:
8693 type: string
8694 description:
8695 type: string
8696 shared:
8697 type: boolean
8698 vims:
8699 type: array
8700 items:
8701 type: string
8702 vim_accounts:
8703 type: array
8704 items:
8705 type: string
8706 interfaces:
8707 $ref: '#/components/schemas/PduInterfaces'
8708 additionalProperties: false
8709 K8sClusterNetList:
8710 type: array
8711 items:
8712 type: object
Gabriel Cubab77d0df2022-03-22 14:43:11 -05008713 additionalProperties: false
8714 K8sClusterDeploymentMethods:
8715 type: object
8716 properties:
Gabriel Cubab77d0df2022-03-22 14:43:11 -05008717 juju-bundle:
8718 type: boolean
8719 helm-chart-v3:
8720 type: boolean
8721 additionalProperties: false
8722 minProperties: 3
delacruzramaf79f3c2019-10-22 13:13:01 +02008723 K8sClusterInfo:
8724 type: object
8725 properties:
8726 _id:
8727 type: string
8728 format: uuid
8729 schema_version:
8730 type: string
8731 format: X.Y[.Z]
8732 schema_type:
8733 type: string
8734 name:
8735 type: string
8736 description:
8737 type: string
8738 credentials:
8739 type: object
8740 additionalProperties: true
8741 vim_account:
8742 type: string
8743 format: uuid
8744 k8s_version:
8745 type: string
8746 nets:
8747 $ref: '#/components/schemas/K8sClusterNetList'
Gabriel Cubab77d0df2022-03-22 14:43:11 -05008748 deployment_methods:
8749 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
delacruzramaf79f3c2019-10-22 13:13:01 +02008750 namespace:
8751 type: string
8752 cni:
8753 type: array
8754 items:
8755 type: string
8756 ArrayOfK8sClusterInfo:
8757 type: array
8758 items:
8759 $ref: '#/components/schemas/K8sClusterInfo'
8760 CreateK8sClusterRequest:
8761 type: object
8762 properties:
8763 schema_version:
8764 type: string
8765 format: X.Y[.Z]
8766 schema_type:
8767 type: string
8768 name:
8769 type: string
8770 description:
8771 type: string
8772 credentials:
8773 type: object
8774 additionalProperties: true
8775 vim_account:
8776 type: string
8777 format: uuid
8778 k8s_version:
8779 type: string
8780 nets:
8781 $ref: '#/components/schemas/K8sClusterNetList'
8782 namespace:
8783 type: string
8784 cni:
8785 type: array
8786 items:
8787 type: string
8788 required:
8789 - name
8790 - credentials
8791 - vim_account
8792 - k8s_version
8793 - nets
8794 additionalProperties: false
8795 EditK8sClusterRequest:
8796 type: object
8797 properties:
8798 name:
8799 type: string
8800 description:
8801 type: string
8802 credentials:
8803 type: object
8804 additionalProperties: true
8805 vim_account:
8806 type: string
8807 format: uuid
8808 k8s_version:
8809 type: string
8810 nets:
8811 $ref: '#/components/schemas/K8sClusterNetList'
8812 namespace:
8813 type: string
8814 cni:
8815 type: array
8816 items:
8817 type: string
8818 additionalProperties: false
David Garciaaf38fce2021-05-04 12:48:04 +02008819 VcaInfo:
8820 type: object
8821 properties:
8822 _id:
8823 type: string
8824 format: uuid
8825 schema_version:
8826 type: string
8827 format: X.Y[.Z]
8828 schema_type:
8829 type: string
8830 name:
8831 type: string
8832 description:
8833 type: string
8834 endpoints:
8835 type: string
8836 user:
8837 type: string
8838 secret:
8839 type: string
8840 cacert:
8841 type: string
8842 lxd-cloud:
8843 type: string
8844 lxd-credentials:
8845 type: string
8846 k8s-cloud:
8847 type: string
8848 k8s-credentials:
8849 type: string
8850 model-config:
8851 type: object
8852 additionalProperties: true
8853 ArrayOfVcaInfo:
8854 type: array
8855 items:
8856 $ref: '#/components/schemas/VcaInfo'
8857 CreateVcaRequest:
8858 type: object
8859 properties:
8860 schema_version:
8861 type: string
8862 format: X.Y[.Z]
8863 schema_type:
8864 type: string
8865 name:
8866 type: string
8867 description:
8868 type: string
8869 endpoints:
8870 type: string
8871 user:
8872 type: string
8873 secret:
8874 type: string
8875 cacert:
8876 type: string
8877 lxd-cloud:
8878 type: string
8879 lxd-credentials:
8880 type: string
8881 k8s-cloud:
8882 type: string
8883 k8s-credentials:
8884 type: string
8885 model-config:
8886 type: object
8887 additionalProperties: true
8888 required:
8889 - name
8890 - endpoints
8891 - user
8892 - secret
8893 - cacert
8894 - lxd-cloud
8895 - lxd-credentials
8896 - k8s-cloud
8897 - k8s-credentials
8898 additionalProperties: false
8899 EditVcaRequest:
8900 type: object
8901 properties:
8902 name:
8903 type: string
8904 description:
8905 type: string
8906 endpoints:
8907 type: string
8908 user:
8909 type: string
8910 secret:
8911 type: string
8912 cacert:
8913 type: string
8914 lxd-cloud:
8915 type: string
8916 lxd-credentials:
8917 type: string
8918 k8s-cloud:
8919 type: string
8920 k8s-credentials:
8921 type: string
8922 model-config:
8923 type: object
8924 additionalProperties: true
8925 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02008926 K8sRepoType:
8927 type: string
8928 enum:
8929 - chart
8930 - bundle
8931 K8sRepoInfo:
8932 type: object
8933 properties:
8934 _id:
8935 type: string
8936 format: uuid
8937 name:
8938 type: string
8939 description:
8940 type: string
8941 type:
8942 $ref: '#/components/schemas/K8sRepoType'
8943 url:
8944 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008945 format: uri
garciadeblas8bb3cce2022-02-11 00:41:18 +01008946 username:
8947 type: string
8948 description: repository username
8949 password:
8950 type: string
8951 description: repository password
8952 ca-file:
8953 type: string
8954 description: verify certificates of HTTPS-enabled servers using this CA bundle
8955 cert-file:
8956 type: string
8957 description: identify HTTPS client using this SSL certificate file
8958 skip-tls-verify:
8959 type: boolean
8960 description: skip tls certificate checks for the repository
8961 key-file:
8962 type: string
8963 description: identify HTTPS client using this SSL key file
garciadeblas0881dcf2023-10-20 12:00:08 +02008964 oci:
8965 type: boolean
8966 default: false
8967 description: >
8968 Flag to indicate whether or not it is an OCI-enabled repo (default: false)
8969 required:
8970 - name
8971 - type
8972 - url
8973 additionalProperties: false
delacruzramaf79f3c2019-10-22 13:13:01 +02008974 ArrayOfK8sRepoInfo:
8975 type: array
8976 items:
8977 $ref: '#/components/schemas/K8sRepoInfo'
8978 CreateK8sRepoRequest:
8979 type: object
8980 properties:
8981 name:
8982 type: string
8983 description:
8984 type: string
8985 type:
8986 $ref: '#/components/schemas/K8sRepoType'
8987 url:
8988 type: string
garciadeblas00c2eb92020-02-28 15:24:27 +01008989 format: uri
delacruzramaf79f3c2019-10-22 13:13:01 +02008990 required:
8991 - name
8992 - type
8993 - url
8994 additionalProperties: false
preethika.p31b3a802020-07-28 09:14:01 +00008995 NslcmSubscriptionResponse:
8996 type: object
8997 properties:
8998 id:
8999 type: string
9000 format: uuid
9001 filter:
9002 type: object
9003 CallbackUri:
9004 type: string
9005 format: uri
9006 _links:
9007 type: object
9008 NslcmSubscriptionInfo:
9009 type: object
9010 properties:
9011 _id:
9012 type: string
9013 format: uuid
9014 _admin:
9015 type: object
9016 schema_version:
9017 type: string
9018 format: 'X.Y[.Z]'
9019 CallbackUri:
9020 type: string
9021 format: uri
9022 filter:
9023 type: object
9024 authentication:
9025 $ref: '#/components/schemas/Authenticationschema'
9026 ArrayOfNslcmSubscriptionInfo:
9027 type: array
9028 items:
9029 $ref: '#/components/schemas/NslcmSubscriptionInfo'
9030 NsInstanceSubscriptionFilter:
9031 description: |
9032 used to identify the network service
9033 type: object
9034 oneOf:
9035 - $ref: '#/components/schemas/nsdIds'
9036 - $ref: '#/components/schemas/vnfdIds'
9037 - $ref: '#/components/schemas/pnfdIds'
9038 - $ref: '#/components/schemas/nsInstanceIds'
9039 - $ref: '#/components/schemas/nsInstanceNames'
9040 nsdIds:
9041 type: array
9042 items:
9043 type: string
9044 vnfdIds:
9045 type: array
9046 items:
9047 type: string
9048 pnfdIds:
9049 type: array
9050 items:
9051 type: string
9052 nsInstanceIds:
9053 type: array
9054 items:
9055 type: string
9056 nsInstanceNames:
9057 type: array
9058 items:
9059 type: string
9060 Nslcmsubschema:
9061 type: object
9062 properties:
9063 nsInstanceSubscriptionFilter:
9064 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
9065 notificationTypes:
9066 description: |
9067 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
9068 type: array
9069 items:
9070 type: string
9071 enum:
9072 - NsIdentifierCreationNotification
9073 - NsIdentifierDeletionNotification
9074 - NsLcmOperationOccurrenceNotification
9075 - NsChangeNotification
9076 operationTypes:
9077 type: array
9078 items:
9079 type: string
9080 enum:
9081 - INSTANTIATE
9082 - SCALE
9083 - TERMINATE
9084 - UPDATE
9085 - HEAL
9086 operationStates:
9087 type: array
9088 items:
9089 type: string
9090 enum:
9091 - PROCESSING
9092 - COMPLETED
9093 - PARTIALLY_COMPLETED
9094 - FAILED
9095 - FAILED_TEMP
9096 - ROLLING_BACK
9097 - ROLLED_BACK
9098 nsComponentTypes:
9099 type: array
9100 items:
9101 type: string
9102 enum:
9103 - VNF
9104 - NS
9105 - PNF
9106 lcmOpNameImpactingNsComponent:
9107 type: array
9108 items:
9109 type: string
9110 enum:
9111 - VNF_INSTANTIATE
9112 - VNF_SCALE
9113 - VNF_SCALE_TO_LEVEL
9114 - VNF_CHANGE_FLAVOUR
9115 - VNF_TERMINATE
9116 - VNF_HEAL
9117 - VNF_OPERATE
9118 - VNF_CHANGE_EXT_CONN
9119 - VNF_MODIFY_INFO
9120 - NS_INSTANTIATE
9121 - NS_SCALE
9122 - NS_UPDATE
9123 - NS_TERMINATE
9124 - NS_HEAL
9125 lcmOpOccStatusImpactingNsComponent:
9126 type: array
9127 items:
9128 type: string
9129 enum:
9130 - START
9131 - COMPLETED
9132 - PARTIALLY_COMPLETED
9133 - FAILED
9134 - ROLLED_BACK
9135 Authenticationschema:
9136 type: object
9137 properties:
9138 authType:
9139 type: string
9140 enum:
9141 - basic
9142 paramsBasic:
9143 type: object
9144 properties:
9145 userName:
9146 type: string
9147 password:
9148 type: string
9149 NslcmSubscriptionRequest:
9150 type: object
9151 properties:
9152 filter:
9153 $ref: '#/components/schemas/Nslcmsubschema'
9154 CallbackUri:
9155 type: string
9156 format: uri
9157 authentication:
9158 $ref: '#/components/schemas/Authenticationschema'
9159 required:
9160 - CallbackUri
Gabriel Cuba2c8be082023-11-14 16:52:01 -05009161 CancelNSLCMOpOccRequest:
9162 type: object
9163 properties:
9164 cancelMode:
9165 type: string
9166 enum:
9167 - GRACEFUL
9168 - FORCEFUL
delacruzramfb52ade2019-10-07 16:46:59 +02009169 # END SCHEMAS
9170
garciadeblas60e2ee92018-02-27 19:09:51 +01009171 requestBodies:
9172 CreateNsdInfoRequest:
9173 content:
9174 application/json:
9175 schema:
9176 $ref: '#/components/schemas/CreateNsdInfoRequest'
9177 application/yaml:
9178 schema:
9179 $ref: '#/components/schemas/CreateNsdInfoRequest'
9180 NsdInfoModifications:
9181 content:
9182 application/json:
9183 schema:
9184 $ref: '#/components/schemas/NsdInfoModifications'
9185 application/yaml:
9186 schema:
9187 $ref: '#/components/schemas/NsdInfoModifications'
Atul Agarwal4cd9e952021-05-20 09:24:26 +00009188 AlarmInfoModifications:
9189 content:
9190 application/json:
9191 schema:
9192 $ref: '#/components/schemas/AlarmInfoModifications'
9193 application/yaml:
9194 schema:
9195 $ref: '#/components/schemas/AlarmInfoModifications'
delacruzramfb52ade2019-10-07 16:46:59 +02009196 NsDescriptor:
garciadeblas60e2ee92018-02-27 19:09:51 +01009197 content:
9198 text/plain:
9199 schema:
9200 $ref: '#/components/schemas/NsDescriptor'
delacruzramfb52ade2019-10-07 16:46:59 +02009201 NsPackage:
9202 content:
garciadeblas60e2ee92018-02-27 19:09:51 +01009203 application/zip:
9204 schema:
9205 $ref: '#/components/schemas/NsPackage'
garciadeblas63fe88c2018-02-28 19:32:41 +01009206 CreateVnfPkgInfoRequest:
9207 content:
9208 application/json:
9209 schema:
9210 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9211 application/yaml:
9212 schema:
9213 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9214 VnfPkgInfoModifications:
9215 content:
9216 application/json:
9217 schema:
9218 $ref: '#/components/schemas/VnfPkgInfoModifications'
9219 application/yaml:
9220 schema:
9221 $ref: '#/components/schemas/VnfPkgInfoModifications'
9222 VnfPackage:
9223 content:
9224 application/zip:
9225 schema:
9226 $ref: '#/components/schemas/VnfPackage'
delacruzramfb52ade2019-10-07 16:46:59 +02009227 VnfDescriptor:
garciadeblas63fe88c2018-02-28 19:32:41 +01009228 content:
delacruzramfb52ade2019-10-07 16:46:59 +02009229 text/plain:
garciadeblas63fe88c2018-02-28 19:32:41 +01009230 schema:
delacruzramfb52ade2019-10-07 16:46:59 +02009231 $ref: '#/components/schemas/VnfDescriptor'
delacruzramaf79f3c2019-10-22 13:13:01 +02009232 # CreateNsRequest:
9233 # Substituted by InstantiateNsRequest
garciadeblas12fcc4b2018-03-02 16:12:02 +01009234 InstantiateNsRequest:
9235 content:
9236 application/json:
9237 schema:
9238 $ref: '#/components/schemas/InstantiateNsRequest'
9239 application/yaml:
9240 schema:
9241 $ref: '#/components/schemas/InstantiateNsRequest'
garciadeblasb5a065f2022-02-11 00:27:47 +01009242 HealNsRequest:
9243 content:
9244 application/json:
9245 schema:
9246 $ref: '#/components/schemas/HealNsRequest'
9247 application/yaml:
9248 schema:
9249 $ref: '#/components/schemas/HealNsRequest'
elumalai4b120f12022-04-28 16:44:35 +05309250 NSinstanceMigrateRequest:
9251 content:
9252 application/json:
9253 schema:
9254 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9255 application/yaml:
9256 schema:
9257 $ref: '#/components/schemas/NSinstanceMigrateRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01009258 ScaleNsRequest:
9259 content:
9260 application/json:
9261 schema:
9262 $ref: '#/components/schemas/ScaleNsRequest'
9263 application/yaml:
9264 schema:
9265 $ref: '#/components/schemas/ScaleNsRequest'
garciadeblas12fcc4b2018-03-02 16:12:02 +01009266 TerminateNsRequest:
9267 content:
9268 application/json:
9269 schema:
9270 $ref: '#/components/schemas/TerminateNsRequest'
9271 application/yaml:
9272 schema:
9273 $ref: '#/components/schemas/TerminateNsRequest'
elumalaif2eb5e72022-03-21 19:44:39 +05309274 UpdateNsRequest:
9275 content:
9276 application/json:
9277 schema:
9278 $ref: '#/components/schemas/UpdateNsRequest'
9279 application/yaml:
9280 schema:
9281 $ref: '#/components/schemas/UpdateNsRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009282 # CreateNSinstanceContentRequest:
9283 # Substituted by InstantiateNsRequest
delacruzramfb52ade2019-10-07 16:46:59 +02009284 CreateNstInfoRequest:
9285 content:
9286 application/json:
9287 schema:
9288 $ref: '#/components/schemas/CreateNstInfoRequest'
9289 application/yaml:
9290 schema:
9291 $ref: '#/components/schemas/CreateNstInfoRequest'
9292 NetSliceTemplate:
9293 content:
9294 text/plain:
9295 schema:
9296 $ref: '#/components/schemas/NetSliceTemplate'
9297 NetSlicePackage:
9298 content:
9299 application/zip:
9300 schema:
9301 $ref: '#/components/schemas/NetSlicePackage'
9302 NstInfoModifications:
9303 content:
9304 application/json:
9305 schema:
9306 $ref: '#/components/schemas/NstInfoModifications'
9307 application/yaml:
9308 schema:
9309 $ref: '#/components/schemas/NstInfoModifications'
delacruzramaf79f3c2019-10-22 13:13:01 +02009310 # CreateNsiRequest:
9311 # Substituted by InstantiateNsiRequest
delacruzramfb52ade2019-10-07 16:46:59 +02009312 InstantiateNsiRequest:
9313 content:
9314 application/json:
9315 schema:
9316 $ref: '#/components/schemas/InstantiateNsiRequest'
9317 application/yaml:
9318 schema:
9319 $ref: '#/components/schemas/InstantiateNsiRequest'
9320 TerminateNsiRequest:
9321 content:
9322 application/json:
9323 schema:
9324 $ref: '#/components/schemas/TerminateNsiRequest'
9325 application/yaml:
9326 schema:
9327 $ref: '#/components/schemas/TerminateNsiRequest'
9328 NsiActionRequest:
9329 content:
9330 application/json:
9331 schema:
9332 $ref: '#/components/schemas/NsiActionRequest'
9333 application/yaml:
9334 schema:
9335 $ref: '#/components/schemas/NsiActionRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009336 # CreateNsiContentRequest:
9337 # Substituted by InstantiateNsiRequest
9338 CreateTokenRequest:
delacruzramfb52ade2019-10-07 16:46:59 +02009339 content:
9340 application/json:
9341 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02009342 $ref: '#/components/schemas/CreateTokenRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02009343 application/yaml:
9344 schema:
delacruzramaf79f3c2019-10-22 13:13:01 +02009345 $ref: '#/components/schemas/CreateTokenRequest'
9346 CreateUserRequest:
9347 content:
9348 application/json:
9349 schema:
9350 $ref: '#/components/schemas/CreateUserRequest'
9351 application/yaml:
9352 schema:
9353 $ref: '#/components/schemas/CreateUserRequest'
9354 EditUserRequest:
9355 content:
9356 application/json:
9357 schema:
9358 $ref: '#/components/schemas/EditUserRequest'
9359 application/yaml:
9360 schema:
9361 $ref: '#/components/schemas/EditUserRequest'
9362 CreateProjectRequest:
9363 content:
9364 application/json:
9365 schema:
9366 $ref: '#/components/schemas/CreateProjectRequest'
9367 application/yaml:
9368 schema:
9369 $ref: '#/components/schemas/CreateProjectRequest'
9370 EditProjectRequest:
9371 content:
9372 application/json:
9373 schema:
9374 $ref: '#/components/schemas/EditProjectRequest'
9375 application/yaml:
9376 schema:
9377 $ref: '#/components/schemas/EditProjectRequest'
9378 CreateRoleRequest:
9379 content:
9380 application/json:
9381 schema:
9382 $ref: '#/components/schemas/CreateRoleRequest'
9383 application/yaml:
9384 schema:
9385 $ref: '#/components/schemas/CreateRoleRequest'
9386 EditRoleRequest:
9387 content:
9388 application/json:
9389 schema:
9390 $ref: '#/components/schemas/EditRoleRequest'
9391 application/yaml:
9392 schema:
9393 $ref: '#/components/schemas/EditRoleRequest'
9394 CreateVimRequest:
9395 content:
9396 application/json:
9397 schema:
9398 $ref: '#/components/schemas/CreateVimRequest'
9399 application/yaml:
9400 schema:
9401 $ref: '#/components/schemas/CreateVimRequest'
9402 EditVimRequest:
9403 content:
9404 application/json:
9405 schema:
9406 $ref: '#/components/schemas/EditVimRequest'
9407 application/yaml:
9408 schema:
9409 $ref: '#/components/schemas/EditVimRequest'
9410 CreateWimRequest:
9411 content:
9412 application/json:
9413 schema:
9414 $ref: '#/components/schemas/CreateWimRequest'
9415 application/yaml:
9416 schema:
9417 $ref: '#/components/schemas/CreateWimRequest'
9418 EditWimRequest:
9419 content:
9420 application/json:
9421 schema:
9422 $ref: '#/components/schemas/EditWimRequest'
9423 application/yaml:
9424 schema:
9425 $ref: '#/components/schemas/EditWimRequest'
9426 CreateSdnRequest:
9427 content:
9428 application/json:
9429 schema:
9430 $ref: '#/components/schemas/CreateSdnRequest'
9431 application/yaml:
9432 schema:
9433 $ref: '#/components/schemas/CreateSdnRequest'
9434 EditSdnRequest:
9435 content:
9436 application/json:
9437 schema:
9438 $ref: '#/components/schemas/EditSdnRequest'
9439 application/yaml:
9440 schema:
9441 $ref: '#/components/schemas/EditSdnRequest'
9442 CreatePduRequest:
9443 content:
9444 application/json:
9445 schema:
9446 $ref: '#/components/schemas/CreatePduRequest'
9447 application/yaml:
9448 schema:
9449 $ref: '#/components/schemas/CreatePduRequest'
9450 EditPduRequest:
9451 content:
9452 application/json:
9453 schema:
9454 $ref: '#/components/schemas/EditPduRequest'
9455 application/yaml:
9456 schema:
9457 $ref: '#/components/schemas/EditPduRequest'
9458 CreateK8sClusterRequest:
9459 content:
9460 application/json:
9461 schema:
9462 $ref: '#/components/schemas/CreateK8sClusterRequest'
9463 application/yaml:
9464 schema:
9465 $ref: '#/components/schemas/CreateK8sClusterRequest'
9466 EditK8sClusterRequest:
9467 content:
9468 application/json:
9469 schema:
9470 $ref: '#/components/schemas/EditK8sClusterRequest'
9471 application/yaml:
9472 schema:
9473 $ref: '#/components/schemas/EditK8sClusterRequest'
David Garciaaf38fce2021-05-04 12:48:04 +02009474 CreateVcaRequest:
9475 content:
9476 application/json:
9477 schema:
9478 $ref: '#/components/schemas/CreateVcaRequest'
9479 application/yaml:
9480 schema:
9481 $ref: '#/components/schemas/CreateVcaRequest'
9482 EditVcaRequest:
9483 content:
9484 application/json:
9485 schema:
9486 $ref: '#/components/schemas/EditVcaRequest'
9487 application/yaml:
9488 schema:
9489 $ref: '#/components/schemas/EditVcaRequest'
delacruzramaf79f3c2019-10-22 13:13:01 +02009490 CreateK8sRepoRequest:
9491 content:
9492 application/json:
9493 schema:
9494 $ref: '#/components/schemas/CreateK8sRepoRequest'
9495 application/yaml:
9496 schema:
9497 $ref: '#/components/schemas/CreateK8sRepoRequest'
preethika.p31b3a802020-07-28 09:14:01 +00009498 NslcmSubscriptionRequest:
9499 content:
9500 application/json:
9501 schema:
9502 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9503 application/yaml:
9504 schema:
9505 $ref: '#/components/schemas/NslcmSubscriptionRequest'
Gabriel Cuba2c8be082023-11-14 16:52:01 -05009506 CancelNSLCMOpOccRequest:
9507 content:
9508 application/json:
9509 schema:
9510 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
9511 application/yaml:
9512 schema:
9513 $ref: '#/components/schemas/CancelNSLCMOpOccRequest'
delacruzramfb52ade2019-10-07 16:46:59 +02009514 # END REQUEST BODIES
9515
garciadeblas60e2ee92018-02-27 19:09:51 +01009516 securitySchemes:
9517 bearerAuth:
9518 type: http
9519 scheme: bearer