4 "description" : "MicroService Bus rest API",
\r
6 "title" : "MicroService Bus rest API",
\r
8 "name" : "https://wiki.onap.org/display/DW/Apache+2.0+License"
\r
11 "host" : "127.0.0.1:80",
\r
12 "basePath" : "/api/microservices/v1",
\r
16 "name" : "CustomRoute"
\r
20 "schemes" : [ "http", "https" ],
\r
24 "tags" : [ "ApiRoute" ],
\r
25 "summary" : "get all ApiRoute ",
\r
27 "operationId" : "getApiRoutes",
\r
28 "produces" : [ "application/json" ],
\r
30 "name" : "routeWay",
\r
32 "description" : "Route Way",
\r
39 "description" : "successful operation",
\r
43 "$ref" : "#/definitions/ApiRouteInfo"
\r
48 "description" : "get ApiRouteInfo List fail"
\r
53 "tags" : [ "ApiRoute" ],
\r
54 "summary" : "add one ApiRoute ",
\r
56 "operationId" : "addApiRoute",
\r
57 "produces" : [ "application/json" ],
\r
61 "description" : "ApiRoute Instance Info",
\r
64 "$ref" : "#/definitions/ApiRouteInfo"
\r
67 "name" : "routeWay",
\r
69 "description" : "Route Way",
\r
76 "description" : "successful operation",
\r
78 "$ref" : "#/definitions/ApiRouteInfo"
\r
82 "description" : "Unprocessable ApiRouteInfo JSON REQUEST"
\r
85 "description" : "Unprocessable ApiRouteInfo Entity "
\r
88 "description" : "add ApiRouteInfo fail"
\r
93 "/apiRoute/apiDocs" : {
\r
95 "tags" : [ "ApiRoute" ],
\r
96 "summary" : "get all Local apiDoc ",
\r
98 "operationId" : "getApiDocs",
\r
99 "produces" : [ "application/json" ],
\r
102 "description" : "successful operation",
\r
111 "description" : "get apiDoc List fail"
\r
116 "/apiRoute/discoverInfo" : {
\r
118 "tags" : [ "ApiRoute" ],
\r
119 "summary" : "get discover Info ",
\r
120 "description" : "",
\r
121 "operationId" : "getServiceDiscoverInfo",
\r
122 "produces" : [ "application/json" ],
\r
125 "description" : "successful operation",
\r
127 "$ref" : "#/definitions/DiscoverInfo"
\r
131 "description" : "get discover Info fail"
\r
136 "/apiRoute/export" : {
\r
138 "tags" : [ "ApiRoute" ],
\r
139 "summary" : "export all route service Info by json-file",
\r
140 "description" : "",
\r
141 "operationId" : "exportService",
\r
142 "produces" : [ "text/plain" ],
\r
144 "name" : "routeWay",
\r
146 "description" : "Route Way",
\r
147 "required" : false,
\r
153 "description" : "successful operation",
\r
159 "description" : " not Acceptable client-side"
\r
162 "description" : "export fail"
\r
167 "/apiRoute/{serviceName}/version/{version}" : {
\r
169 "tags" : [ "ApiRoute" ],
\r
170 "summary" : "get one ApiRoute ",
\r
171 "description" : "",
\r
172 "operationId" : "getApiRoute",
\r
173 "produces" : [ "application/json" ],
\r
175 "name" : "serviceName",
\r
177 "description" : "ApiRoute serviceName",
\r
181 "name" : "version",
\r
183 "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
\r
189 "description" : "ApiRoute host",
\r
190 "required" : false,
\r
193 "name" : "publish_port",
\r
195 "description" : "ApiRoute Publish port",
\r
196 "required" : false,
\r
199 "name" : "routeWay",
\r
201 "description" : "Route Way",
\r
202 "required" : false,
\r
208 "description" : "successful operation",
\r
210 "$ref" : "#/definitions/ApiRouteInfo"
\r
214 "description" : "ApiRouteInfo not found"
\r
217 "description" : "Unprocessable ApiRouteInfo Entity "
\r
220 "description" : "get ApiRouteInfo fail"
\r
225 "tags" : [ "ApiRoute" ],
\r
226 "summary" : "update one ApiRoute by serviceName and version",
\r
227 "description" : "",
\r
228 "operationId" : "updateApiRoute",
\r
229 "produces" : [ "application/json" ],
\r
231 "name" : "serviceName",
\r
233 "description" : "ApiRoute serviceName",
\r
237 "name" : "version",
\r
239 "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
\r
245 "description" : "ApiRoute Instance Info",
\r
248 "$ref" : "#/definitions/ApiRouteInfo"
\r
251 "name" : "routeWay",
\r
253 "description" : "Route Way",
\r
254 "required" : false,
\r
260 "description" : "successful operation",
\r
262 "$ref" : "#/definitions/ApiRouteInfo"
\r
266 "description" : "Unprocessable ApiRouteInfo JSON REQUEST"
\r
269 "description" : "Unprocessable ApiRouteInfo Entity "
\r
272 "description" : "update ApiRouteInfo fail"
\r
277 "tags" : [ "ApiRoute" ],
\r
278 "summary" : "delete one ApiRoute by serviceName and version",
\r
279 "description" : "",
\r
280 "operationId" : "deleteApiRoute",
\r
281 "produces" : [ "application/json" ],
\r
283 "name" : "serviceName",
\r
285 "description" : "ApiRoute serviceName",
\r
289 "name" : "version",
\r
291 "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
\r
297 "description" : "ApiRoute host",
\r
298 "required" : false,
\r
301 "name" : "publish_port",
\r
303 "description" : "ApiRoute Publish port",
\r
304 "required" : false,
\r
307 "name" : "routeWay",
\r
309 "description" : "Route Way",
\r
310 "required" : false,
\r
316 "description" : "delete ApiRouteInfo succeed "
\r
319 "description" : "ApiRouteInfo not found"
\r
322 "description" : "delete ApiRouteInfo fail"
\r
327 "/apiRoute/{serviceName}/version/{version}/status/{status}" : {
\r
329 "tags" : [ "ApiRoute" ],
\r
330 "summary" : "update one ApiRoute status by serviceName and version",
\r
331 "description" : "",
\r
332 "operationId" : "updateApiRouteStatus",
\r
333 "produces" : [ "application/json" ],
\r
335 "name" : "serviceName",
\r
337 "description" : "ApiRoute serviceName",
\r
341 "name" : "version",
\r
343 "description" : "ApiRoute version,if the version is empty, please enter \"null\"",
\r
349 "description" : "ApiRoute status,1?abled 0?disabled",
\r
355 "description" : "ApiRoute host",
\r
356 "required" : false,
\r
359 "name" : "publish_port",
\r
361 "description" : "ApiRoute Publish port",
\r
362 "required" : false,
\r
365 "name" : "routeWay",
\r
367 "description" : "Route Way",
\r
368 "required" : false,
\r
374 "description" : "successful operation",
\r
376 "$ref" : "#/definitions/ApiRouteInfo"
\r
380 "description" : "ApiRouteInfo not found"
\r
383 "description" : "Unprocessable ApiRouteInfo Entity "
\r
386 "description" : "update status fail"
\r
391 "/customRoute/all" : {
\r
393 "tags" : [ "CustomRoute" ],
\r
394 "summary" : "get all CustomRoute ",
\r
395 "description" : "",
\r
396 "operationId" : "getCustomRoutes",
\r
397 "produces" : [ "application/json" ],
\r
399 "name" : "routeWay",
\r
401 "description" : "Route Way",
\r
402 "required" : false,
\r
408 "description" : "successful operation",
\r
412 "$ref" : "#/definitions/CustomRouteInfo"
\r
417 "description" : "get CustomRouteInfo List fail"
\r
422 "/customRoute/instance" : {
\r
424 "tags" : [ "CustomRoute" ],
\r
425 "summary" : "get one CustomRoute ",
\r
426 "description" : "",
\r
427 "operationId" : "getCustomRoute",
\r
428 "produces" : [ "application/json" ],
\r
430 "name" : "serviceName",
\r
432 "description" : "CustomRoute serviceName",
\r
433 "required" : false,
\r
438 "description" : "CustomRoute host",
\r
439 "required" : false,
\r
442 "name" : "publish_port",
\r
444 "description" : "CustomRoute Publish port",
\r
445 "required" : false,
\r
448 "name" : "routeWay",
\r
450 "description" : "Route Way",
\r
451 "required" : false,
\r
457 "description" : "successful operation",
\r
459 "$ref" : "#/definitions/CustomRouteInfo"
\r
463 "description" : "CustomRoute not found"
\r
466 "description" : "Unprocessable CustomRoute Entity "
\r
469 "description" : "get CustomRoute fail"
\r
474 "tags" : [ "CustomRoute" ],
\r
475 "summary" : "add one CustomRoute ",
\r
476 "description" : "",
\r
477 "operationId" : "addCustomRoute",
\r
478 "produces" : [ "application/json" ],
\r
482 "description" : "CustomRoute Instance Info",
\r
485 "$ref" : "#/definitions/CustomRouteInfo"
\r
488 "name" : "routeWay",
\r
490 "description" : "Route Way",
\r
491 "required" : false,
\r
497 "description" : "successful operation",
\r
499 "$ref" : "#/definitions/CustomRouteInfo"
\r
503 "description" : "Unprocessable CustomRouteInfo JSON REQUEST"
\r
506 "description" : "Unprocessable CustomRouteInfo Entity "
\r
509 "description" : "add CustomRouteInfo fail"
\r
514 "tags" : [ "CustomRoute" ],
\r
515 "summary" : "update one CustomRoute by serviceName",
\r
516 "description" : "",
\r
517 "operationId" : "updateCustomRoute",
\r
518 "produces" : [ "application/json" ],
\r
520 "name" : "serviceName",
\r
522 "description" : "CustomRoute serviceName",
\r
528 "description" : "CustomRoute Instance Info",
\r
531 "$ref" : "#/definitions/CustomRouteInfo"
\r
534 "name" : "routeWay",
\r
536 "description" : "Route Way",
\r
537 "required" : false,
\r
543 "description" : "successful operation",
\r
545 "$ref" : "#/definitions/CustomRouteInfo"
\r
549 "description" : "Unprocessable CustomRoute JSON REQUEST"
\r
552 "description" : "Unprocessable CustomRoute Entity "
\r
555 "description" : "update CustomRoute fail"
\r
560 "tags" : [ "CustomRoute" ],
\r
561 "summary" : "delete one CustomRoute by serviceName",
\r
562 "description" : "",
\r
563 "operationId" : "deleteCustomRoute",
\r
564 "produces" : [ "application/json" ],
\r
566 "name" : "serviceName",
\r
568 "description" : "CustomRoute serviceName",
\r
574 "description" : "CustomRoute host",
\r
575 "required" : false,
\r
578 "name" : "publish_port",
\r
580 "description" : "CustomRoute Publish port",
\r
581 "required" : false,
\r
584 "name" : "routeWay",
\r
586 "description" : "Route Way",
\r
587 "required" : false,
\r
593 "description" : "delete customRoute succeed "
\r
596 "description" : "customRoute not found"
\r
599 "description" : "delete customRoute fail"
\r
604 "/customRoute/status" : {
\r
606 "tags" : [ "CustomRoute" ],
\r
607 "summary" : "update one CustomRoute status by serviceName ",
\r
608 "description" : "",
\r
609 "operationId" : "updateCustomRouteStatus",
\r
610 "produces" : [ "application/json" ],
\r
612 "name" : "serviceName",
\r
614 "description" : "CustomRoute serviceName",
\r
620 "description" : "CustomRoute host",
\r
621 "required" : false,
\r
626 "description" : "CustomRoute status,1?abled 0?disabled",
\r
630 "name" : "publish_port",
\r
632 "description" : "CustomRoute Publish port",
\r
633 "required" : false,
\r
636 "name" : "routeWay",
\r
638 "description" : "Route Way",
\r
639 "required" : false,
\r
645 "description" : "successful operation",
\r
647 "$ref" : "#/definitions/CustomRouteInfo"
\r
651 "description" : "customRoute not found"
\r
654 "description" : "Unprocessable customRoute Entity "
\r
657 "description" : "update status fail"
\r
664 "tags" : [ "iuiRoute" ],
\r
665 "summary" : "get all iuiRoute ",
\r
666 "description" : "",
\r
667 "operationId" : "getIuiRoutes",
\r
668 "produces" : [ "application/json" ],
\r
670 "name" : "routeWay",
\r
672 "description" : "Route Way",
\r
673 "required" : false,
\r
679 "description" : "successful operation",
\r
683 "$ref" : "#/definitions/IuiRouteInfo"
\r
688 "description" : "get iuiRouteInfo List fail"
\r
693 "tags" : [ "iuiRoute" ],
\r
694 "summary" : "add one iuiRoute ",
\r
695 "description" : "",
\r
696 "operationId" : "addIuiRoute",
\r
697 "produces" : [ "application/json" ],
\r
701 "description" : "iuiRoute Instance Info",
\r
704 "$ref" : "#/definitions/IuiRouteInfo"
\r
707 "name" : "routeWay",
\r
709 "description" : "Route Way",
\r
710 "required" : false,
\r
716 "description" : "successful operation",
\r
718 "$ref" : "#/definitions/IuiRouteInfo"
\r
722 "description" : "Unprocessable iuiRouteInfo JSON REQUEST"
\r
725 "description" : "Unprocessable iuiRouteInfo Entity "
\r
728 "description" : "add iuiRouteInfo fail"
\r
733 "/iuiRoute/{serviceName}" : {
\r
735 "tags" : [ "iuiRoute" ],
\r
736 "summary" : "get one iuiRoute ",
\r
737 "description" : "",
\r
738 "operationId" : "getIuiRoute",
\r
739 "produces" : [ "application/json" ],
\r
741 "name" : "serviceName",
\r
743 "description" : "iuiRoute serviceName",
\r
749 "description" : "iuiRoute host",
\r
750 "required" : false,
\r
753 "name" : "publish_port",
\r
755 "description" : "iuiRoute Publish port",
\r
756 "required" : false,
\r
759 "name" : "routeWay",
\r
761 "description" : "Route Way",
\r
762 "required" : false,
\r
768 "description" : "successful operation",
\r
770 "$ref" : "#/definitions/IuiRouteInfo"
\r
774 "description" : "IuiRouteInfo not found"
\r
777 "description" : "Unprocessable IuiRouteInfo Entity "
\r
780 "description" : "get IuiRouteInfo fail"
\r
785 "tags" : [ "iuiRoute" ],
\r
786 "summary" : "update one iuiRoute by serviceName",
\r
787 "description" : "",
\r
788 "operationId" : "updateIuiRoute",
\r
789 "produces" : [ "application/json" ],
\r
791 "name" : "serviceName",
\r
793 "description" : "iuiRoute serviceName",
\r
799 "description" : "iuiRoute Instance Info",
\r
802 "$ref" : "#/definitions/IuiRouteInfo"
\r
805 "name" : "routeWay",
\r
807 "description" : "Route Way",
\r
808 "required" : false,
\r
814 "description" : "successful operation",
\r
816 "$ref" : "#/definitions/IuiRouteInfo"
\r
820 "description" : "Unprocessable IuiRouteInfo JSON REQUEST"
\r
823 "description" : "Unprocessable IuiRouteInfo Entity "
\r
826 "description" : "update IuiRouteInfo fail"
\r
831 "tags" : [ "iuiRoute" ],
\r
832 "summary" : "delete one iuiRoute by serviceName",
\r
833 "description" : "",
\r
834 "operationId" : "deleteIuiRoute",
\r
835 "produces" : [ "application/json" ],
\r
837 "name" : "serviceName",
\r
839 "description" : "iuiRoute serviceName",
\r
845 "description" : "iuiRoute host",
\r
846 "required" : false,
\r
849 "name" : "publish_port",
\r
851 "description" : "iuiRoute Publish port",
\r
852 "required" : false,
\r
855 "name" : "routeWay",
\r
857 "description" : "Route Way",
\r
858 "required" : false,
\r
864 "description" : "delete IuiRouteInfo succeed "
\r
867 "description" : "IuiRouteInfo not found"
\r
870 "description" : "delete IuiRouteInfo fail"
\r
875 "/iuiRoute/{serviceName}/status/{status}" : {
\r
877 "tags" : [ "iuiRoute" ],
\r
878 "summary" : "update one iuiRoute status by serviceName ",
\r
879 "description" : "",
\r
880 "operationId" : "updateIuiRouteStatus",
\r
881 "produces" : [ "application/json" ],
\r
883 "name" : "serviceName",
\r
885 "description" : "iuiRoute serviceName",
\r
891 "description" : "iuiRoute host",
\r
892 "required" : false,
\r
897 "description" : "iuiRoute status,1?abled 0?disabled",
\r
901 "name" : "publish_port",
\r
903 "description" : "iuiRoute Publish port",
\r
904 "required" : false,
\r
907 "name" : "routeWay",
\r
909 "description" : "Route Way",
\r
910 "required" : false,
\r
916 "description" : "successful operation",
\r
918 "$ref" : "#/definitions/IuiRouteInfo"
\r
922 "description" : "IuiRouteInfo not found"
\r
925 "description" : "Unprocessable IuiRouteInfo Entity "
\r
928 "description" : "update IuiRouteInfo status fail"
\r
937 "required" : [ "servers", "serviceName", "url", "version" ],
\r
944 "example" : "/test",
\r
945 "description" : "Target Service URL,start with /"
\r
950 "description" : "[control Range] 0?default 1?readonly 2?hidden ",
\r
951 "enum" : [ "0", "1", "2" ]
\r
956 "description" : "[status] 1?abled 0?disabled ",
\r
957 "enum" : [ "0", "1" ]
\r
962 "description" : "[visual Range]interSystem:0,inSystem:1",
\r
963 "enum" : [ "0", "1" ]
\r
965 "useOwnUpstream" : {
\r
968 "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",
\r
969 "enum" : [ "0", "1" ]
\r
974 "$ref" : "#/definitions/RouteServer"
\r
987 "type" : "boolean",
\r
990 "consulServiceName" : {
\r
993 "publishProtocol" : {
\r
1004 "type" : "string",
\r
1006 "description" : "[apiJson Type] 0?local file 1? remote file",
\r
1007 "enum" : [ "0", "1" ]
\r
1014 "CustomRouteInfo" : {
\r
1015 "type" : "object",
\r
1016 "required" : [ "servers", "serviceName", "url" ],
\r
1022 "type" : "string",
\r
1023 "example" : "/test",
\r
1024 "description" : "Target Service URL,start with /"
\r
1027 "type" : "string",
\r
1029 "description" : "[control Range] 0?default 1?readonly 2?hidden ",
\r
1030 "enum" : [ "0", "1", "2" ]
\r
1033 "type" : "string",
\r
1035 "description" : "[status] 1?abled 0?disabled ",
\r
1036 "enum" : [ "0", "1" ]
\r
1039 "type" : "string",
\r
1041 "description" : "[visual Range]interSystem:0,inSystem:1",
\r
1042 "enum" : [ "0", "1" ]
\r
1044 "useOwnUpstream" : {
\r
1045 "type" : "string",
\r
1047 "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",
\r
1048 "enum" : [ "0", "1" ]
\r
1053 "$ref" : "#/definitions/RouteServer"
\r
1062 "publish_port" : {
\r
1066 "type" : "boolean",
\r
1069 "consulServiceName" : {
\r
1072 "publishProtocol" : {
\r
1077 "DiscoverInfo" : {
\r
1078 "type" : "object",
\r
1084 "type" : "integer",
\r
1085 "format" : "int32"
\r
1088 "type" : "boolean",
\r
1093 "IuiRouteInfo" : {
\r
1094 "type" : "object",
\r
1095 "required" : [ "servers", "serviceName", "url" ],
\r
1101 "type" : "string",
\r
1102 "example" : "/test",
\r
1103 "description" : "Target Service URL,start with /"
\r
1106 "type" : "string",
\r
1108 "description" : "[control Range] 0?default 1?readonly 2?hidden ",
\r
1109 "enum" : [ "0", "1", "2" ]
\r
1112 "type" : "string",
\r
1114 "description" : "[status] 1?abled 0?disabled ",
\r
1115 "enum" : [ "0", "1" ]
\r
1118 "type" : "string",
\r
1120 "description" : "[visual Range]interSystem:0,inSystem:1",
\r
1121 "enum" : [ "0", "1" ]
\r
1123 "useOwnUpstream" : {
\r
1124 "type" : "string",
\r
1126 "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",
\r
1127 "enum" : [ "0", "1" ]
\r
1132 "$ref" : "#/definitions/RouteServer"
\r
1141 "publish_port" : {
\r
1145 "type" : "boolean",
\r
1148 "consulServiceName" : {
\r
1151 "publishProtocol" : {
\r
1157 "type" : "object",
\r
1158 "required" : [ "ip", "port" ],
\r
1167 "type" : "integer",
\r
1168 "format" : "int32"
\r