apiroute/apiroute-service/src/main/resources/swagger.json

   1 {\r
   2   "swagger" : "2.0",\r
   3   "info" : {\r
   4     "description" : "MicroService Bus rest API",\r
   5     "version" : "1.0.0",\r
   6     "title" : "MicroService Bus rest API",\r
   7     "license" : {\r
   8       "name" : "https://wiki.onap.org/display/DW/Apache+2.0+License"\r
   9     }\r
  10   },\r
  11   "host" : "127.0.0.1:80",\r
  12   "basePath" : "/api/microservices/v1",\r
  13   "tags" : [ {\r
  14     "name" : "ApiRoute"\r
  15   }, {\r
  16     "name" : "CustomRoute"\r
  17   }, {\r
  18     "name" : "iuiRoute"\r
  19   } ],\r
  20   "schemes" : [ "http", "https" ],\r
  21   "paths" : {\r
  22     "/apiRoute" : {\r
  23       "get" : {\r
  24         "tags" : [ "ApiRoute" ],\r
  25         "summary" : "get all ApiRoute ",\r
  26         "description" : "",\r
  27         "operationId" : "getApiRoutes",\r
  28         "produces" : [ "application/json" ],\r
  29         "parameters" : [ {\r
  30           "name" : "routeWay",\r
  31           "in" : "query",\r
  32           "description" : "Route Way",\r
  33           "required" : false,\r
  34           "type" : "string",\r
  35           "default" : "ip"\r
  36         } ],\r
  37         "responses" : {\r
  38           "200" : {\r
  39             "description" : "successful operation",\r
  40             "schema" : {\r
  41               "type" : "array",\r
  42               "items" : {\r
  43                 "$ref" : "#/definitions/ApiRouteInfo"\r
  44               }\r
  45             }\r
  46           },\r
  47           "500" : {\r
  48             "description" : "get ApiRouteInfo List  fail"\r
  49           }\r
  50         }\r
  51       },\r
  52       "post" : {\r
  53         "tags" : [ "ApiRoute" ],\r
  54         "summary" : "add one ApiRoute ",\r
  55         "description" : "",\r
  56         "operationId" : "addApiRoute",\r
  57         "produces" : [ "application/json" ],\r
  58         "parameters" : [ {\r
  59           "in" : "body",\r
  60           "name" : "body",\r
  61           "description" : "ApiRoute Instance Info",\r
  62           "required" : true,\r
  63           "schema" : {\r
  64             "$ref" : "#/definitions/ApiRouteInfo"\r
  65           }\r
  66         }, {\r
  67           "name" : "routeWay",\r
  68           "in" : "query",\r
  69           "description" : "Route Way",\r
  70           "required" : false,\r
  71           "type" : "string",\r
  72           "default" : "ip"\r
  73         } ],\r
  74         "responses" : {\r
  75           "201" : {\r
  76             "description" : "successful operation",\r
  77             "schema" : {\r
  78               "$ref" : "#/definitions/ApiRouteInfo"\r
  79             }\r
  80           },\r
  81           "400" : {\r
  82             "description" : "Unprocessable ApiRouteInfo JSON REQUEST"\r
  83           },\r
  84           "422" : {\r
  85             "description" : "Unprocessable ApiRouteInfo Entity "\r
  86           },\r
  87           "500" : {\r
  88             "description" : "add ApiRouteInfo fail"\r
  89           }\r
  90         }\r
  91       }\r
  92     },\r
  93     "/apiRoute/apiDocs" : {\r
  94       "get" : {\r
  95         "tags" : [ "ApiRoute" ],\r
  96         "summary" : "get all Local apiDoc ",\r
  97         "description" : "",\r
  98         "operationId" : "getApiDocs",\r
  99         "produces" : [ "application/json" ],\r
 100         "responses" : {\r
 101           "200" : {\r
 102             "description" : "successful operation",\r
 103             "schema" : {\r
 104               "type" : "array",\r
 105               "items" : {\r
 106                 "type" : "string"\r
 107               }\r
 108             }\r
 109           },\r
 110           "500" : {\r
 111             "description" : "get apiDoc List  fail"\r
 112           }\r
 113         }\r
 114       }\r
 115     },\r
 116     "/apiRoute/discoverInfo" : {\r
 117       "get" : {\r
 118         "tags" : [ "ApiRoute" ],\r
 119         "summary" : "get discover Info ",\r
 120         "description" : "",\r
 121         "operationId" : "getServiceDiscoverInfo",\r
 122         "produces" : [ "application/json" ],\r
 123         "responses" : {\r
 124           "200" : {\r
 125             "description" : "successful operation",\r
 126             "schema" : {\r
 127               "$ref" : "#/definitions/DiscoverInfo"\r
 128             }\r
 129           },\r
 130           "500" : {\r
 131             "description" : "get discover Info fail"\r
 132           }\r
 133         }\r
 134       }\r
 135     },\r
 136     "/apiRoute/export" : {\r
 137       "get" : {\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
 143         "parameters" : [ {\r
 144           "name" : "routeWay",\r
 145           "in" : "query",\r
 146           "description" : "Route Way",\r
 147           "required" : false,\r
 148           "type" : "string",\r
 149           "default" : "ip"\r
 150         } ],\r
 151         "responses" : {\r
 152           "200" : {\r
 153             "description" : "successful operation",\r
 154             "schema" : {\r
 155               "type" : "string"\r
 156             }\r
 157           },\r
 158           "406" : {\r
 159             "description" : " not Acceptable client-side"\r
 160           },\r
 161           "500" : {\r
 162             "description" : "export fail"\r
 163           }\r
 164         }\r
 165       }\r
 166     },\r
 167     "/apiRoute/{serviceName}/version/{version}" : {\r
 168       "get" : {\r
 169         "tags" : [ "ApiRoute" ],\r
 170         "summary" : "get one ApiRoute ",\r
 171         "description" : "",\r
 172         "operationId" : "getApiRoute",\r
 173         "produces" : [ "application/json" ],\r
 174         "parameters" : [ {\r
 175           "name" : "serviceName",\r
 176           "in" : "path",\r
 177           "description" : "ApiRoute serviceName",\r
 178           "required" : true,\r
 179           "type" : "string"\r
 180         }, {\r
 181           "name" : "version",\r
 182           "in" : "path",\r
 183           "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
 184           "required" : true,\r
 185           "type" : "string"\r
 186         }, {\r
 187           "name" : "host",\r
 188           "in" : "query",\r
 189           "description" : "ApiRoute host",\r
 190           "required" : false,\r
 191           "type" : "string"\r
 192         }, {\r
 193           "name" : "publish_port",\r
 194           "in" : "query",\r
 195           "description" : "ApiRoute Publish port",\r
 196           "required" : false,\r
 197           "type" : "string"\r
 198         }, {\r
 199           "name" : "routeWay",\r
 200           "in" : "query",\r
 201           "description" : "Route Way",\r
 202           "required" : false,\r
 203           "type" : "string",\r
 204           "default" : "ip"\r
 205         } ],\r
 206         "responses" : {\r
 207           "200" : {\r
 208             "description" : "successful operation",\r
 209             "schema" : {\r
 210               "$ref" : "#/definitions/ApiRouteInfo"\r
 211             }\r
 212           },\r
 213           "404" : {\r
 214             "description" : "ApiRouteInfo not found"\r
 215           },\r
 216           "422" : {\r
 217             "description" : "Unprocessable ApiRouteInfo Entity "\r
 218           },\r
 219           "500" : {\r
 220             "description" : "get ApiRouteInfo fail"\r
 221           }\r
 222         }\r
 223       },\r
 224       "put" : {\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
 230         "parameters" : [ {\r
 231           "name" : "serviceName",\r
 232           "in" : "path",\r
 233           "description" : "ApiRoute serviceName",\r
 234           "required" : true,\r
 235           "type" : "string"\r
 236         }, {\r
 237           "name" : "version",\r
 238           "in" : "path",\r
 239           "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
 240           "required" : true,\r
 241           "type" : "string"\r
 242         }, {\r
 243           "in" : "body",\r
 244           "name" : "body",\r
 245           "description" : "ApiRoute Instance Info",\r
 246           "required" : true,\r
 247           "schema" : {\r
 248             "$ref" : "#/definitions/ApiRouteInfo"\r
 249           }\r
 250         }, {\r
 251           "name" : "routeWay",\r
 252           "in" : "query",\r
 253           "description" : "Route Way",\r
 254           "required" : false,\r
 255           "type" : "string",\r
 256           "default" : "ip"\r
 257         } ],\r
 258         "responses" : {\r
 259           "201" : {\r
 260             "description" : "successful operation",\r
 261             "schema" : {\r
 262               "$ref" : "#/definitions/ApiRouteInfo"\r
 263             }\r
 264           },\r
 265           "400" : {\r
 266             "description" : "Unprocessable ApiRouteInfo JSON REQUEST"\r
 267           },\r
 268           "422" : {\r
 269             "description" : "Unprocessable ApiRouteInfo Entity "\r
 270           },\r
 271           "500" : {\r
 272             "description" : "update ApiRouteInfo fail"\r
 273           }\r
 274         }\r
 275       },\r
 276       "delete" : {\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
 282         "parameters" : [ {\r
 283           "name" : "serviceName",\r
 284           "in" : "path",\r
 285           "description" : "ApiRoute serviceName",\r
 286           "required" : true,\r
 287           "type" : "string"\r
 288         }, {\r
 289           "name" : "version",\r
 290           "in" : "path",\r
 291           "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
 292           "required" : true,\r
 293           "type" : "string"\r
 294         }, {\r
 295           "name" : "host",\r
 296           "in" : "query",\r
 297           "description" : "ApiRoute host",\r
 298           "required" : false,\r
 299           "type" : "string"\r
 300         }, {\r
 301           "name" : "publish_port",\r
 302           "in" : "query",\r
 303           "description" : "ApiRoute Publish port",\r
 304           "required" : false,\r
 305           "type" : "string"\r
 306         }, {\r
 307           "name" : "routeWay",\r
 308           "in" : "query",\r
 309           "description" : "Route Way",\r
 310           "required" : false,\r
 311           "type" : "string",\r
 312           "default" : "ip"\r
 313         } ],\r
 314         "responses" : {\r
 315           "204" : {\r
 316             "description" : "delete ApiRouteInfo succeed "\r
 317           },\r
 318           "404" : {\r
 319             "description" : "ApiRouteInfo not found"\r
 320           },\r
 321           "500" : {\r
 322             "description" : "delete ApiRouteInfo fail"\r
 323           }\r
 324         }\r
 325       }\r
 326     },\r
 327     "/apiRoute/{serviceName}/version/{version}/status/{status}" : {\r
 328       "put" : {\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
 334         "parameters" : [ {\r
 335           "name" : "serviceName",\r
 336           "in" : "path",\r
 337           "description" : "ApiRoute serviceName",\r
 338           "required" : true,\r
 339           "type" : "string"\r
 340         }, {\r
 341           "name" : "version",\r
 342           "in" : "path",\r
 343           "description" : "ApiRoute version,if the version is empty, please enter \"null\"",\r
 344           "required" : true,\r
 345           "type" : "string"\r
 346         }, {\r
 347           "name" : "status",\r
 348           "in" : "path",\r
 349           "description" : "ApiRoute status,1?abled  0?disabled",\r
 350           "required" : true,\r
 351           "type" : "string"\r
 352         }, {\r
 353           "name" : "host",\r
 354           "in" : "query",\r
 355           "description" : "ApiRoute host",\r
 356           "required" : false,\r
 357           "type" : "string"\r
 358         }, {\r
 359           "name" : "publish_port",\r
 360           "in" : "query",\r
 361           "description" : "ApiRoute Publish port",\r
 362           "required" : false,\r
 363           "type" : "string"\r
 364         }, {\r
 365           "name" : "routeWay",\r
 366           "in" : "query",\r
 367           "description" : "Route Way",\r
 368           "required" : false,\r
 369           "type" : "string",\r
 370           "default" : "ip"\r
 371         } ],\r
 372         "responses" : {\r
 373           "201" : {\r
 374             "description" : "successful operation",\r
 375             "schema" : {\r
 376               "$ref" : "#/definitions/ApiRouteInfo"\r
 377             }\r
 378           },\r
 379           "404" : {\r
 380             "description" : "ApiRouteInfo not found"\r
 381           },\r
 382           "422" : {\r
 383             "description" : "Unprocessable ApiRouteInfo Entity "\r
 384           },\r
 385           "500" : {\r
 386             "description" : "update status fail"\r
 387           }\r
 388         }\r
 389       }\r
 390     },\r
 391     "/customRoute/all" : {\r
 392       "get" : {\r
 393         "tags" : [ "CustomRoute" ],\r
 394         "summary" : "get all CustomRoute ",\r
 395         "description" : "",\r
 396         "operationId" : "getCustomRoutes",\r
 397         "produces" : [ "application/json" ],\r
 398         "parameters" : [ {\r
 399           "name" : "routeWay",\r
 400           "in" : "query",\r
 401           "description" : "Route Way",\r
 402           "required" : false,\r
 403           "type" : "string",\r
 404           "default" : "ip"\r
 405         } ],\r
 406         "responses" : {\r
 407           "200" : {\r
 408             "description" : "successful operation",\r
 409             "schema" : {\r
 410               "type" : "array",\r
 411               "items" : {\r
 412                 "$ref" : "#/definitions/CustomRouteInfo"\r
 413               }\r
 414             }\r
 415           },\r
 416           "500" : {\r
 417             "description" : "get CustomRouteInfo List  fail"\r
 418           }\r
 419         }\r
 420       }\r
 421     },\r
 422     "/customRoute/instance" : {\r
 423       "get" : {\r
 424         "tags" : [ "CustomRoute" ],\r
 425         "summary" : "get one CustomRoute ",\r
 426         "description" : "",\r
 427         "operationId" : "getCustomRoute",\r
 428         "produces" : [ "application/json" ],\r
 429         "parameters" : [ {\r
 430           "name" : "serviceName",\r
 431           "in" : "query",\r
 432           "description" : "CustomRoute serviceName",\r
 433           "required" : false,\r
 434           "type" : "string"\r
 435         }, {\r
 436           "name" : "host",\r
 437           "in" : "query",\r
 438           "description" : "CustomRoute host",\r
 439           "required" : false,\r
 440           "type" : "string"\r
 441         }, {\r
 442           "name" : "publish_port",\r
 443           "in" : "query",\r
 444           "description" : "CustomRoute Publish port",\r
 445           "required" : false,\r
 446           "type" : "string"\r
 447         }, {\r
 448           "name" : "routeWay",\r
 449           "in" : "query",\r
 450           "description" : "Route Way",\r
 451           "required" : false,\r
 452           "type" : "string",\r
 453           "default" : "ip"\r
 454         } ],\r
 455         "responses" : {\r
 456           "200" : {\r
 457             "description" : "successful operation",\r
 458             "schema" : {\r
 459               "$ref" : "#/definitions/CustomRouteInfo"\r
 460             }\r
 461           },\r
 462           "404" : {\r
 463             "description" : "CustomRoute not found"\r
 464           },\r
 465           "422" : {\r
 466             "description" : "Unprocessable CustomRoute Entity "\r
 467           },\r
 468           "500" : {\r
 469             "description" : "get CustomRoute fail"\r
 470           }\r
 471         }\r
 472       },\r
 473       "post" : {\r
 474         "tags" : [ "CustomRoute" ],\r
 475         "summary" : "add one CustomRoute ",\r
 476         "description" : "",\r
 477         "operationId" : "addCustomRoute",\r
 478         "produces" : [ "application/json" ],\r
 479         "parameters" : [ {\r
 480           "in" : "body",\r
 481           "name" : "body",\r
 482           "description" : "CustomRoute Instance Info",\r
 483           "required" : true,\r
 484           "schema" : {\r
 485             "$ref" : "#/definitions/CustomRouteInfo"\r
 486           }\r
 487         }, {\r
 488           "name" : "routeWay",\r
 489           "in" : "query",\r
 490           "description" : "Route Way",\r
 491           "required" : false,\r
 492           "type" : "string",\r
 493           "default" : "ip"\r
 494         } ],\r
 495         "responses" : {\r
 496           "201" : {\r
 497             "description" : "successful operation",\r
 498             "schema" : {\r
 499               "$ref" : "#/definitions/CustomRouteInfo"\r
 500             }\r
 501           },\r
 502           "400" : {\r
 503             "description" : "Unprocessable CustomRouteInfo JSON REQUEST"\r
 504           },\r
 505           "422" : {\r
 506             "description" : "Unprocessable CustomRouteInfo Entity "\r
 507           },\r
 508           "500" : {\r
 509             "description" : "add CustomRouteInfo fail"\r
 510           }\r
 511         }\r
 512       },\r
 513       "put" : {\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
 519         "parameters" : [ {\r
 520           "name" : "serviceName",\r
 521           "in" : "query",\r
 522           "description" : "CustomRoute serviceName",\r
 523           "required" : true,\r
 524           "type" : "string"\r
 525         }, {\r
 526           "in" : "body",\r
 527           "name" : "body",\r
 528           "description" : "CustomRoute Instance Info",\r
 529           "required" : true,\r
 530           "schema" : {\r
 531             "$ref" : "#/definitions/CustomRouteInfo"\r
 532           }\r
 533         }, {\r
 534           "name" : "routeWay",\r
 535           "in" : "query",\r
 536           "description" : "Route Way",\r
 537           "required" : false,\r
 538           "type" : "string",\r
 539           "default" : "ip"\r
 540         } ],\r
 541         "responses" : {\r
 542           "201" : {\r
 543             "description" : "successful operation",\r
 544             "schema" : {\r
 545               "$ref" : "#/definitions/CustomRouteInfo"\r
 546             }\r
 547           },\r
 548           "400" : {\r
 549             "description" : "Unprocessable CustomRoute JSON REQUEST"\r
 550           },\r
 551           "422" : {\r
 552             "description" : "Unprocessable CustomRoute Entity "\r
 553           },\r
 554           "500" : {\r
 555             "description" : "update CustomRoute fail"\r
 556           }\r
 557         }\r
 558       },\r
 559       "delete" : {\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
 565         "parameters" : [ {\r
 566           "name" : "serviceName",\r
 567           "in" : "query",\r
 568           "description" : "CustomRoute serviceName",\r
 569           "required" : true,\r
 570           "type" : "string"\r
 571         }, {\r
 572           "name" : "host",\r
 573           "in" : "query",\r
 574           "description" : "CustomRoute host",\r
 575           "required" : false,\r
 576           "type" : "string"\r
 577         }, {\r
 578           "name" : "publish_port",\r
 579           "in" : "query",\r
 580           "description" : "CustomRoute Publish port",\r
 581           "required" : false,\r
 582           "type" : "string"\r
 583         }, {\r
 584           "name" : "routeWay",\r
 585           "in" : "query",\r
 586           "description" : "Route Way",\r
 587           "required" : false,\r
 588           "type" : "string",\r
 589           "default" : "ip"\r
 590         } ],\r
 591         "responses" : {\r
 592           "204" : {\r
 593             "description" : "delete customRoute succeed "\r
 594           },\r
 595           "404" : {\r
 596             "description" : "customRoute not found"\r
 597           },\r
 598           "500" : {\r
 599             "description" : "delete customRoute fail"\r
 600           }\r
 601         }\r
 602       }\r
 603     },\r
 604     "/customRoute/status" : {\r
 605       "put" : {\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
 611         "parameters" : [ {\r
 612           "name" : "serviceName",\r
 613           "in" : "query",\r
 614           "description" : "CustomRoute serviceName",\r
 615           "required" : true,\r
 616           "type" : "string"\r
 617         }, {\r
 618           "name" : "host",\r
 619           "in" : "query",\r
 620           "description" : "CustomRoute host",\r
 621           "required" : false,\r
 622           "type" : "string"\r
 623         }, {\r
 624           "name" : "status",\r
 625           "in" : "query",\r
 626           "description" : "CustomRoute status,1?abled  0?disabled",\r
 627           "required" : true,\r
 628           "type" : "string"\r
 629         }, {\r
 630           "name" : "publish_port",\r
 631           "in" : "query",\r
 632           "description" : "CustomRoute Publish port",\r
 633           "required" : false,\r
 634           "type" : "string"\r
 635         }, {\r
 636           "name" : "routeWay",\r
 637           "in" : "query",\r
 638           "description" : "Route Way",\r
 639           "required" : false,\r
 640           "type" : "string",\r
 641           "default" : "ip"\r
 642         } ],\r
 643         "responses" : {\r
 644           "201" : {\r
 645             "description" : "successful operation",\r
 646             "schema" : {\r
 647               "$ref" : "#/definitions/CustomRouteInfo"\r
 648             }\r
 649           },\r
 650           "404" : {\r
 651             "description" : "customRoute not found"\r
 652           },\r
 653           "422" : {\r
 654             "description" : "Unprocessable customRoute Entity "\r
 655           },\r
 656           "500" : {\r
 657             "description" : "update status fail"\r
 658           }\r
 659         }\r
 660       }\r
 661     },\r
 662     "/iuiRoute" : {\r
 663       "get" : {\r
 664         "tags" : [ "iuiRoute" ],\r
 665         "summary" : "get all iuiRoute ",\r
 666         "description" : "",\r
 667         "operationId" : "getIuiRoutes",\r
 668         "produces" : [ "application/json" ],\r
 669         "parameters" : [ {\r
 670           "name" : "routeWay",\r
 671           "in" : "query",\r
 672           "description" : "Route Way",\r
 673           "required" : false,\r
 674           "type" : "string",\r
 675           "default" : "ip"\r
 676         } ],\r
 677         "responses" : {\r
 678           "200" : {\r
 679             "description" : "successful operation",\r
 680             "schema" : {\r
 681               "type" : "array",\r
 682               "items" : {\r
 683                 "$ref" : "#/definitions/IuiRouteInfo"\r
 684               }\r
 685             }\r
 686           },\r
 687           "500" : {\r
 688             "description" : "get iuiRouteInfo List  fail"\r
 689           }\r
 690         }\r
 691       },\r
 692       "post" : {\r
 693         "tags" : [ "iuiRoute" ],\r
 694         "summary" : "add one iuiRoute ",\r
 695         "description" : "",\r
 696         "operationId" : "addIuiRoute",\r
 697         "produces" : [ "application/json" ],\r
 698         "parameters" : [ {\r
 699           "in" : "body",\r
 700           "name" : "body",\r
 701           "description" : "iuiRoute Instance Info",\r
 702           "required" : true,\r
 703           "schema" : {\r
 704             "$ref" : "#/definitions/IuiRouteInfo"\r
 705           }\r
 706         }, {\r
 707           "name" : "routeWay",\r
 708           "in" : "query",\r
 709           "description" : "Route Way",\r
 710           "required" : false,\r
 711           "type" : "string",\r
 712           "default" : "ip"\r
 713         } ],\r
 714         "responses" : {\r
 715           "201" : {\r
 716             "description" : "successful operation",\r
 717             "schema" : {\r
 718               "$ref" : "#/definitions/IuiRouteInfo"\r
 719             }\r
 720           },\r
 721           "400" : {\r
 722             "description" : "Unprocessable iuiRouteInfo JSON REQUEST"\r
 723           },\r
 724           "422" : {\r
 725             "description" : "Unprocessable iuiRouteInfo Entity "\r
 726           },\r
 727           "500" : {\r
 728             "description" : "add iuiRouteInfo fail"\r
 729           }\r
 730         }\r
 731       }\r
 732     },\r
 733     "/iuiRoute/{serviceName}" : {\r
 734       "get" : {\r
 735         "tags" : [ "iuiRoute" ],\r
 736         "summary" : "get one iuiRoute ",\r
 737         "description" : "",\r
 738         "operationId" : "getIuiRoute",\r
 739         "produces" : [ "application/json" ],\r
 740         "parameters" : [ {\r
 741           "name" : "serviceName",\r
 742           "in" : "path",\r
 743           "description" : "iuiRoute serviceName",\r
 744           "required" : true,\r
 745           "type" : "string"\r
 746         }, {\r
 747           "name" : "host",\r
 748           "in" : "query",\r
 749           "description" : "iuiRoute host",\r
 750           "required" : false,\r
 751           "type" : "string"\r
 752         }, {\r
 753           "name" : "publish_port",\r
 754           "in" : "query",\r
 755           "description" : "iuiRoute Publish port",\r
 756           "required" : false,\r
 757           "type" : "string"\r
 758         }, {\r
 759           "name" : "routeWay",\r
 760           "in" : "query",\r
 761           "description" : "Route Way",\r
 762           "required" : false,\r
 763           "type" : "string",\r
 764           "default" : "ip"\r
 765         } ],\r
 766         "responses" : {\r
 767           "200" : {\r
 768             "description" : "successful operation",\r
 769             "schema" : {\r
 770               "$ref" : "#/definitions/IuiRouteInfo"\r
 771             }\r
 772           },\r
 773           "404" : {\r
 774             "description" : "IuiRouteInfo not found"\r
 775           },\r
 776           "422" : {\r
 777             "description" : "Unprocessable IuiRouteInfo Entity "\r
 778           },\r
 779           "500" : {\r
 780             "description" : "get IuiRouteInfo fail"\r
 781           }\r
 782         }\r
 783       },\r
 784       "put" : {\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
 790         "parameters" : [ {\r
 791           "name" : "serviceName",\r
 792           "in" : "path",\r
 793           "description" : "iuiRoute serviceName",\r
 794           "required" : true,\r
 795           "type" : "string"\r
 796         }, {\r
 797           "in" : "body",\r
 798           "name" : "body",\r
 799           "description" : "iuiRoute Instance Info",\r
 800           "required" : true,\r
 801           "schema" : {\r
 802             "$ref" : "#/definitions/IuiRouteInfo"\r
 803           }\r
 804         }, {\r
 805           "name" : "routeWay",\r
 806           "in" : "query",\r
 807           "description" : "Route Way",\r
 808           "required" : false,\r
 809           "type" : "string",\r
 810           "default" : "ip"\r
 811         } ],\r
 812         "responses" : {\r
 813           "201" : {\r
 814             "description" : "successful operation",\r
 815             "schema" : {\r
 816               "$ref" : "#/definitions/IuiRouteInfo"\r
 817             }\r
 818           },\r
 819           "400" : {\r
 820             "description" : "Unprocessable IuiRouteInfo JSON REQUEST"\r
 821           },\r
 822           "422" : {\r
 823             "description" : "Unprocessable IuiRouteInfo Entity "\r
 824           },\r
 825           "500" : {\r
 826             "description" : "update IuiRouteInfo fail"\r
 827           }\r
 828         }\r
 829       },\r
 830       "delete" : {\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
 836         "parameters" : [ {\r
 837           "name" : "serviceName",\r
 838           "in" : "path",\r
 839           "description" : "iuiRoute serviceName",\r
 840           "required" : true,\r
 841           "type" : "string"\r
 842         }, {\r
 843           "name" : "host",\r
 844           "in" : "query",\r
 845           "description" : "iuiRoute host",\r
 846           "required" : false,\r
 847           "type" : "string"\r
 848         }, {\r
 849           "name" : "publish_port",\r
 850           "in" : "query",\r
 851           "description" : "iuiRoute Publish port",\r
 852           "required" : false,\r
 853           "type" : "string"\r
 854         }, {\r
 855           "name" : "routeWay",\r
 856           "in" : "query",\r
 857           "description" : "Route Way",\r
 858           "required" : false,\r
 859           "type" : "string",\r
 860           "default" : "ip"\r
 861         } ],\r
 862         "responses" : {\r
 863           "204" : {\r
 864             "description" : "delete IuiRouteInfo succeed "\r
 865           },\r
 866           "404" : {\r
 867             "description" : "IuiRouteInfo not found"\r
 868           },\r
 869           "500" : {\r
 870             "description" : "delete IuiRouteInfo fail"\r
 871           }\r
 872         }\r
 873       }\r
 874     },\r
 875     "/iuiRoute/{serviceName}/status/{status}" : {\r
 876       "put" : {\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
 882         "parameters" : [ {\r
 883           "name" : "serviceName",\r
 884           "in" : "path",\r
 885           "description" : "iuiRoute serviceName",\r
 886           "required" : true,\r
 887           "type" : "string"\r
 888         }, {\r
 889           "name" : "host",\r
 890           "in" : "query",\r
 891           "description" : "iuiRoute host",\r
 892           "required" : false,\r
 893           "type" : "string"\r
 894         }, {\r
 895           "name" : "status",\r
 896           "in" : "path",\r
 897           "description" : "iuiRoute status,1?abled  0?disabled",\r
 898           "required" : true,\r
 899           "type" : "string"\r
 900         }, {\r
 901           "name" : "publish_port",\r
 902           "in" : "query",\r
 903           "description" : "iuiRoute Publish port",\r
 904           "required" : false,\r
 905           "type" : "string"\r
 906         }, {\r
 907           "name" : "routeWay",\r
 908           "in" : "query",\r
 909           "description" : "Route Way",\r
 910           "required" : false,\r
 911           "type" : "string",\r
 912           "default" : "ip"\r
 913         } ],\r
 914         "responses" : {\r
 915           "201" : {\r
 916             "description" : "successful operation",\r
 917             "schema" : {\r
 918               "$ref" : "#/definitions/IuiRouteInfo"\r
 919             }\r
 920           },\r
 921           "404" : {\r
 922             "description" : "IuiRouteInfo not found"\r
 923           },\r
 924           "422" : {\r
 925             "description" : "Unprocessable IuiRouteInfo Entity "\r
 926           },\r
 927           "500" : {\r
 928             "description" : "update IuiRouteInfo status fail"\r
 929           }\r
 930         }\r
 931       }\r
 932     }\r
 933   },\r
 934   "definitions" : {\r
 935     "ApiRouteInfo" : {\r
 936       "type" : "object",\r
 937       "required" : [ "servers", "serviceName", "url", "version" ],\r
 938       "properties" : {\r
 939         "serviceName" : {\r
 940           "type" : "string"\r
 941         },\r
 942         "url" : {\r
 943           "type" : "string",\r
 944           "example" : "/test",\r
 945           "description" : "Target Service URL,start with /"\r
 946         },\r
 947         "control" : {\r
 948           "type" : "string",\r
 949           "example" : "0",\r
 950           "description" : "[control Range] 0?default   1?readonly  2?hidden ",\r
 951           "enum" : [ "0", "1", "2" ]\r
 952         },\r
 953         "status" : {\r
 954           "type" : "string",\r
 955           "example" : "1",\r
 956           "description" : "[status] 1?abled    0?disabled ",\r
 957           "enum" : [ "0", "1" ]\r
 958         },\r
 959         "visualRange" : {\r
 960           "type" : "string",\r
 961           "example" : "1",\r
 962           "description" : "[visual Range]interSystem:0,inSystem:1",\r
 963           "enum" : [ "0", "1" ]\r
 964         },\r
 965         "useOwnUpstream" : {\r
 966           "type" : "string",\r
 967           "example" : "0",\r
 968           "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",\r
 969           "enum" : [ "0", "1" ]\r
 970         },\r
 971         "servers" : {\r
 972           "type" : "array",\r
 973           "items" : {\r
 974             "$ref" : "#/definitions/RouteServer"\r
 975           }\r
 976         },\r
 977         "host" : {\r
 978           "type" : "string"\r
 979         },\r
 980         "namespace" : {\r
 981           "type" : "string"\r
 982         },\r
 983         "publish_port" : {\r
 984           "type" : "string"\r
 985         },\r
 986         "enable_ssl" : {\r
 987           "type" : "boolean",\r
 988           "default" : false\r
 989         },\r
 990         "consulServiceName" : {\r
 991           "type" : "string"\r
 992         },\r
 993         "publishProtocol" : {\r
 994           "type" : "string"\r
 995         },\r
 996         "version" : {\r
 997           "type" : "string",\r
 998           "example" : "v1"\r
 999         },\r
1000         "apiJson" : {\r
1001           "type" : "string"\r
1002         },\r
1003         "apiJsonType" : {\r
1004           "type" : "string",\r
1005           "example" : "1",\r
1006           "description" : "[apiJson Type] 0?local file  1? remote file",\r
1007           "enum" : [ "0", "1" ]\r
1008         },\r
1009         "metricsUrl" : {\r
1010           "type" : "string"\r
1011         }\r
1012       }\r
1013     },\r
1014     "CustomRouteInfo" : {\r
1015       "type" : "object",\r
1016       "required" : [ "servers", "serviceName", "url" ],\r
1017       "properties" : {\r
1018         "serviceName" : {\r
1019           "type" : "string"\r
1020         },\r
1021         "url" : {\r
1022           "type" : "string",\r
1023           "example" : "/test",\r
1024           "description" : "Target Service URL,start with /"\r
1025         },\r
1026         "control" : {\r
1027           "type" : "string",\r
1028           "example" : "0",\r
1029           "description" : "[control Range] 0?default   1?readonly  2?hidden ",\r
1030           "enum" : [ "0", "1", "2" ]\r
1031         },\r
1032         "status" : {\r
1033           "type" : "string",\r
1034           "example" : "1",\r
1035           "description" : "[status] 1?abled    0?disabled ",\r
1036           "enum" : [ "0", "1" ]\r
1037         },\r
1038         "visualRange" : {\r
1039           "type" : "string",\r
1040           "example" : "1",\r
1041           "description" : "[visual Range]interSystem:0,inSystem:1",\r
1042           "enum" : [ "0", "1" ]\r
1043         },\r
1044         "useOwnUpstream" : {\r
1045           "type" : "string",\r
1046           "example" : "0",\r
1047           "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",\r
1048           "enum" : [ "0", "1" ]\r
1049         },\r
1050         "servers" : {\r
1051           "type" : "array",\r
1052           "items" : {\r
1053             "$ref" : "#/definitions/RouteServer"\r
1054           }\r
1055         },\r
1056         "host" : {\r
1057           "type" : "string"\r
1058         },\r
1059         "namespace" : {\r
1060           "type" : "string"\r
1061         },\r
1062         "publish_port" : {\r
1063           "type" : "string"\r
1064         },\r
1065         "enable_ssl" : {\r
1066           "type" : "boolean",\r
1067           "default" : false\r
1068         },\r
1069         "consulServiceName" : {\r
1070           "type" : "string"\r
1071         },\r
1072         "publishProtocol" : {\r
1073           "type" : "string"\r
1074         }\r
1075       }\r
1076     },\r
1077     "DiscoverInfo" : {\r
1078       "type" : "object",\r
1079       "properties" : {\r
1080         "ip" : {\r
1081           "type" : "string"\r
1082         },\r
1083         "port" : {\r
1084           "type" : "integer",\r
1085           "format" : "int32"\r
1086         },\r
1087         "enabled" : {\r
1088           "type" : "boolean",\r
1089           "default" : false\r
1090         }\r
1091       }\r
1092     },\r
1093     "IuiRouteInfo" : {\r
1094       "type" : "object",\r
1095       "required" : [ "servers", "serviceName", "url" ],\r
1096       "properties" : {\r
1097         "serviceName" : {\r
1098           "type" : "string"\r
1099         },\r
1100         "url" : {\r
1101           "type" : "string",\r
1102           "example" : "/test",\r
1103           "description" : "Target Service URL,start with /"\r
1104         },\r
1105         "control" : {\r
1106           "type" : "string",\r
1107           "example" : "0",\r
1108           "description" : "[control Range] 0?default   1?readonly  2?hidden ",\r
1109           "enum" : [ "0", "1", "2" ]\r
1110         },\r
1111         "status" : {\r
1112           "type" : "string",\r
1113           "example" : "1",\r
1114           "description" : "[status] 1?abled    0?disabled ",\r
1115           "enum" : [ "0", "1" ]\r
1116         },\r
1117         "visualRange" : {\r
1118           "type" : "string",\r
1119           "example" : "1",\r
1120           "description" : "[visual Range]interSystem:0,inSystem:1",\r
1121           "enum" : [ "0", "1" ]\r
1122         },\r
1123         "useOwnUpstream" : {\r
1124           "type" : "string",\r
1125           "example" : "0",\r
1126           "description" : "[LB Policy]non_ip_hash:0,ip_hash:1",\r
1127           "enum" : [ "0", "1" ]\r
1128         },\r
1129         "servers" : {\r
1130           "type" : "array",\r
1131           "items" : {\r
1132             "$ref" : "#/definitions/RouteServer"\r
1133           }\r
1134         },\r
1135         "host" : {\r
1136           "type" : "string"\r
1137         },\r
1138         "namespace" : {\r
1139           "type" : "string"\r
1140         },\r
1141         "publish_port" : {\r
1142           "type" : "string"\r
1143         },\r
1144         "enable_ssl" : {\r
1145           "type" : "boolean",\r
1146           "default" : false\r
1147         },\r
1148         "consulServiceName" : {\r
1149           "type" : "string"\r
1150         },\r
1151         "publishProtocol" : {\r
1152           "type" : "string"\r
1153         }\r
1154       }\r
1155     },\r
1156     "RouteServer" : {\r
1157       "type" : "object",\r
1158       "required" : [ "ip", "port" ],\r
1159       "properties" : {\r
1160         "ip" : {\r
1161           "type" : "string"\r
1162         },\r
1163         "port" : {\r
1164           "type" : "string"\r
1165         },\r
1166         "weight" : {\r
1167           "type" : "integer",\r
1168           "format" : "int32"\r
1169         }\r
1170       }\r
1171     }\r
1172   }\r
1173 }