{ "openapi": "3.0.3", "info": { "version": "1.0.0", "title": "recursive", "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." }, "servers": [ { "url": "http://localhost:8181/" } ], "paths": { "/rests/data/nodes/node=123/yang-ext:mount/recursive:container-root/root-list={name}/nested-list={name1}": { "get": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "schema": { "enum": [ "config", "nonconfig", "all" ], "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list" } }, "application/json": { "schema": { "properties": { "nested-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list", "type": "object" } } } } } } } }, "description": "", "summary": "GET - 123 - recursive - nested-list" }, "put": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "nested-list", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list" } }, "application/json": { "schema": { "properties": { "recursive:nested-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list", "type": "object" } } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - recursive - 123 - nested-list" }, "delete": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - recursive - nested-list" }, "patch": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "nested-list", "content": { "application/yang-data+json": { "schema": { "properties": { "recursive:nested-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list", "type": "object" } } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - recursive - 123 - nested-list" } }, "/rests/data/nodes/node=123/yang-ext:mount/recursive:container-root": { "get": { "tags": [ "123 recursive" ], "parameters": [ { "name": "content", "in": "query", "required": false, "schema": { "enum": [ "config", "nonconfig", "all" ], "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root" } }, "application/json": { "schema": { "properties": { "container-root": { "$ref": "#/components/schemas/recursive_container-root", "type": "object" } } } } } } }, "description": "", "summary": "GET - 123 - recursive - container-root" }, "put": { "tags": [ "123 recursive" ], "parameters": [], "requestBody": { "description": "container-root", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root" } }, "application/json": { "schema": { "properties": { "recursive:container-root": { "$ref": "#/components/schemas/recursive_container-root", "type": "object" } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - recursive - 123 - container-root" }, "post": { "tags": [ "123 recursive" ], "parameters": [], "requestBody": { "description": "root-list", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list" } }, "application/json": { "schema": { "properties": { "root-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list", "type": "object" } } } } } } }, "responses": { "201": { "description": "Created" } }, "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", "summary": "POST - 123 - recursive - container-root" }, "delete": { "tags": [ "123 recursive" ], "parameters": [], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - recursive - container-root" }, "patch": { "tags": [ "123 recursive" ], "parameters": [], "requestBody": { "description": "container-root", "content": { "application/yang-data+json": { "schema": { "properties": { "recursive:container-root": { "$ref": "#/components/schemas/recursive_container-root", "type": "object" } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - recursive - 123 - container-root" } }, "/rests/data/nodes/node=123/yang-ext:mount/recursive:container-root/root-list={name}": { "get": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "schema": { "enum": [ "config", "nonconfig", "all" ], "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list" } }, "application/json": { "schema": { "properties": { "root-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list", "type": "object" } } } } } } } }, "description": "", "summary": "GET - 123 - recursive - root-list" }, "put": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "root-list", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list" } }, "application/json": { "schema": { "properties": { "recursive:root-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list", "type": "object" } } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - recursive - 123 - root-list" }, "delete": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - recursive - root-list" }, "patch": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "root-list", "content": { "application/yang-data+json": { "schema": { "properties": { "recursive:root-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list", "type": "object" } } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - recursive - 123 - root-list" } }, "/rests/data/nodes/node=123/yang-ext:mount/recursive:container-root/root-list={name}/nested-list={name1}/super-nested-list={name2}": { "get": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "schema": { "enum": [ "config", "nonconfig", "all" ], "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list" } }, "application/json": { "schema": { "properties": { "super-nested-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list", "type": "object" } } } } } } } }, "description": "", "summary": "GET - 123 - recursive - super-nested-list" }, "put": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name2", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "super-nested-list", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list" } }, "application/json": { "schema": { "properties": { "recursive:super-nested-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list", "type": "object" } } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - recursive - 123 - super-nested-list" }, "delete": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name2", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - recursive - super-nested-list" }, "patch": { "tags": [ "123 recursive" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name2", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "super-nested-list", "content": { "application/yang-data+json": { "schema": { "properties": { "recursive:super-nested-list": { "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list", "type": "object" } } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - recursive - 123 - super-nested-list" } }, "/rests/data/nodes/node=123/yang-ext:mount": { "post": { "tags": [ "123 recursive" ], "parameters": [], "requestBody": { "description": "container-root", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/recursive_container-root" } }, "application/json": { "schema": { "properties": { "container-root": { "$ref": "#/components/schemas/recursive_container-root", "type": "object" } } } } } }, "responses": { "201": { "description": "Created" } }, "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", "summary": "POST - 123 - recursive - recursive" } } }, "components": { "schemas": { "recursive_container-root_root-list": { "properties": { "nested-list": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list" } }, "name": { "description": "", "type": "string", "example": "Some name" } }, "xml": { "name": "root-list", "namespace": "urn:opendaylight:test:recursive" }, "description": "", "title": "recursive_container-root_root-list", "type": "object" }, "recursive_container-root_root-list_nested-list": { "properties": { "super-nested-list": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list_nested-list_super-nested-list" } }, "name": { "description": "", "type": "string", "example": "Some name" } }, "xml": { "name": "nested-list", "namespace": "urn:opendaylight:test:recursive" }, "description": "", "title": "recursive_container-root_root-list_nested-list", "type": "object" }, "recursive_container-root_root-list_nested-list_super-nested-list": { "properties": { "name": { "description": "", "type": "string", "example": "Some name" } }, "xml": { "name": "super-nested-list", "namespace": "urn:opendaylight:test:recursive" }, "description": "", "title": "recursive_container-root_root-list_nested-list_super-nested-list", "type": "object" }, "recursive_container-root": { "properties": { "root-list": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/recursive_container-root_root-list" } } }, "xml": { "name": "container-root", "namespace": "urn:opendaylight:test:recursive" }, "description": "", "title": "recursive_container-root", "type": "object" } }, "securitySchemes": { "basicAuth": { "scheme": "basic", "type": "http" } } }, "security": [ { "basicAuth": [] } ] }