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