5 "title": "123 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/operations/nodes/node=123/yang-ext:mount/action-types:list={name}/list-action": {
30 "description": "list-action_input",
34 "$ref": "#/components/schemas/action-types_list-action_input"
41 "$ref": "#/components/schemas/action-types_list-action_input",
51 "description": "RPC list-action success",
55 "$ref": "#/components/schemas/action-types_list-action_output"
60 "$ref": "#/components/schemas/action-types_list-action_output"
67 "summary": "POST - 123 - action-types - list-action"
70 "/rests/operations/nodes/node=123/yang-ext:mount/action-types:container/container-action": {
77 "description": "container-action_input",
81 "$ref": "#/components/schemas/action-types_container-action_input"
88 "$ref": "#/components/schemas/action-types_container-action_input",
98 "description": "RPC container-action success",
102 "$ref": "#/components/schemas/action-types_container-action_output"
105 "application/json": {
107 "$ref": "#/components/schemas/action-types_container-action_output"
114 "summary": "POST - 123 - action-types - container-action"
117 "/rests/data/nodes/node=123/yang-ext:mount/action-types:list={name}": {
147 "description": "200",
151 "$ref": "#/components/schemas/action-types_list"
154 "application/json": {
160 "$ref": "#/components/schemas/action-types_list",
171 "summary": "GET - 123 - action-types - list"
188 "description": "list",
192 "$ref": "#/components/schemas/action-types_list"
195 "application/json": {
198 "action-types:list": {
201 "$ref": "#/components/schemas/action-types_list",
212 "description": "Updated"
215 "description": "Created"
219 "summary": "PUT - action-types - 123 - list"
237 "description": "Deleted"
241 "summary": "DELETE - 123 - action-types - list"
258 "description": "list",
260 "application/yang-data+json": {
263 "action-types:list": {
266 "$ref": "#/components/schemas/action-types_list",
273 "application/yang-data+xml": {
275 "$ref": "#/components/schemas/action-types_list"
285 "description": "Updated"
289 "summary": "PATCH - action-types - 123 - list"
292 "/rests/data/nodes/node=123/yang-ext:mount/operational:root": {
314 "description": "200",
318 "$ref": "#/components/schemas/operational_root"
321 "application/json": {
325 "$ref": "#/components/schemas/operational_root",
335 "summary": "GET - 123 - operational - root"
343 "description": "root",
347 "$ref": "#/components/schemas/operational_root"
350 "application/json": {
353 "operational:root": {
354 "$ref": "#/components/schemas/operational_root",
364 "description": "Updated"
367 "description": "Created"
371 "summary": "PUT - operational - 123 - root"
379 "description": "root",
383 "$ref": "#/components/schemas/operational_root"
386 "application/json": {
388 "$ref": "#/components/schemas/operational_root"
395 "description": "Created"
398 "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",
399 "summary": "POST - 123 - operational - root"
408 "description": "Deleted"
412 "summary": "DELETE - 123 - operational - root"
420 "description": "root",
422 "application/yang-data+json": {
425 "operational:root": {
426 "$ref": "#/components/schemas/operational_root",
432 "application/yang-data+xml": {
434 "$ref": "#/components/schemas/operational_root"
444 "description": "Updated"
448 "summary": "PATCH - operational - 123 - root"
451 "/rests/data/nodes/node=123/yang-ext:mount/operational:root/oper-container/config-container": {
473 "description": "200",
477 "$ref": "#/components/schemas/operational_root_oper-container_config-container"
480 "application/json": {
483 "config-container": {
484 "$ref": "#/components/schemas/operational_root_oper-container_config-container",
494 "summary": "GET - 123 - operational - config-container"
497 "/rests/data/nodes/node=123/yang-ext:mount/operational:root/oper-container/oper-container-list={oper-container-list-leaf}": {
504 "name": "oper-container-list-leaf",
527 "description": "200",
531 "$ref": "#/components/schemas/operational_root_oper-container_oper-container-list"
534 "application/json": {
537 "oper-container-list": {
540 "$ref": "#/components/schemas/operational_root_oper-container_oper-container-list",
551 "summary": "GET - 123 - operational - oper-container-list"
554 "/rests/data/nodes/node=123/yang-ext:mount/action-types:multi-container": {
576 "description": "200",
580 "$ref": "#/components/schemas/action-types_multi-container"
583 "application/json": {
587 "$ref": "#/components/schemas/action-types_multi-container",
597 "summary": "GET - 123 - action-types - multi-container"
605 "description": "multi-container",
609 "$ref": "#/components/schemas/action-types_multi-container"
612 "application/json": {
615 "action-types:multi-container": {
616 "$ref": "#/components/schemas/action-types_multi-container",
626 "description": "Updated"
629 "description": "Created"
633 "summary": "PUT - action-types - 123 - multi-container"
641 "description": "inner-container",
645 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
648 "application/json": {
652 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
662 "description": "Created"
665 "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",
666 "summary": "POST - 123 - action-types - multi-container"
675 "description": "Deleted"
679 "summary": "DELETE - 123 - action-types - multi-container"
687 "description": "multi-container",
689 "application/yang-data+json": {
692 "action-types:multi-container": {
693 "$ref": "#/components/schemas/action-types_multi-container",
699 "application/yang-data+xml": {
701 "$ref": "#/components/schemas/action-types_multi-container"
711 "description": "Updated"
715 "summary": "PATCH - action-types - 123 - multi-container"
718 "/rests/data/nodes/node=123/yang-ext:mount/action-types:multi-container/inner-container": {
740 "description": "200",
744 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
747 "application/json": {
751 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
761 "summary": "GET - 123 - action-types - inner-container"
769 "description": "inner-container",
773 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
776 "application/json": {
779 "action-types:inner-container": {
780 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
790 "description": "Updated"
793 "description": "Created"
797 "summary": "PUT - action-types - 123 - inner-container"
806 "description": "Deleted"
810 "summary": "DELETE - 123 - action-types - inner-container"
818 "description": "inner-container",
820 "application/yang-data+json": {
823 "action-types:inner-container": {
824 "$ref": "#/components/schemas/action-types_multi-container_inner-container",
830 "application/yang-data+xml": {
832 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
842 "description": "Updated"
846 "summary": "PATCH - action-types - 123 - inner-container"
849 "/rests/operations/nodes/node=123/yang-ext:mount": {
859 "description": "Queries the available operations (RPC calls) on the mounted hosted.",
860 "summary": "GET - 123 - datastore - operations"
863 "/rests/data/nodes/node=123/yang-ext:mount/operational:root/oper-container": {
885 "description": "200",
889 "$ref": "#/components/schemas/operational_root_oper-container"
892 "application/json": {
896 "$ref": "#/components/schemas/operational_root_oper-container",
906 "summary": "GET - 123 - operational - oper-container"
909 "/rests/data/nodes/node=123/yang-ext:mount/action-types:container": {
931 "description": "200",
935 "$ref": "#/components/schemas/action-types_container"
938 "application/json": {
942 "$ref": "#/components/schemas/action-types_container",
952 "summary": "GET - 123 - action-types - container"
960 "description": "container",
964 "$ref": "#/components/schemas/action-types_container"
967 "application/json": {
970 "action-types:container": {
971 "$ref": "#/components/schemas/action-types_container",
981 "description": "Updated"
984 "description": "Created"
988 "summary": "PUT - action-types - 123 - container"
997 "description": "Deleted"
1001 "summary": "DELETE - 123 - action-types - container"
1009 "description": "container",
1011 "application/yang-data+json": {
1014 "action-types:container": {
1015 "$ref": "#/components/schemas/action-types_container",
1021 "application/yang-data+xml": {
1023 "$ref": "#/components/schemas/action-types_container"
1033 "description": "Updated"
1037 "summary": "PATCH - action-types - 123 - container"
1040 "/rests/operations/nodes/node=123/yang-ext:mount/action-types:multi-container/inner-container/action": {
1047 "description": "action_input",
1049 "application/xml": {
1053 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1058 "application/json": {
1072 "description": "RPC action success"
1076 "summary": "POST - 123 - action-types - action"
1079 "/rests/data/nodes/node=123/yang-ext:mount/operational:root/config-container/config-container-oper-list={oper-container-list-leaf}": {
1086 "name": "oper-container-list-leaf",
1109 "description": "200",
1111 "application/xml": {
1113 "$ref": "#/components/schemas/operational_root_config-container_config-container-oper-list"
1116 "application/json": {
1119 "config-container-oper-list": {
1122 "$ref": "#/components/schemas/operational_root_config-container_config-container-oper-list",
1133 "summary": "GET - 123 - operational - config-container-oper-list"
1136 "/rests/data/nodes/node=123/yang-ext:mount/operational:root/config-container": {
1158 "description": "200",
1160 "application/xml": {
1162 "$ref": "#/components/schemas/operational_root_config-container"
1165 "application/json": {
1168 "config-container": {
1169 "$ref": "#/components/schemas/operational_root_config-container",
1179 "summary": "GET - 123 - operational - config-container"
1187 "description": "config-container",
1189 "application/xml": {
1191 "$ref": "#/components/schemas/operational_root_config-container"
1194 "application/json": {
1197 "operational:config-container": {
1198 "$ref": "#/components/schemas/operational_root_config-container",
1208 "description": "Updated"
1211 "description": "Created"
1215 "summary": "PUT - operational - 123 - config-container"
1223 "description": "config-container",
1225 "application/xml": {
1227 "$ref": "#/components/schemas/operational_root_config-container"
1230 "application/json": {
1232 "$ref": "#/components/schemas/operational_root_config-container"
1239 "description": "Created"
1242 "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",
1243 "summary": "POST - 123 - operational - config-container"
1252 "description": "Deleted"
1256 "summary": "DELETE - 123 - operational - config-container"
1264 "description": "config-container",
1266 "application/yang-data+json": {
1269 "operational:config-container": {
1270 "$ref": "#/components/schemas/operational_root_config-container",
1276 "application/yang-data+xml": {
1278 "$ref": "#/components/schemas/operational_root_config-container"
1288 "description": "Updated"
1292 "summary": "PATCH - operational - 123 - config-container"
1295 "/rests/data/nodes/node=123/yang-ext:mount": {
1305 "description": "Queries the config (startup) datastore on the mounted hosted.",
1306 "summary": "GET - 123 - datastore - data"
1312 "action-types_multi-container": {
1314 "inner-container": {
1315 "$ref": "#/components/schemas/action-types_multi-container_inner-container"
1319 "name": "multi-container",
1320 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1323 "title": "action-types_multi-container",
1326 "operational_root_config-container": {
1328 "leaf-second-case": {
1331 "example": "Some leaf-second-case"
1333 "config-container-config-leaf": {
1336 "example": "Some config-container-config-leaf"
1340 "name": "config-container",
1341 "namespace": "urn:opendaylight:oper"
1344 "title": "operational_root_config-container",
1347 "operational_root": {
1352 "example": "Some leaf-config"
1354 "config-container": {
1355 "$ref": "#/components/schemas/operational_root_config-container"
1360 "namespace": "urn:opendaylight:oper"
1363 "title": "operational_root",
1366 "action-types_container-action_input": {
1374 "example": "Some ca-input"
1379 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1381 "title": "action-types_container-action_input",
1384 "operational_root_oper-container_config-container": {
1386 "config-container-config-leaf"
1389 "config-container-config-leaf": {
1392 "example": "Some config-container-config-leaf"
1394 "opconfig-container-oper-leaf": {
1397 "example": "Some opconfig-container-oper-leaf"
1401 "name": "config-container",
1402 "namespace": "urn:opendaylight:oper"
1405 "title": "operational_root_oper-container_config-container",
1408 "operational_root_oper-container": {
1413 "oper-container-list": {
1417 "$ref": "#/components/schemas/operational_root_oper-container_oper-container-list"
1420 "oper-container-config-leaf-list": {
1425 "example": "Some oper-container-config-leaf-list"
1428 "config-container": {
1429 "$ref": "#/components/schemas/operational_root_oper-container_config-container"
1431 "oper-leaf-first-case": {
1434 "example": "Some oper-leaf-first-case"
1436 "leaf-first-case": {
1439 "example": "Some leaf-first-case"
1443 "name": "oper-container",
1444 "namespace": "urn:opendaylight:oper"
1447 "title": "operational_root_oper-container",
1450 "action-types_multi-container_inner-container": {
1453 "name": "inner-container",
1454 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1457 "title": "action-types_multi-container_inner-container",
1460 "operational_root_config-container_config-container-oper-list": {
1462 "oper-container-list-leaf": {
1465 "example": "Some oper-container-list-leaf"
1469 "name": "config-container-oper-list",
1470 "namespace": "urn:opendaylight:oper"
1473 "title": "operational_root_config-container_config-container-oper-list",
1476 "action-types_container-action_output": {
1484 "example": "Some ca-output"
1489 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1491 "title": "action-types_container-action_output",
1494 "action-types_list-action_input": {
1502 "example": "Some la-input"
1507 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1509 "title": "action-types_list-action_input",
1512 "action-types_container": {
1515 "name": "container",
1516 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1519 "title": "action-types_container",
1522 "action-types_list-action_output": {
1530 "example": "Some la-output"
1535 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1537 "title": "action-types_list-action_output",
1540 "operational_root_oper-container_oper-container-list": {
1542 "oper-container-list-leaf": {
1545 "example": "Some oper-container-list-leaf"
1549 "name": "oper-container-list",
1550 "namespace": "urn:opendaylight:oper"
1553 "title": "operational_root_oper-container_oper-container-list",
1556 "action-types_list": {
1561 "example": "Some name"
1566 "namespace": "urn:ietf:params:xml:ns:yang:test:action:types"
1569 "title": "action-types_list",
1573 "securitySchemes": {