summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authors00370346 <swarup.nayak1@huawei.com>2019-03-13 19:38:52 +0530
committers00370346 <swarup.nayak1@huawei.com>2019-03-13 19:43:31 +0530
commitd76c2d0f61bfb4373b13fcdb6fc3317467dd19b4 (patch)
treee6be1b4eadf4919d3deff8bd58be0153ab84ab77
parent4149f3256a0b0948a766fb83824032e53beee2ff (diff)
Issue-ID: DCAEGEN2-1141 Restconf SwaggerAPI docs
Change-Id: I8fb37dff3e88bbef8aa69ef338f1d8ebd2a9ea6f Signed-off-by: s00370346 <swarup.nayak1@huawei.com>
-rw-r--r--swagger_restconfcollector_1.0.0.json315
-rw-r--r--swagger_restconfcollector_1.0.0.yaml315
2 files changed, 630 insertions, 0 deletions
diff --git a/swagger_restconfcollector_1.0.0.json b/swagger_restconfcollector_1.0.0.json
new file mode 100644
index 0000000..d511970
--- /dev/null
+++ b/swagger_restconfcollector_1.0.0.json
@@ -0,0 +1,315 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "description": "Api Documentation",
+ "version": "1.0",
+ "title": "Api Documentation",
+ "termsOfService": "urn:tos",
+ "contact": {},
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ }
+ },
+ "host": "localhost:8686",
+ "basePath": "/",
+ "tags": [{
+ "name": "restconf-colletcor",
+ "description": "Generic Restconf event Colletcor"
+ }, {
+ "name": "restconf-Colletcor",
+ "description": "Restconf Colletcor"
+ }],
+ "paths": {
+ "/": {
+ "get": {
+ "tags": ["restconf-colletcor"],
+ "summary": "mainPage",
+ "operationId": "mainPageUsingGET",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ }
+ },
+ "/error": {
+ "get": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingGET",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ },
+ "head": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingHEAD",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "post": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPOST",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ },
+ "put": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPUT",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ },
+ "delete": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingDELETE",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "options": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingOPTIONS",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "patch": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPATCH",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/healthcheck": {
+ "get": {
+ "tags": ["basic-healthcheck"],
+ "summary": "healthcheckHtml",
+ "operationId": "healthcheckUsingGET",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ModelAndView": {
+ "type": "object",
+ "properties": {
+ "empty": {
+ "type": "boolean"
+ },
+ "model": {
+ "type": "object"
+ },
+ "modelMap": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "reference": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511"]
+ },
+ "view": {
+ "$ref": "#/definitions/View"
+ },
+ "viewName": {
+ "type": "string"
+ }
+ },
+ "title": "ModelAndView"
+ },
+ "View": {
+ "type": "object",
+ "properties": {
+ "contentType": {
+ "type": "string"
+ }
+ },
+ "title": "View"
+ }
+ }
+} \ No newline at end of file
diff --git a/swagger_restconfcollector_1.0.0.yaml b/swagger_restconfcollector_1.0.0.yaml
new file mode 100644
index 0000000..d511970
--- /dev/null
+++ b/swagger_restconfcollector_1.0.0.yaml
@@ -0,0 +1,315 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "description": "Api Documentation",
+ "version": "1.0",
+ "title": "Api Documentation",
+ "termsOfService": "urn:tos",
+ "contact": {},
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ }
+ },
+ "host": "localhost:8686",
+ "basePath": "/",
+ "tags": [{
+ "name": "restconf-colletcor",
+ "description": "Generic Restconf event Colletcor"
+ }, {
+ "name": "restconf-Colletcor",
+ "description": "Restconf Colletcor"
+ }],
+ "paths": {
+ "/": {
+ "get": {
+ "tags": ["restconf-colletcor"],
+ "summary": "mainPage",
+ "operationId": "mainPageUsingGET",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ }
+ },
+ "/error": {
+ "get": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingGET",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ },
+ "head": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingHEAD",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "post": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPOST",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ },
+ "put": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPUT",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ },
+ "delete": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingDELETE",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "options": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingOPTIONS",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "patch": {
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPATCH",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/healthcheck": {
+ "get": {
+ "tags": ["basic-healthcheck"],
+ "summary": "healthcheckHtml",
+ "operationId": "healthcheckUsingGET",
+ "produces": ["*/*"],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ModelAndView": {
+ "type": "object",
+ "properties": {
+ "empty": {
+ "type": "boolean"
+ },
+ "model": {
+ "type": "object"
+ },
+ "modelMap": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "reference": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511"]
+ },
+ "view": {
+ "$ref": "#/definitions/View"
+ },
+ "viewName": {
+ "type": "string"
+ }
+ },
+ "title": "ModelAndView"
+ },
+ "View": {
+ "type": "object",
+ "properties": {
+ "contentType": {
+ "type": "string"
+ }
+ },
+ "title": "View"
+ }
+ }
+} \ No newline at end of file