5 "title": "Controller modules of RESTCONF",
6 "description": "We are providing full API for configurational data which can be edited (by POST, PUT, PATCH and DELETE).\nFor operational data we only provide GET API.\n\nFor majority of request you can see only config data in examples. That is because we can show only one example\nper request. The exception when you can see operational data in example is when data are representing\noperational (config false) container with no config data in it."
10 "url": "http://localhost:8181/"
14 "/rests/data/action-types:multi-container/inner-container": {
17 "Controller action-types"
40 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
47 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
57 "summary": "GET - Controller - action-types - inner-container"
61 "Controller action-types"
65 "description": "inner-container",
69 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
75 "action-types:inner-container": {
76 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
86 "description": "Created"
89 "description": "Updated"
93 "summary": "PUT - action-types - Controller - inner-container"
97 "Controller action-types"
102 "description": "Deleted"
106 "summary": "DELETE - Controller - action-types - inner-container"
110 "Controller action-types"
114 "description": "inner-container",
116 "application/yang-data+json": {
119 "action-types:inner-container": {
120 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
126 "application/yang-data+xml": {
128 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
135 "description": "Updated"
142 "summary": "PATCH - action-types - Controller - inner-container"
145 "/rests/operations/action-types:container/container-action": {
148 "Controller action-types"
152 "description": "container-action_input",
156 "$ref": "#/components/schemas/action-types_container-action_input"
159 "application/json": {
163 "$ref": "#/components/schemas/action-types_container-action_input",
173 "description": "RPC container-action success",
177 "$ref": "#/components/schemas/action-types_container-action_output"
180 "application/json": {
182 "$ref": "#/components/schemas/action-types_container-action_output"
189 "summary": "POST - Controller - action-types - container-action"
192 "/rests/data/operational:root/config-container": {
195 "Controller operational"
214 "description": "200",
218 "$ref": "#/components/schemas/operational_root_config-container"
221 "application/json": {
224 "config-container": {
225 "$ref": "#/components/schemas/operational_root_config-container",
235 "summary": "GET - Controller - operational - config-container"
239 "Controller operational"
243 "description": "config-container",
247 "$ref": "#/components/schemas/operational_root_config-container"
250 "application/json": {
253 "operational:config-container": {
254 "$ref": "#/components/schemas/operational_root_config-container",
264 "description": "Created"
267 "description": "Updated"
271 "summary": "PUT - operational - Controller - config-container"
275 "Controller operational"
279 "description": "config-container",
283 "$ref": "#/components/schemas/operational_root_config-container"
286 "application/json": {
288 "$ref": "#/components/schemas/operational_root_config-container"
295 "description": "Created"
298 "description": "\n\nNote:\nIn example payload, you can see only the first data node child of the resource to be created, following the\nguidelines of RFC 8040, which allows us to create only one resource in POST request.\n",
299 "summary": "POST - Controller - operational - config-container"
303 "Controller operational"
308 "description": "Deleted"
312 "summary": "DELETE - Controller - operational - config-container"
316 "Controller operational"
320 "description": "config-container",
322 "application/yang-data+json": {
325 "operational:config-container": {
326 "$ref": "#/components/schemas/operational_root_config-container",
332 "application/yang-data+xml": {
334 "$ref": "#/components/schemas/operational_root_config-container"
341 "description": "Updated"
348 "summary": "PATCH - operational - Controller - config-container"
351 "/rests/data/operational:root/config-container/config-container-oper-list={oper-container-list-leaf}": {
354 "Controller operational"
358 "name": "oper-container-list-leaf",
381 "description": "200",
385 "$ref": "#/components/schemas/operational_root_config-container_config-container-oper-list"
388 "application/json": {
391 "config-container-oper-list": {
394 "$ref": "#/components/schemas/operational_root_config-container_config-container-oper-list",
405 "summary": "GET - Controller - operational - config-container-oper-list"
408 "/rests/data/action-types:multi-container": {
411 "Controller action-types"
430 "description": "200",
434 "$ref": "#/components/schemas/action-types_multi-container"
437 "application/json": {
441 "$ref": "#/components/schemas/action-types_multi-container",
451 "summary": "GET - Controller - action-types - multi-container"
455 "Controller action-types"
459 "description": "multi-container",
463 "$ref": "#/components/schemas/action-types_multi-container"
466 "application/json": {
469 "action-types:multi-container": {
470 "$ref": "#/components/schemas/action-types_multi-container",
480 "description": "Created"
483 "description": "Updated"
487 "summary": "PUT - action-types - Controller - multi-container"
491 "Controller action-types"
495 "description": "inner-container",
499 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
502 "application/json": {
506 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
516 "description": "Created"
519 "description": "\n\nNote:\nIn example payload, you can see only the first data node child of the resource to be created, following the\nguidelines of RFC 8040, which allows us to create only one resource in POST request.\n",
520 "summary": "POST - Controller - action-types - multi-container"
524 "Controller action-types"
529 "description": "Deleted"
533 "summary": "DELETE - Controller - action-types - multi-container"
537 "Controller action-types"
541 "description": "multi-container",
543 "application/yang-data+json": {
546 "action-types:multi-container": {
547 "$ref": "#/components/schemas/action-types_multi-container",
553 "application/yang-data+xml": {
555 "$ref": "#/components/schemas/action-types_multi-container"
562 "description": "Updated"
569 "summary": "PATCH - action-types - Controller - multi-container"
572 "/rests/data/operational:root": {
575 "Controller operational"
594 "description": "200",
598 "$ref": "#/components/schemas/operational_root"
601 "application/json": {
605 "$ref": "#/components/schemas/operational_root",
615 "summary": "GET - Controller - operational - root"
619 "Controller operational"
623 "description": "root",
627 "$ref": "#/components/schemas/operational_root"
630 "application/json": {
633 "operational:root": {
634 "$ref": "#/components/schemas/operational_root",
644 "description": "Created"
647 "description": "Updated"
651 "summary": "PUT - operational - Controller - root"
655 "Controller operational"
659 "description": "root",
663 "$ref": "#/components/schemas/operational_root"
666 "application/json": {
668 "$ref": "#/components/schemas/operational_root"
675 "description": "Created"
678 "description": "\n\nNote:\nIn example payload, you can see only the first data node child of the resource to be created, following the\nguidelines of RFC 8040, which allows us to create only one resource in POST request.\n",
679 "summary": "POST - Controller - operational - root"
683 "Controller operational"
688 "description": "Deleted"
692 "summary": "DELETE - Controller - operational - root"
696 "Controller operational"
700 "description": "root",
702 "application/yang-data+json": {
705 "operational:root": {
706 "$ref": "#/components/schemas/operational_root",
712 "application/yang-data+xml": {
714 "$ref": "#/components/schemas/operational_root"
721 "description": "Updated"
728 "summary": "PATCH - operational - Controller - root"
731 "/rests/operations/action-types:list={name}/list-action": {
734 "Controller action-types"
747 "description": "list-action_input",
751 "$ref": "#/components/schemas/action-types_list-action_input"
754 "application/json": {
758 "$ref": "#/components/schemas/action-types_list-action_input",
768 "description": "RPC list-action success",
772 "$ref": "#/components/schemas/action-types_list-action_output"
775 "application/json": {
777 "$ref": "#/components/schemas/action-types_list-action_output"
784 "summary": "POST - Controller - action-types - list-action"
787 "/rests/data/operational:root/oper-container/config-container": {
790 "Controller operational"
809 "description": "200",
813 "$ref": "#/components/schemas/operational_root_oper-container_config-container"
816 "application/json": {
819 "config-container": {
820 "$ref": "#/components/schemas/operational_root_oper-container_config-container",
830 "summary": "GET - Controller - operational - config-container"
833 "/rests/operations/action-types:multi-container/inner-container/action": {
836 "Controller action-types"
840 "description": "action_input",
846 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
851 "application/json": {
865 "description": "RPC action success"
869 "summary": "POST - Controller - action-types - action"
872 "/rests/data/operational:root/oper-container/oper-container-list={oper-container-list-leaf}": {
875 "Controller operational"
879 "name": "oper-container-list-leaf",
902 "description": "200",
906 "$ref": "#/components/schemas/operational_root_oper-container_oper-container-list"
909 "application/json": {
912 "oper-container-list": {
915 "$ref": "#/components/schemas/operational_root_oper-container_oper-container-list",
926 "summary": "GET - Controller - operational - oper-container-list"
929 "/rests/data/operational:root/oper-container": {
932 "Controller operational"
951 "description": "200",
955 "$ref": "#/components/schemas/operational_root_oper-container"
958 "application/json": {
962 "$ref": "#/components/schemas/operational_root_oper-container",
972 "summary": "GET - Controller - operational - oper-container"
975 "/rests/data/action-types:list={name}": {
978 "Controller action-types"
1005 "description": "200",
1007 "application/xml": {
1009 "$ref": "#/components/schemas/action-types_list"
1012 "application/json": {
1018 "$ref": "#/components/schemas/action-types_list",
1029 "summary": "GET - Controller - action-types - list"
1033 "Controller action-types"
1046 "description": "list",
1048 "application/xml": {
1050 "$ref": "#/components/schemas/action-types_list"
1053 "application/json": {
1056 "action-types:list": {
1059 "$ref": "#/components/schemas/action-types_list",
1070 "description": "Created"
1073 "description": "Updated"
1077 "summary": "PUT - action-types - Controller - list"
1081 "Controller action-types"
1095 "description": "Deleted"
1099 "summary": "DELETE - Controller - action-types - list"
1103 "Controller action-types"
1116 "description": "list",
1118 "application/yang-data+json": {
1121 "action-types:list": {
1124 "$ref": "#/components/schemas/action-types_list",
1131 "application/yang-data+xml": {
1133 "$ref": "#/components/schemas/action-types_list"
1140 "description": "Updated"
1147 "summary": "PATCH - action-types - Controller - list"
1150 "/rests/data/action-types:container": {
1153 "Controller action-types"
1172 "description": "200",
1174 "application/xml": {
1176 "$ref": "#/components/schemas/action-types_container"
1179 "application/json": {
1183 "$ref": "#/components/schemas/action-types_container",
1193 "summary": "GET - Controller - action-types - container"
1197 "Controller action-types"
1201 "description": "container",
1203 "application/xml": {
1205 "$ref": "#/components/schemas/action-types_container"
1208 "application/json": {
1211 "action-types:container": {
1212 "$ref": "#/components/schemas/action-types_container",
1222 "description": "Created"
1225 "description": "Updated"
1229 "summary": "PUT - action-types - Controller - container"
1233 "Controller action-types"
1238 "description": "Deleted"
1242 "summary": "DELETE - Controller - action-types - container"
1246 "Controller action-types"
1250 "description": "container",
1252 "application/yang-data+json": {
1255 "action-types:container": {
1256 "$ref": "#/components/schemas/action-types_container",
1262 "application/yang-data+xml": {
1264 "$ref": "#/components/schemas/action-types_container"
1271 "description": "Updated"
1278 "summary": "PATCH - action-types - Controller - container"
1284 "action-types_multi-container": {
1286 "inner-container": {
1287 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
1291 "name": "multi-container",
1292 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1295 "title": "action-types_multi-container",
1298 "operational_root_config-container": {
1300 "config-container-config-leaf": {
1303 "example": "Some config-container-config-leaf"
1305 "leaf-second-case": {
1308 "example": "Some leaf-second-case"
1312 "name": "config-container",
1313 "namespace": "urn:opendaylight:oper"
1316 "title": "operational_root_config-container",
1319 "operational_root": {
1324 "example": "Some leaf-config"
1326 "config-container": {
1327 "$ref": "#/components/schemas/operational_root_config-container"
1332 "namespace": "urn:opendaylight:oper"
1335 "title": "operational_root",
1338 "action-types_container-action_input": {
1346 "example": "Some ca-input"
1351 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1353 "title": "action-types_container-action_input",
1356 "operational_root_oper-container_config-container": {
1358 "config-container-config-leaf"
1361 "opconfig-container-oper-leaf": {
1364 "example": "Some opconfig-container-oper-leaf"
1366 "config-container-config-leaf": {
1369 "example": "Some config-container-config-leaf"
1373 "name": "config-container",
1374 "namespace": "urn:opendaylight:oper"
1377 "title": "operational_root_oper-container_config-container",
1380 "operational_root_oper-container": {
1385 "config-container": {
1386 "$ref": "#/components/schemas/operational_root_oper-container_config-container"
1388 "oper-container-config-leaf-list": {
1393 "example": "Some oper-container-config-leaf-list"
1396 "oper-container-list": {
1400 "$ref": "#/components/schemas/operational_root_oper-container_oper-container-list"
1403 "leaf-first-case": {
1406 "example": "Some leaf-first-case"
1408 "oper-leaf-first-case": {
1411 "example": "Some oper-leaf-first-case"
1415 "name": "oper-container",
1416 "namespace": "urn:opendaylight:oper"
1419 "title": "operational_root_oper-container",
1422 "action-types_multi-container_inner-container": {
1425 "name": "inner-container",
1426 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1429 "title": "action-types_multi-container_inner-container",
1432 "operational_root_config-container_config-container-oper-list": {
1434 "oper-container-list-leaf": {
1437 "example": "Some oper-container-list-leaf"
1441 "name": "config-container-oper-list",
1442 "namespace": "urn:opendaylight:oper"
1445 "title": "operational_root_config-container_config-container-oper-list",
1448 "action-types_container-action_output": {
1456 "example": "Some ca-output"
1461 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1463 "title": "action-types_container-action_output",
1466 "action-types_list-action_input": {
1474 "example": "Some la-input"
1479 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1481 "title": "action-types_list-action_input",
1484 "action-types_container": {
1487 "name": "container",
1488 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1491 "title": "action-types_container",
1494 "action-types_list-action_output": {
1502 "example": "Some la-output"
1507 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1509 "title": "action-types_list-action_output",
1512 "operational_root_oper-container_oper-container-list": {
1514 "oper-container-list-leaf": {
1517 "example": "Some oper-container-list-leaf"
1521 "name": "oper-container-list",
1522 "namespace": "urn:opendaylight:oper"
1525 "title": "operational_root_oper-container_oper-container-list",
1528 "action-types_list": {
1533 "example": "Some name"
1538 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1541 "title": "action-types_list",
1545 "securitySchemes": {