{ "openapi": "3.0.3", "info": { "version": "1.0.0", "title": "action-types", "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's 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/operations/nodes/node=123/yang-ext:mount/action-types:list={name}/list-action": { "post": { "tags": [ "123 action-types" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "list-action_input", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_list_list-action_input" } }, "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/action-types_list_list-action_input", "type": "object" } } } } } }, "responses": { "200": { "description": "RPC list-action success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_list_list-action_output" } }, "application/json": { "schema": { "$ref": "#/components/schemas/action-types_list_list-action_output" } } } } }, "description": "", "summary": "POST - 123 - action-types - list-action" } }, "/rests/operations/nodes/node=123/yang-ext:mount/action-types:container/container-action": { "post": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "container-action_input", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_container_container-action_input" } }, "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/action-types_container_container-action_input", "type": "object" } } } } } }, "responses": { "200": { "description": "RPC container-action success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_container_container-action_output" } }, "application/json": { "schema": { "$ref": "#/components/schemas/action-types_container_container-action_output" } } } } }, "description": "", "summary": "POST - 123 - action-types - container-action" } }, "/rests/data/nodes/node=123/yang-ext:mount/action-types:list={name}": { "get": { "tags": [ "123 action-types" ], "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/action-types_list" } }, "application/json": { "schema": { "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/action-types_list", "type": "object" } } } } } } } }, "description": "", "summary": "GET - 123 - action-types - list" }, "put": { "tags": [ "123 action-types" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "list", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_list" } }, "application/json": { "schema": { "properties": { "action-types:list": { "type": "array", "items": { "$ref": "#/components/schemas/action-types_list", "type": "object" } } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - action-types - 123 - list" }, "delete": { "tags": [ "123 action-types" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - action-types - list" }, "patch": { "tags": [ "123 action-types" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "list", "content": { "application/yang-data+json": { "schema": { "properties": { "action-types:list": { "type": "array", "items": { "$ref": "#/components/schemas/action-types_list", "type": "object" } } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/action-types_list" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - action-types - 123 - list" } }, "/rests/data/nodes/node=123/yang-ext:mount/action-types:container": { "get": { "tags": [ "123 action-types" ], "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/action-types_container" } }, "application/json": { "schema": { "properties": { "container": { "$ref": "#/components/schemas/action-types_container", "type": "object" } } } } } } }, "description": "", "summary": "GET - 123 - action-types - container" }, "put": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "container", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_container" } }, "application/json": { "schema": { "properties": { "action-types:container": { "$ref": "#/components/schemas/action-types_container", "type": "object" } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - action-types - 123 - container" }, "delete": { "tags": [ "123 action-types" ], "parameters": [], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - action-types - container" }, "patch": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "container", "content": { "application/yang-data+json": { "schema": { "properties": { "action-types:container": { "$ref": "#/components/schemas/action-types_container", "type": "object" } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/action-types_container" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - action-types - 123 - container" } }, "/rests/data/nodes/node=123/yang-ext:mount/action-types:multi-container": { "get": { "tags": [ "123 action-types" ], "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/action-types_multi-container" } }, "application/json": { "schema": { "properties": { "multi-container": { "$ref": "#/components/schemas/action-types_multi-container", "type": "object" } } } } } } }, "description": "", "summary": "GET - 123 - action-types - multi-container" }, "put": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "multi-container", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_multi-container" } }, "application/json": { "schema": { "properties": { "action-types:multi-container": { "$ref": "#/components/schemas/action-types_multi-container", "type": "object" } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - action-types - 123 - multi-container" }, "post": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "inner-container", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_multi-container_inner-container" } }, "application/json": { "schema": { "properties": { "inner-container": { "$ref": "#/components/schemas/action-types_multi-container_inner-container", "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 - action-types - multi-container" }, "delete": { "tags": [ "123 action-types" ], "parameters": [], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - action-types - multi-container" }, "patch": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "multi-container", "content": { "application/yang-data+json": { "schema": { "properties": { "action-types:multi-container": { "$ref": "#/components/schemas/action-types_multi-container", "type": "object" } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/action-types_multi-container" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - action-types - 123 - multi-container" } }, "/rests/operations/nodes/node=123/yang-ext:mount/action-types:multi-container/inner-container/action": { "post": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "action_input", "content": { "application/xml": { "schema": { "xml": { "name": "input", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "type": "object" } }, "application/json": { "schema": { "properties": { "input": { "type": "object" } }, "type": "object" } } } }, "responses": { "204": { "description": "RPC action success" } }, "description": "", "summary": "POST - 123 - action-types - action" } }, "/rests/data/nodes/node=123/yang-ext:mount": { "post": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "list", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_list" } }, "application/json": { "schema": { "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/action-types_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 - action-types - action-types" } }, "/rests/data/nodes/node=123/yang-ext:mount/action-types:multi-container/inner-container": { "get": { "tags": [ "123 action-types" ], "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/action-types_multi-container_inner-container" } }, "application/json": { "schema": { "properties": { "inner-container": { "$ref": "#/components/schemas/action-types_multi-container_inner-container", "type": "object" } } } } } } }, "description": "", "summary": "GET - 123 - action-types - inner-container" }, "put": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "inner-container", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/action-types_multi-container_inner-container" } }, "application/json": { "schema": { "properties": { "action-types:inner-container": { "$ref": "#/components/schemas/action-types_multi-container_inner-container", "type": "object" } } } } } }, "responses": { "204": { "description": "Updated" }, "201": { "description": "Created" } }, "description": "", "summary": "PUT - action-types - 123 - inner-container" }, "delete": { "tags": [ "123 action-types" ], "parameters": [], "responses": { "204": { "description": "Deleted" } }, "description": "", "summary": "DELETE - 123 - action-types - inner-container" }, "patch": { "tags": [ "123 action-types" ], "parameters": [], "requestBody": { "description": "inner-container", "content": { "application/yang-data+json": { "schema": { "properties": { "action-types:inner-container": { "$ref": "#/components/schemas/action-types_multi-container_inner-container", "type": "object" } } } }, "application/yang-data+xml": { "schema": { "$ref": "#/components/schemas/action-types_multi-container_inner-container" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "Updated" } }, "description": "", "summary": "PATCH - action-types - 123 - inner-container" } } }, "components": { "schemas": { "action-types_list_list-action_input": { "required": [ "la-input" ], "properties": { "la-input": { "description": "", "type": "string", "example": "Some la-input" } }, "xml": { "name": "input", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_list_list-action_input", "type": "object" }, "action-types_container": { "properties": {}, "xml": { "name": "container", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_container", "type": "object" }, "action-types_multi-container": { "properties": { "inner-container": { "$ref": "#/components/schemas/action-types_multi-container_inner-container" } }, "xml": { "name": "multi-container", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_multi-container", "type": "object" }, "action-types_list_list-action_output": { "required": [ "la-output" ], "properties": { "la-output": { "description": "", "type": "string", "example": "Some la-output" } }, "xml": { "name": "output", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_list_list-action_output", "type": "object" }, "action-types_container_container-action_input": { "required": [ "ca-input" ], "properties": { "ca-input": { "description": "", "type": "string", "example": "Some ca-input" } }, "xml": { "name": "input", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_container_container-action_input", "type": "object" }, "action-types_multi-container_inner-container": { "properties": {}, "xml": { "name": "inner-container", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_multi-container_inner-container", "type": "object" }, "action-types_list": { "properties": { "name": { "description": "", "type": "string", "example": "Some name" } }, "xml": { "name": "list", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_list", "type": "object" }, "action-types_container_container-action_output": { "required": [ "ca-output" ], "properties": { "ca-output": { "description": "", "type": "string", "example": "Some ca-output" } }, "xml": { "name": "output", "namespace": "urn:ietf:params:xml:ns:yang:test:action:types" }, "title": "action-types_container_container-action_output", "type": "object" } }, "securitySchemes": { "basicAuth": { "scheme": "basic", "type": "http" } } }, "security": [ { "basicAuth": [] } ] }