-{\r
- "swagger" : "2.0",\r
- "info" : {\r
- "description" : "MicroService Bus rest API",\r
- "version" : "1.0.0",\r
- "title" : "MicroService Bus rest API",\r
- "license" : {\r
- "name" : "https://wiki.onap.org/display/DW/Apache+2.0+License"\r
- }\r
- },\r
- "host" : "127.0.0.1:80",\r
- "basePath" : "/api/microservices/v1",\r
- "tags" : [ {\r
- "name" : "ApiRoute"\r
- }, {\r
- "name" : "CustomRoute"\r
- }, {\r
- "name" : "iuiRoute"\r
- } ],\r
- "schemes" : [ "http", "https" ],\r
- "paths" : {\r
- "/apiRoute" : {\r
- "get" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "get all ApiRoute ",\r
- "description" : "",\r
- "operationId" : "getApiRoutes",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "type" : "array",\r
- "items" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- }\r
- },\r
- "500" : {\r
- "description" : "get ApiRouteInfo List fail"\r
- }\r
- }\r
- },\r
- "post" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "add one ApiRoute ",\r
- "description" : "",\r
- "operationId" : "addApiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "in" : "body",\r
- "name" : "body",\r
- "description" : "ApiRoute Instance Info",\r
- "required" : true,\r
- "schema" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- },\r
- "400" : {\r
- "description" : "Unprocessable ApiRouteInfo JSON REQUEST"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable ApiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "add ApiRouteInfo fail"\r
- }\r
- }\r
- }\r
- },\r
- "/apiRoute/apiDocs" : {\r
- "get" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "get all Local apiDoc ",\r
- "description" : "",\r
- "operationId" : "getApiDocs",\r
- "produces" : [ "application/json" ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "type" : "array",\r
- "items" : {\r
- "type" : "string"\r
- }\r
- }\r
- },\r
- "500" : {\r
- "description" : "get apiDoc List fail"\r
- }\r
- }\r
- }\r
- },\r
- "/apiRoute/discoverInfo" : {\r
- "get" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "get discover Info ",\r
- "description" : "",\r
- "operationId" : "getServiceDiscoverInfo",\r
- "produces" : [ "application/json" ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/DiscoverInfo"\r
- }\r
- },\r
- "500" : {\r
- "description" : "get discover Info fail"\r
- }\r
- }\r
- }\r
- },\r
- "/apiRoute/export" : {\r
- "get" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "export all route service Info by json-file",\r
- "description" : "",\r
- "operationId" : "exportService",\r
- "produces" : [ "text/plain" ],\r
- "parameters" : [ {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "type" : "string"\r
- }\r
- },\r
- "406" : {\r
- "description" : " not Acceptable client-side"\r
- },\r
- "500" : {\r
- "description" : "export fail"\r
- }\r
- }\r
- }\r
- },\r
- "/apiRoute/{serviceName}/version/{version}" : {\r
- "get" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "get one ApiRoute ",\r
- "description" : "",\r
- "operationId" : "getApiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "ApiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "version",\r
- "in" : "path",\r
- "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "ApiRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "ApiRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- },\r
- "404" : {\r
- "description" : "ApiRouteInfo not found"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable ApiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "get ApiRouteInfo fail"\r
- }\r
- }\r
- },\r
- "put" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "update one ApiRoute by serviceName and version",\r
- "description" : "",\r
- "operationId" : "updateApiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "ApiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "version",\r
- "in" : "path",\r
- "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "in" : "body",\r
- "name" : "body",\r
- "description" : "ApiRoute Instance Info",\r
- "required" : true,\r
- "schema" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- },\r
- "400" : {\r
- "description" : "Unprocessable ApiRouteInfo JSON REQUEST"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable ApiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "update ApiRouteInfo fail"\r
- }\r
- }\r
- },\r
- "delete" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "delete one ApiRoute by serviceName and version",\r
- "description" : "",\r
- "operationId" : "deleteApiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "ApiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "version",\r
- "in" : "path",\r
- "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "ApiRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "ApiRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "204" : {\r
- "description" : "delete ApiRouteInfo succeed "\r
- },\r
- "404" : {\r
- "description" : "ApiRouteInfo not found"\r
- },\r
- "500" : {\r
- "description" : "delete ApiRouteInfo fail"\r
- }\r
- }\r
- }\r
- },\r
- "/apiRoute/{serviceName}/version/{version}/status/{status}" : {\r
- "put" : {\r
- "tags" : [ "ApiRoute" ],\r
- "summary" : "update one ApiRoute status by serviceName and version",\r
- "description" : "",\r
- "operationId" : "updateApiRouteStatus",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "ApiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "version",\r
- "in" : "path",\r
- "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "status",\r
- "in" : "path",\r
- "description" : "ApiRoute status,1?abled 0?disabled",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "ApiRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "ApiRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/ApiRouteInfo"\r
- }\r
- },\r
- "404" : {\r
- "description" : "ApiRouteInfo not found"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable ApiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "update status fail"\r
- }\r
- }\r
- }\r
- },\r
- "/customRoute/all" : {\r
- "get" : {\r
- "tags" : [ "CustomRoute" ],\r
- "summary" : "get all CustomRoute ",\r
- "description" : "",\r
- "operationId" : "getCustomRoutes",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "type" : "array",\r
- "items" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- }\r
- },\r
- "500" : {\r
- "description" : "get CustomRouteInfo List fail"\r
- }\r
- }\r
- }\r
- },\r
- "/customRoute/instance" : {\r
- "get" : {\r
- "tags" : [ "CustomRoute" ],\r
- "summary" : "get one CustomRoute ",\r
- "description" : "",\r
- "operationId" : "getCustomRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "query",\r
- "description" : "CustomRoute serviceName",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "CustomRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "CustomRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- },\r
- "404" : {\r
- "description" : "CustomRoute not found"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable CustomRoute Entity "\r
- },\r
- "500" : {\r
- "description" : "get CustomRoute fail"\r
- }\r
- }\r
- },\r
- "post" : {\r
- "tags" : [ "CustomRoute" ],\r
- "summary" : "add one CustomRoute ",\r
- "description" : "",\r
- "operationId" : "addCustomRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "in" : "body",\r
- "name" : "body",\r
- "description" : "CustomRoute Instance Info",\r
- "required" : true,\r
- "schema" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- },\r
- "400" : {\r
- "description" : "Unprocessable CustomRouteInfo JSON REQUEST"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable CustomRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "add CustomRouteInfo fail"\r
- }\r
- }\r
- },\r
- "put" : {\r
- "tags" : [ "CustomRoute" ],\r
- "summary" : "update one CustomRoute by serviceName",\r
- "description" : "",\r
- "operationId" : "updateCustomRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "query",\r
- "description" : "CustomRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "in" : "body",\r
- "name" : "body",\r
- "description" : "CustomRoute Instance Info",\r
- "required" : true,\r
- "schema" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- },\r
- "400" : {\r
- "description" : "Unprocessable CustomRoute JSON REQUEST"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable CustomRoute Entity "\r
- },\r
- "500" : {\r
- "description" : "update CustomRoute fail"\r
- }\r
- }\r
- },\r
- "delete" : {\r
- "tags" : [ "CustomRoute" ],\r
- "summary" : "delete one CustomRoute by serviceName",\r
- "description" : "",\r
- "operationId" : "deleteCustomRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "query",\r
- "description" : "CustomRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "CustomRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "CustomRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "204" : {\r
- "description" : "delete customRoute succeed "\r
- },\r
- "404" : {\r
- "description" : "customRoute not found"\r
- },\r
- "500" : {\r
- "description" : "delete customRoute fail"\r
- }\r
- }\r
- }\r
- },\r
- "/customRoute/status" : {\r
- "put" : {\r
- "tags" : [ "CustomRoute" ],\r
- "summary" : "update one CustomRoute status by serviceName ",\r
- "description" : "",\r
- "operationId" : "updateCustomRouteStatus",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "query",\r
- "description" : "CustomRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "CustomRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "status",\r
- "in" : "query",\r
- "description" : "CustomRoute status,1?abled 0?disabled",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "CustomRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/CustomRouteInfo"\r
- }\r
- },\r
- "404" : {\r
- "description" : "customRoute not found"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable customRoute Entity "\r
- },\r
- "500" : {\r
- "description" : "update status fail"\r
- }\r
- }\r
- }\r
- },\r
- "/iuiRoute" : {\r
- "get" : {\r
- "tags" : [ "iuiRoute" ],\r
- "summary" : "get all iuiRoute ",\r
- "description" : "",\r
- "operationId" : "getIuiRoutes",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "type" : "array",\r
- "items" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- }\r
- },\r
- "500" : {\r
- "description" : "get iuiRouteInfo List fail"\r
- }\r
- }\r
- },\r
- "post" : {\r
- "tags" : [ "iuiRoute" ],\r
- "summary" : "add one iuiRoute ",\r
- "description" : "",\r
- "operationId" : "addIuiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "in" : "body",\r
- "name" : "body",\r
- "description" : "iuiRoute Instance Info",\r
- "required" : true,\r
- "schema" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- },\r
- "400" : {\r
- "description" : "Unprocessable iuiRouteInfo JSON REQUEST"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable iuiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "add iuiRouteInfo fail"\r
- }\r
- }\r
- }\r
- },\r
- "/iuiRoute/{serviceName}" : {\r
- "get" : {\r
- "tags" : [ "iuiRoute" ],\r
- "summary" : "get one iuiRoute ",\r
- "description" : "",\r
- "operationId" : "getIuiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "iuiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "iuiRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "iuiRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "200" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- },\r
- "404" : {\r
- "description" : "IuiRouteInfo not found"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable IuiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "get IuiRouteInfo fail"\r
- }\r
- }\r
- },\r
- "put" : {\r
- "tags" : [ "iuiRoute" ],\r
- "summary" : "update one iuiRoute by serviceName",\r
- "description" : "",\r
- "operationId" : "updateIuiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "iuiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "in" : "body",\r
- "name" : "body",\r
- "description" : "iuiRoute Instance Info",\r
- "required" : true,\r
- "schema" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- },\r
- "400" : {\r
- "description" : "Unprocessable IuiRouteInfo JSON REQUEST"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable IuiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "update IuiRouteInfo fail"\r
- }\r
- }\r
- },\r
- "delete" : {\r
- "tags" : [ "iuiRoute" ],\r
- "summary" : "delete one iuiRoute by serviceName",\r
- "description" : "",\r
- "operationId" : "deleteIuiRoute",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "iuiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "iuiRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "iuiRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "204" : {\r
- "description" : "delete IuiRouteInfo succeed "\r
- },\r
- "404" : {\r
- "description" : "IuiRouteInfo not found"\r
- },\r
- "500" : {\r
- "description" : "delete IuiRouteInfo fail"\r
- }\r
- }\r
- }\r
- },\r
- "/iuiRoute/{serviceName}/status/{status}" : {\r
- "put" : {\r
- "tags" : [ "iuiRoute" ],\r
- "summary" : "update one iuiRoute status by serviceName ",\r
- "description" : "",\r
- "operationId" : "updateIuiRouteStatus",\r
- "produces" : [ "application/json" ],\r
- "parameters" : [ {\r
- "name" : "serviceName",\r
- "in" : "path",\r
- "description" : "iuiRoute serviceName",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "host",\r
- "in" : "query",\r
- "description" : "iuiRoute host",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "status",\r
- "in" : "path",\r
- "description" : "iuiRoute status,1?abled 0?disabled",\r
- "required" : true,\r
- "type" : "string"\r
- }, {\r
- "name" : "publish_port",\r
- "in" : "query",\r
- "description" : "iuiRoute Publish port",\r
- "required" : false,\r
- "type" : "string"\r
- }, {\r
- "name" : "routeWay",\r
- "in" : "query",\r
- "description" : "Route Way",\r
- "required" : false,\r
- "type" : "string",\r
- "default" : "ip"\r
- } ],\r
- "responses" : {\r
- "201" : {\r
- "description" : "successful operation",\r
- "schema" : {\r
- "$ref" : "#/definitions/IuiRouteInfo"\r
- }\r
- },\r
- "404" : {\r
- "description" : "IuiRouteInfo not found"\r
- },\r
- "422" : {\r
- "description" : "Unprocessable IuiRouteInfo Entity "\r
- },\r
- "500" : {\r
- "description" : "update IuiRouteInfo status fail"\r
- }\r
- }\r
- }\r
- }\r
- },\r
- "definitions" : {\r
- "ApiRouteInfo" : {\r
- "type" : "object",\r
- "required" : [ "servers", "serviceName", "url", "version" ],\r
- "properties" : {\r
- "serviceName" : {\r
- "type" : "string"\r
- },\r
- "url" : {\r
- "type" : "string",\r
- "example" : "/test",\r
- "description" : "Target Service URL,start with /"\r
- },\r
- "control" : {\r
- "type" : "string",\r
- "example" : "0",\r
- "description" : "[control Range] 0?default 1?readonly 2?hidden ",\r
- "enum" : [ "0", "1", "2" ]\r
- },\r
- "status" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[status] 1?abled 0?disabled ",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "visualRange" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[visual Range]interSystem:0,inSystem:1",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "useOwnUpstream" : {\r
- "type" : "string",\r
- "example" : "0",\r
- "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "servers" : {\r
- "type" : "array",\r
- "items" : {\r
- "$ref" : "#/definitions/RouteServer"\r
- }\r
- },\r
- "host" : {\r
- "type" : "string"\r
- },\r
- "namespace" : {\r
- "type" : "string"\r
- },\r
- "publish_port" : {\r
- "type" : "string"\r
- },\r
- "enable_ssl" : {\r
- "type" : "boolean",\r
- "default" : false\r
- },\r
- "consulServiceName" : {\r
- "type" : "string"\r
- },\r
- "publishProtocol" : {\r
- "type" : "string"\r
- },\r
- "version" : {\r
- "type" : "string",\r
- "example" : "v1"\r
- },\r
- "apiJson" : {\r
- "type" : "string"\r
- },\r
- "apiJsonType" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[apiJson Type] 0?local file 1? remote file",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "metricsUrl" : {\r
- "type" : "string"\r
- }\r
- }\r
- },\r
- "CustomRouteInfo" : {\r
- "type" : "object",\r
- "required" : [ "servers", "serviceName", "url" ],\r
- "properties" : {\r
- "serviceName" : {\r
- "type" : "string"\r
- },\r
- "url" : {\r
- "type" : "string",\r
- "example" : "/test",\r
- "description" : "Target Service URL,start with /"\r
- },\r
- "control" : {\r
- "type" : "string",\r
- "example" : "0",\r
- "description" : "[control Range] 0?default 1?readonly 2?hidden ",\r
- "enum" : [ "0", "1", "2" ]\r
- },\r
- "status" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[status] 1?abled 0?disabled ",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "visualRange" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[visual Range]interSystem:0,inSystem:1",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "useOwnUpstream" : {\r
- "type" : "string",\r
- "example" : "0",\r
- "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "servers" : {\r
- "type" : "array",\r
- "items" : {\r
- "$ref" : "#/definitions/RouteServer"\r
- }\r
- },\r
- "host" : {\r
- "type" : "string"\r
- },\r
- "namespace" : {\r
- "type" : "string"\r
- },\r
- "publish_port" : {\r
- "type" : "string"\r
- },\r
- "enable_ssl" : {\r
- "type" : "boolean",\r
- "default" : false\r
- },\r
- "consulServiceName" : {\r
- "type" : "string"\r
- },\r
- "publishProtocol" : {\r
- "type" : "string"\r
- }\r
- }\r
- },\r
- "DiscoverInfo" : {\r
- "type" : "object",\r
- "properties" : {\r
- "ip" : {\r
- "type" : "string"\r
- },\r
- "port" : {\r
- "type" : "integer",\r
- "format" : "int32"\r
- },\r
- "enabled" : {\r
- "type" : "boolean",\r
- "default" : false\r
- }\r
- }\r
- },\r
- "IuiRouteInfo" : {\r
- "type" : "object",\r
- "required" : [ "servers", "serviceName", "url" ],\r
- "properties" : {\r
- "serviceName" : {\r
- "type" : "string"\r
- },\r
- "url" : {\r
- "type" : "string",\r
- "example" : "/test",\r
- "description" : "Target Service URL,start with /"\r
- },\r
- "control" : {\r
- "type" : "string",\r
- "example" : "0",\r
- "description" : "[control Range] 0?default 1?readonly 2?hidden ",\r
- "enum" : [ "0", "1", "2" ]\r
- },\r
- "status" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[status] 1?abled 0?disabled ",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "visualRange" : {\r
- "type" : "string",\r
- "example" : "1",\r
- "description" : "[visual Range]interSystem:0,inSystem:1",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "useOwnUpstream" : {\r
- "type" : "string",\r
- "example" : "0",\r
- "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",\r
- "enum" : [ "0", "1" ]\r
- },\r
- "servers" : {\r
- "type" : "array",\r
- "items" : {\r
- "$ref" : "#/definitions/RouteServer"\r
- }\r
- },\r
- "host" : {\r
- "type" : "string"\r
- },\r
- "namespace" : {\r
- "type" : "string"\r
- },\r
- "publish_port" : {\r
- "type" : "string"\r
- },\r
- "enable_ssl" : {\r
- "type" : "boolean",\r
- "default" : false\r
- },\r
- "consulServiceName" : {\r
- "type" : "string"\r
- },\r
- "publishProtocol" : {\r
- "type" : "string"\r
- }\r
- }\r
- },\r
- "RouteServer" : {\r
- "type" : "object",\r
- "required" : [ "ip", "port" ],\r
- "properties" : {\r
- "ip" : {\r
- "type" : "string"\r
- },\r
- "port" : {\r
- "type" : "string"\r
- },\r
- "weight" : {\r
- "type" : "integer",\r
- "format" : "int32"\r
- }\r
- }\r
- }\r
- }\r
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "MicroService Bus rest API",
+ "version" : "1.0.0",
+ "title" : "MicroService Bus rest API",
+ "license" : {
+ "name" : "https://wiki.onap.org/display/DW/Apache+2.0+License"
+ }
+ },
+ "host" : "127.0.0.1:80",
+ "basePath" : "/api/microservices/v1",
+ "tags" : [ {
+ "name" : "ApiRoute"
+ }, {
+ "name" : "CustomRoute"
+ }, {
+ "name" : "iuiRoute"
+ } ],
+ "schemes" : [ "http", "https" ],
+ "paths" : {
+ "/apiRoute" : {
+ "get" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "get all ApiRoute ",
+ "description" : "",
+ "operationId" : "getApiRoutes",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ }
+ },
+ "500" : {
+ "description" : "get ApiRouteInfo List fail"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "add one ApiRoute ",
+ "description" : "",
+ "operationId" : "addApiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "ApiRoute Instance Info",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ },
+ "400" : {
+ "description" : "Unprocessable ApiRouteInfo JSON REQUEST"
+ },
+ "422" : {
+ "description" : "Unprocessable ApiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "add ApiRouteInfo fail"
+ }
+ }
+ }
+ },
+ "/apiRoute/apiDocs" : {
+ "get" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "get all Local apiDoc ",
+ "description" : "",
+ "operationId" : "getApiDocs",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "500" : {
+ "description" : "get apiDoc List fail"
+ }
+ }
+ }
+ },
+ "/apiRoute/discoverInfo" : {
+ "get" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "get discover Info ",
+ "description" : "",
+ "operationId" : "getServiceDiscoverInfo",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DiscoverInfo"
+ }
+ },
+ "500" : {
+ "description" : "get discover Info fail"
+ }
+ }
+ }
+ },
+ "/apiRoute/export" : {
+ "get" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "export all route service Info by json-file",
+ "description" : "",
+ "operationId" : "exportService",
+ "produces" : [ "text/plain" ],
+ "parameters" : [ {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "406" : {
+ "description" : " not Acceptable client-side"
+ },
+ "500" : {
+ "description" : "export fail"
+ }
+ }
+ }
+ },
+ "/apiRoute/{serviceName}/version/{version}" : {
+ "get" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "get one ApiRoute ",
+ "description" : "",
+ "operationId" : "getApiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "ApiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "ApiRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "ApiRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ },
+ "404" : {
+ "description" : "ApiRouteInfo not found"
+ },
+ "422" : {
+ "description" : "Unprocessable ApiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "get ApiRouteInfo fail"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "update one ApiRoute by serviceName and version",
+ "description" : "",
+ "operationId" : "updateApiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "ApiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "ApiRoute Instance Info",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ },
+ "400" : {
+ "description" : "Unprocessable ApiRouteInfo JSON REQUEST"
+ },
+ "422" : {
+ "description" : "Unprocessable ApiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "update ApiRouteInfo fail"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "delete one ApiRoute by serviceName and version",
+ "description" : "",
+ "operationId" : "deleteApiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "ApiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "ApiRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "ApiRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "delete ApiRouteInfo succeed "
+ },
+ "404" : {
+ "description" : "ApiRouteInfo not found"
+ },
+ "500" : {
+ "description" : "delete ApiRouteInfo fail"
+ }
+ }
+ }
+ },
+ "/apiRoute/{serviceName}/version/{version}/status/{status}" : {
+ "put" : {
+ "tags" : [ "ApiRoute" ],
+ "summary" : "update one ApiRoute status by serviceName and version",
+ "description" : "",
+ "operationId" : "updateApiRouteStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "ApiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "status",
+ "in" : "path",
+ "description" : "ApiRoute status,1：abled 0：disabled",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "ApiRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "ApiRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ApiRouteInfo"
+ }
+ },
+ "404" : {
+ "description" : "ApiRouteInfo not found"
+ },
+ "422" : {
+ "description" : "Unprocessable ApiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "update status fail"
+ }
+ }
+ }
+ },
+ "/customRoute/all" : {
+ "get" : {
+ "tags" : [ "CustomRoute" ],
+ "summary" : "get all CustomRoute ",
+ "description" : "",
+ "operationId" : "getCustomRoutes",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ }
+ },
+ "500" : {
+ "description" : "get CustomRouteInfo List fail"
+ }
+ }
+ }
+ },
+ "/customRoute/instance" : {
+ "get" : {
+ "tags" : [ "CustomRoute" ],
+ "summary" : "get one CustomRoute ",
+ "description" : "",
+ "operationId" : "getCustomRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "query",
+ "description" : "CustomRoute serviceName",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "CustomRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "CustomRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ },
+ "404" : {
+ "description" : "CustomRoute not found"
+ },
+ "422" : {
+ "description" : "Unprocessable CustomRoute Entity "
+ },
+ "500" : {
+ "description" : "get CustomRoute fail"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "CustomRoute" ],
+ "summary" : "add one CustomRoute ",
+ "description" : "",
+ "operationId" : "addCustomRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "CustomRoute Instance Info",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ },
+ "400" : {
+ "description" : "Unprocessable CustomRouteInfo JSON REQUEST"
+ },
+ "422" : {
+ "description" : "Unprocessable CustomRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "add CustomRouteInfo fail"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "CustomRoute" ],
+ "summary" : "update one CustomRoute by serviceName",
+ "description" : "",
+ "operationId" : "updateCustomRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "query",
+ "description" : "CustomRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "CustomRoute Instance Info",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ },
+ "400" : {
+ "description" : "Unprocessable CustomRoute JSON REQUEST"
+ },
+ "422" : {
+ "description" : "Unprocessable CustomRoute Entity "
+ },
+ "500" : {
+ "description" : "update CustomRoute fail"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "CustomRoute" ],
+ "summary" : "delete one CustomRoute by serviceName",
+ "description" : "",
+ "operationId" : "deleteCustomRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "query",
+ "description" : "CustomRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "CustomRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "CustomRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "delete customRoute succeed "
+ },
+ "404" : {
+ "description" : "customRoute not found"
+ },
+ "500" : {
+ "description" : "delete customRoute fail"
+ }
+ }
+ }
+ },
+ "/customRoute/status" : {
+ "put" : {
+ "tags" : [ "CustomRoute" ],
+ "summary" : "update one CustomRoute status by serviceName ",
+ "description" : "",
+ "operationId" : "updateCustomRouteStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "query",
+ "description" : "CustomRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "CustomRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "status",
+ "in" : "query",
+ "description" : "CustomRoute status,1：abled 0：disabled",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "CustomRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/CustomRouteInfo"
+ }
+ },
+ "404" : {
+ "description" : "customRoute not found"
+ },
+ "422" : {
+ "description" : "Unprocessable customRoute Entity "
+ },
+ "500" : {
+ "description" : "update status fail"
+ }
+ }
+ }
+ },
+ "/iuiRoute" : {
+ "get" : {
+ "tags" : [ "iuiRoute" ],
+ "summary" : "get all iuiRoute ",
+ "description" : "",
+ "operationId" : "getIuiRoutes",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ }
+ },
+ "500" : {
+ "description" : "get iuiRouteInfo List fail"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "iuiRoute" ],
+ "summary" : "add one iuiRoute ",
+ "description" : "",
+ "operationId" : "addIuiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "iuiRoute Instance Info",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ },
+ "400" : {
+ "description" : "Unprocessable iuiRouteInfo JSON REQUEST"
+ },
+ "422" : {
+ "description" : "Unprocessable iuiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "add iuiRouteInfo fail"
+ }
+ }
+ }
+ },
+ "/iuiRoute/{serviceName}" : {
+ "get" : {
+ "tags" : [ "iuiRoute" ],
+ "summary" : "get one iuiRoute ",
+ "description" : "",
+ "operationId" : "getIuiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "iuiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "iuiRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "iuiRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ },
+ "404" : {
+ "description" : "IuiRouteInfo not found"
+ },
+ "422" : {
+ "description" : "Unprocessable IuiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "get IuiRouteInfo fail"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "iuiRoute" ],
+ "summary" : "update one iuiRoute by serviceName",
+ "description" : "",
+ "operationId" : "updateIuiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "iuiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "iuiRoute Instance Info",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ },
+ "400" : {
+ "description" : "Unprocessable IuiRouteInfo JSON REQUEST"
+ },
+ "422" : {
+ "description" : "Unprocessable IuiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "update IuiRouteInfo fail"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "iuiRoute" ],
+ "summary" : "delete one iuiRoute by serviceName",
+ "description" : "",
+ "operationId" : "deleteIuiRoute",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "iuiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "iuiRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "iuiRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "delete IuiRouteInfo succeed "
+ },
+ "404" : {
+ "description" : "IuiRouteInfo not found"
+ },
+ "500" : {
+ "description" : "delete IuiRouteInfo fail"
+ }
+ }
+ }
+ },
+ "/iuiRoute/{serviceName}/status/{status}" : {
+ "put" : {
+ "tags" : [ "iuiRoute" ],
+ "summary" : "update one iuiRoute status by serviceName ",
+ "description" : "",
+ "operationId" : "updateIuiRouteStatus",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "serviceName",
+ "in" : "path",
+ "description" : "iuiRoute serviceName",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "host",
+ "in" : "query",
+ "description" : "iuiRoute host",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "status",
+ "in" : "path",
+ "description" : "iuiRoute status,1：abled 0：disabled",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "publish_port",
+ "in" : "query",
+ "description" : "iuiRoute Publish port",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "routeWay",
+ "in" : "query",
+ "description" : "Route Way",
+ "required" : false,
+ "type" : "string",
+ "default" : "ip"
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/IuiRouteInfo"
+ }
+ },
+ "404" : {
+ "description" : "IuiRouteInfo not found"
+ },
+ "422" : {
+ "description" : "Unprocessable IuiRouteInfo Entity "
+ },
+ "500" : {
+ "description" : "update IuiRouteInfo status fail"
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "ApiRouteInfo" : {
+ "type" : "object",
+ "required" : [ "servers", "serviceName", "url", "version" ],
+ "properties" : {
+ "serviceName" : {
+ "type" : "string"
+ },
+ "url" : {
+ "type" : "string",
+ "example" : "/test",
+ "description" : "Target Service URL,start with /"
+ },
+ "control" : {
+ "type" : "string",
+ "example" : "0",
+ "description" : "[control Range] 0：default 1：readonly 2：hidden ",
+ "enum" : [ "0", "1", "2" ]
+ },
+ "status" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[status] 1：abled 0：disabled ",
+ "enum" : [ "0", "1" ]
+ },
+ "visualRange" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[visual Range]interSystem:0,inSystem:1",
+ "enum" : [ "0", "1" ]
+ },
+ "useOwnUpstream" : {
+ "type" : "string",
+ "example" : "0",
+ "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",
+ "enum" : [ "0", "1" ]
+ },
+ "servers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/RouteServer"
+ }
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "namespace" : {
+ "type" : "string"
+ },
+ "publish_port" : {
+ "type" : "string"
+ },
+ "enable_ssl" : {
+ "type" : "boolean",
+ "default" : false
+ },
+ "consulServiceName" : {
+ "type" : "string"
+ },
+ "publishProtocol" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "string",
+ "example" : "v1"
+ },
+ "apiJson" : {
+ "type" : "string"
+ },
+ "apiJsonType" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[apiJson Type] 0：local file 1： remote file",
+ "enum" : [ "0", "1" ]
+ },
+ "metricsUrl" : {
+ "type" : "string"
+ }
+ }
+ },
+ "CustomRouteInfo" : {
+ "type" : "object",
+ "required" : [ "servers", "serviceName", "url" ],
+ "properties" : {
+ "serviceName" : {
+ "type" : "string"
+ },
+ "url" : {
+ "type" : "string",
+ "example" : "/test",
+ "description" : "Target Service URL,start with /"
+ },
+ "control" : {
+ "type" : "string",
+ "example" : "0",
+ "description" : "[control Range] 0：default 1：readonly 2：hidden ",
+ "enum" : [ "0", "1", "2" ]
+ },
+ "status" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[status] 1：abled 0：disabled ",
+ "enum" : [ "0", "1" ]
+ },
+ "visualRange" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[visual Range]interSystem:0,inSystem:1",
+ "enum" : [ "0", "1" ]
+ },
+ "useOwnUpstream" : {
+ "type" : "string",
+ "example" : "0",
+ "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",
+ "enum" : [ "0", "1" ]
+ },
+ "servers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/RouteServer"
+ }
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "namespace" : {
+ "type" : "string"
+ },
+ "publish_port" : {
+ "type" : "string"
+ },
+ "enable_ssl" : {
+ "type" : "boolean",
+ "default" : false
+ },
+ "consulServiceName" : {
+ "type" : "string"
+ },
+ "publishProtocol" : {
+ "type" : "string"
+ }
+ }
+ },
+ "DiscoverInfo" : {
+ "type" : "object",
+ "properties" : {
+ "ip" : {
+ "type" : "string"
+ },
+ "port" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "enabled" : {
+ "type" : "boolean",
+ "default" : false
+ }
+ }
+ },
+ "IuiRouteInfo" : {
+ "type" : "object",
+ "required" : [ "servers", "serviceName", "url" ],
+ "properties" : {
+ "serviceName" : {
+ "type" : "string"
+ },
+ "url" : {
+ "type" : "string",
+ "example" : "/test",
+ "description" : "Target Service URL,start with /"
+ },
+ "control" : {
+ "type" : "string",
+ "example" : "0",
+ "description" : "[control Range] 0：default 1：readonly 2：hidden ",
+ "enum" : [ "0", "1", "2" ]
+ },
+ "status" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[status] 1：abled 0：disabled ",
+ "enum" : [ "0", "1" ]
+ },
+ "visualRange" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "[visual Range]interSystem:0,inSystem:1",
+ "enum" : [ "0", "1" ]
+ },
+ "useOwnUpstream" : {
+ "type" : "string",
+ "example" : "0",
+ "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",
+ "enum" : [ "0", "1" ]
+ },
+ "servers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/RouteServer"
+ }
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "namespace" : {
+ "type" : "string"
+ },
+ "publish_port" : {
+ "type" : "string"
+ },
+ "enable_ssl" : {
+ "type" : "boolean",
+ "default" : false
+ },
+ "consulServiceName" : {
+ "type" : "string"
+ },
+ "publishProtocol" : {
+ "type" : "string"
+ }
+ }
+ },
+ "RouteServer" : {
+ "type" : "object",
+ "required" : [ "ip", "port" ],
+ "properties" : {
+ "ip" : {
+ "type" : "string"
+ },
+ "port" : {
+ "type" : "string"
+ },
+ "weight" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ }
}
\ No newline at end of file
Code Review / msb / apigateway.git / commitdiff