starsz commented on a change in pull request #1765: URL: https://github.com/apache/apisix-dashboard/pull/1765#discussion_r634856094
########## File path: docs/en/latest/api/api.md ########## @@ -21,351 +21,881 @@ title: API doc of Manager API. # --> +## Description + Manager API directly operates ETCD and provides data management for Apache APISIX, provides APIs for Front-end or other clients. -**License:** [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) +We could pass parameters to APIs to control APISIX Nodes. To have a better understanding about how it works, please see [README](https://github.com/apache/apisix-dashboard/blob/master/README.md). -### /apisix/admin/check_ssl_cert +9000 is the default port on which the Manager API listens. You could take another port by modifying the [conf/conf.yaml](https://github.com/apache/apisix-dashboard/blob/master/api/conf/conf.yaml) file. + +## Authentication + +Before invoking other APIs, you need to log in first. + + +### /apisix/admin/user/login #### POST +##### Description: + +User login + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | + + +##### Request Body + +| Name | Type | Description | Required | +| ---- | ---- | ----------- | -------- | +| username | string | the username of your account | Yes | +| password | string | the password of your account | Yes | + + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response Data](#universal_response_data) | + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| token | string | The token signed after user login. Other APIs need to carry the token for identity verification.| + + +#### Example + +```shell +# Create a route +$ curl http://127.0.0.1:9000/apisix/admin/user/login -X POST -i -d ' +{ + "username": "admin", + "password": "admin" +}' + +HTTP/1.1 200 OK +... + +{"code":0,"message":"","data":{"token":"token-returned-by-login-api"},"request_id":"cd53eef7-56e2-4a74-a91d-e48c6e0a0107"} + +``` -##### Summary: +***Note: `token-returned-by-login-api` is a fake token, just to facilitate the following interface examples. In actual use, the content returned by the interface shall prevail.*** -verify SSL cert and key. +### /apisix/admin/server_info + +#### GET +##### Description: + +Get the list of APISIX server info ##### Parameters | Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ------ | -| cert | body | cert of SSL | Yes | string | -| key | body | key of SSL | Yes | string | +| ---- | ---------- | ----------- | -------- | ---- | +| page | query | The current page number | No | string | +| page_size | query | The number of data returned per page | No | string | +| hostname | query | | No | string | Review comment: Need a description of the `hostname` field. ########## File path: docs/en/latest/api/api.md ########## @@ -21,351 +21,881 @@ title: API doc of Manager API. # --> +## Description + Manager API directly operates ETCD and provides data management for Apache APISIX, provides APIs for Front-end or other clients. -**License:** [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) +We could pass parameters to APIs to control APISIX Nodes. To have a better understanding about how it works, please see [README](https://github.com/apache/apisix-dashboard/blob/master/README.md). -### /apisix/admin/check_ssl_cert +9000 is the default port on which the Manager API listens. You could take another port by modifying the [conf/conf.yaml](https://github.com/apache/apisix-dashboard/blob/master/api/conf/conf.yaml) file. + Review comment: Need a table of contents ########## File path: docs/en/latest/api/api.md ########## @@ -21,351 +21,881 @@ title: API doc of Manager API. # --> +## Description + Manager API directly operates ETCD and provides data management for Apache APISIX, provides APIs for Front-end or other clients. -**License:** [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) +We could pass parameters to APIs to control APISIX Nodes. To have a better understanding about how it works, please see [README](https://github.com/apache/apisix-dashboard/blob/master/README.md). -### /apisix/admin/check_ssl_cert +9000 is the default port on which the Manager API listens. You could take another port by modifying the [conf/conf.yaml](https://github.com/apache/apisix-dashboard/blob/master/api/conf/conf.yaml) file. + +## Authentication + +Before invoking other APIs, you need to log in first. + + +### /apisix/admin/user/login #### POST +##### Description: + +User login + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | + + +##### Request Body + +| Name | Type | Description | Required | +| ---- | ---- | ----------- | -------- | +| username | string | the username of your account | Yes | +| password | string | the password of your account | Yes | + + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response Data](#universal_response_data) | + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| token | string | The token signed after user login. Other APIs need to carry the token for identity verification.| + + +#### Example + +```shell +# Create a route +$ curl http://127.0.0.1:9000/apisix/admin/user/login -X POST -i -d ' +{ + "username": "admin", + "password": "admin" +}' + +HTTP/1.1 200 OK +... + +{"code":0,"message":"","data":{"token":"token-returned-by-login-api"},"request_id":"cd53eef7-56e2-4a74-a91d-e48c6e0a0107"} + +``` -##### Summary: +***Note: `token-returned-by-login-api` is a fake token, just to facilitate the following interface examples. In actual use, the content returned by the interface shall prevail.*** -verify SSL cert and key. +### /apisix/admin/server_info + +#### GET +##### Description: + +Get the list of APISIX server info ##### Parameters | Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ------ | -| cert | body | cert of SSL | Yes | string | -| key | body | key of SSL | Yes | string | +| ---- | ---------- | ----------- | -------- | ---- | +| page | query | The current page number | No | string | +| page_size | query | The number of data returned per page | No | string | +| hostname | query | | No | string | ##### Responses -| Code | Description | Schema | -| ------- | ----------------- | --------------------- | -| 0 | SSL verify passed | [ApiError](#ApiError) | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response List](#universal_response_data) | + + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| id | string | ID of APISIX servers. | +| last_report_time | int64 | The last time the plugin reported data. | +| up_time | int64 | How long the APISIX is running. Unit is second. | +| boot_time | int64 | The time when APISIX booting up. | +| etcd_version | string | The version of ETCD. | +| hostname | string | The hostname of the APISIX server. | +| version | string | The version of APISIX. | + +### Example + +```shell +curl http://127.0.0.1:9000/apisix/admin/server_info -i -H "Authorization: token-returned-by-login-api" +HTTP/1.1 200 OK +…… +{ + "code": 0, + "message": "", + "data": { + "rows": [ + { + "id": "4dcb6162-76e5-427d-9600-a1fcfbf73ef4", + "last_report_time": 1619061922, + "up_time": 69220, + "boot_time": 1618992702, + "etcd_version": "3.4.0", + "hostname": "MacBook-Pro.local", + "version": "2.5" + } + ], + "total_size": 1 + }, + "request_id": "66af3c70-963a-4cc5-8977-b11f306fe484" +} +``` + + +### /apisix/admin/server_info/{id} -### /apisix/admin/check_ssl_exists +#### GET +##### Description: + +Get the APISIX server info by id + + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of APISIX server | Yes | string | + + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response List](#universal_response_data) | + + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| id | string | ID of APISIX servers. | +| last_report_time | int64 | The last time the plugin reported data. | +| up_time | int64 | How long the APISIX is running. Unit is second. | +| boot_time | int64 | The time when APISIX booting up. | +| etcd_version | string | The version of ETCD. | +| hostname | string | The hostname of the APISIX server. | +| version | string | The version of APISIX. | + + +```sh +curl http://127.0.0.1:9000/apisix/admin/server_info/4dcb6162-76e5-427d-9600-a1fcfbf73ef4 -i -H "Authorization: token-returned-by-login-api" +HTTP/1.1 200 OK +…… +{ + "code": 0, + "message": "", + "data": { + "id": "4dcb6162-76e5-427d-9600-a1fcfbf73ef4", + "last_report_time": 1621346343, + "up_time": 204678, + "boot_time": 1621141665, + "etcd_version": "3.4.0", + "hostname": "MacBook-Pro.local", + "version": "2.5" + }, + "request_id": "fa2b9c86-71ef-43fa-bbf9-cf6c4fef6f8f" +} +``` + + + +### /apisix/admin/routes #### POST +##### Description: + +Create a route, and ID is generated by server + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| data | body | The request body | Yes | [route](#route) | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [route](#route) | + +#### GET +##### Description: + +Get the list of route + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| page | query | The current page number | No | int | +| page_size | query | The number of data returned per page | No | int | +| name | query | Keyword to search by name | No | string | +| uri | query | Keyword to search by uri | No | string | +| label | query | Keyword to search by label | No | string | +| status | query | Keyword to search by status | No | int | -##### Summary: -Check whether the SSL exists. +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + +#### PUT +##### Description: + +Update the route by ID ##### Parameters | Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ------ | -| cert | body | cert of SSL | Yes | string | -| key | body | key of SSL | Yes | string | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | No | string | +| data | body | The request body | Yes | [route](#route) | ##### Responses -| Code | Description | Schema | -| ------- | ---------------- | --------------------- | -| 0 | SSL exists | [ApiError](#ApiError) | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | -### /apisix/admin/consumers +### /apisix/admin/routes/{id} + +#### DELETE +##### Description: + +Delete the route by ID + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | Yes | string | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [universal_response_data](#universal_response_data) | #### GET +##### Description: + +Get the specified route by ID + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | The id of route | Yes | string | + +##### Responses -##### Summary: +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [route](#route) | -Return the consumer list according to the specified page number and page size, and can search consumers by username. +#### PUT +##### Description: + +Update the specified route by ID + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | Yes | string | +| data | body | The request body | Yes | [route](#route) | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + +#### PATCH +##### Description: + +Partial update the specified route ##### Parameters -| Name | Located in | Description | Required | Schema | -| --------- | ---------- | -------------------- | -------- | ------- | -| page | query | page number | No | integer | -| page_size | query | page size | No | integer | -| username | query | username of consumer | No | string | +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | Yes | string | +| data | body | The request body | Yes | any part of [route](#route) | ##### Responses -| Code | Description | Schema | -| ------- | ---------------- | ------------------------- | -| 0 | list response | [ [consumer](#consumer) ] | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | ### /apisix/admin/notexist/routes #### GET - -##### Summary: +##### Description: Return result of route exists checking by name and exclude id. ##### Parameters -| Name | Located in | Description | Required | Schema | -| ------- | ---------- | --------------------------------- | -------- | ------ | -| name | query | name of route | No | string | -| exclude | query | id of route that exclude checking | No | string | +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| name | query | Name of route | Yes | string | +| exclude | query | ID of route that exclude checking | No | string | ##### Responses -| Code | Description | Schema | -| ------- | ---------------- | --------------------- | -| 0 | route not exists | [ApiError](#ApiError) | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [universal_response_data](#universal_response_data) | -### /apisix/admin/routes +### /apisix/admin/routes/{id}/{path} + +#### PATCH +##### Description: + +Partial update the specified route by ID and sub path + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | Yes | string | +| path | path | json path of [route](#route) | Yes | string | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + + +### /apisix/admin/schema/plugins/{name} + +#### GET +##### Description: + +Get the plugin schema by name + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| schema_type | query | Scheme type(consumer or route) | No | string | +| name | path | Name of the plugin | Yes | string | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + +### /apisix/admin/schemas/{resource} #### GET +##### Description: + +Get the schema by resource name + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| resource | path | Resource name(such as route) | Yes | string | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + +### /apisix/admin/plugins + +#### GET +##### Description: + +Get the schema of plugin + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| all | query | Whether to get the list of all plugins | No | string | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + + +### /apisix/admin/check_ssl_exists + +#### POST +##### Description: + +Check if the SSL configuration exists + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| hosts | body | Search whether the sni of the certificate matches | Yes | string array | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [universal_response_data](#universal_response_data) | + +### /apisix/admin/check_ssl_cert + +#### POST +##### Description: + +Check whether the SSL configuration is legal + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| data | body | The request body | Yes | [ssl](#ssl) | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + -##### Summary: +### /apisix/admin/tool/version_match -Return the route list according to the specified page number and page size, and can search routes by name and uri. +#### GET +##### Description: + +Check if dashboard and apisix match ##### Parameters -| Name | Located in | Description | Required | Schema | -| --------- | ---------- | -------------- | -------- | ------- | -| page | query | page number | No | integer | -| page_size | query | page size | No | integer | -| name | query | name of route | No | string | -| uri | query | uri of route | No | string | -| label | query | label of route | No | string | +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | Review comment: Miss example. ########## File path: docs/en/latest/api/api.md ########## @@ -21,351 +21,881 @@ title: API doc of Manager API. # --> +## Description + Manager API directly operates ETCD and provides data management for Apache APISIX, provides APIs for Front-end or other clients. -**License:** [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) +We could pass parameters to APIs to control APISIX Nodes. To have a better understanding about how it works, please see [README](https://github.com/apache/apisix-dashboard/blob/master/README.md). -### /apisix/admin/check_ssl_cert +9000 is the default port on which the Manager API listens. You could take another port by modifying the [conf/conf.yaml](https://github.com/apache/apisix-dashboard/blob/master/api/conf/conf.yaml) file. + +## Authentication + +Before invoking other APIs, you need to log in first. + + +### /apisix/admin/user/login #### POST +##### Description: + +User login + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | + + +##### Request Body + +| Name | Type | Description | Required | +| ---- | ---- | ----------- | -------- | +| username | string | the username of your account | Yes | +| password | string | the password of your account | Yes | + + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response Data](#universal_response_data) | + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| token | string | The token signed after user login. Other APIs need to carry the token for identity verification.| + + +#### Example + +```shell +# Create a route +$ curl http://127.0.0.1:9000/apisix/admin/user/login -X POST -i -d ' +{ + "username": "admin", + "password": "admin" +}' + +HTTP/1.1 200 OK +... + +{"code":0,"message":"","data":{"token":"token-returned-by-login-api"},"request_id":"cd53eef7-56e2-4a74-a91d-e48c6e0a0107"} + +``` -##### Summary: +***Note: `token-returned-by-login-api` is a fake token, just to facilitate the following interface examples. In actual use, the content returned by the interface shall prevail.*** -verify SSL cert and key. +### /apisix/admin/server_info + +#### GET +##### Description: + +Get the list of APISIX server info ##### Parameters | Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ------ | -| cert | body | cert of SSL | Yes | string | -| key | body | key of SSL | Yes | string | +| ---- | ---------- | ----------- | -------- | ---- | +| page | query | The current page number | No | string | +| page_size | query | The number of data returned per page | No | string | +| hostname | query | | No | string | ##### Responses -| Code | Description | Schema | -| ------- | ----------------- | --------------------- | -| 0 | SSL verify passed | [ApiError](#ApiError) | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response List](#universal_response_data) | + + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| id | string | ID of APISIX servers. | +| last_report_time | int64 | The last time the plugin reported data. | +| up_time | int64 | How long the APISIX is running. Unit is second. | +| boot_time | int64 | The time when APISIX booting up. | +| etcd_version | string | The version of ETCD. | +| hostname | string | The hostname of the APISIX server. | +| version | string | The version of APISIX. | + +### Example + +```shell +curl http://127.0.0.1:9000/apisix/admin/server_info -i -H "Authorization: token-returned-by-login-api" +HTTP/1.1 200 OK +…… +{ + "code": 0, + "message": "", + "data": { + "rows": [ + { + "id": "4dcb6162-76e5-427d-9600-a1fcfbf73ef4", + "last_report_time": 1619061922, + "up_time": 69220, + "boot_time": 1618992702, + "etcd_version": "3.4.0", + "hostname": "MacBook-Pro.local", + "version": "2.5" + } + ], + "total_size": 1 + }, + "request_id": "66af3c70-963a-4cc5-8977-b11f306fe484" +} +``` + + +### /apisix/admin/server_info/{id} -### /apisix/admin/check_ssl_exists +#### GET +##### Description: + +Get the APISIX server info by id + + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of APISIX server | Yes | string | + + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [Universal Response List](#universal_response_data) | + + +##### Responses Data + +| Name | Type | Description | +| ---- | ---- | ----------- | +| id | string | ID of APISIX servers. | +| last_report_time | int64 | The last time the plugin reported data. | +| up_time | int64 | How long the APISIX is running. Unit is second. | +| boot_time | int64 | The time when APISIX booting up. | +| etcd_version | string | The version of ETCD. | +| hostname | string | The hostname of the APISIX server. | +| version | string | The version of APISIX. | + + +```sh +curl http://127.0.0.1:9000/apisix/admin/server_info/4dcb6162-76e5-427d-9600-a1fcfbf73ef4 -i -H "Authorization: token-returned-by-login-api" +HTTP/1.1 200 OK +…… +{ + "code": 0, + "message": "", + "data": { + "id": "4dcb6162-76e5-427d-9600-a1fcfbf73ef4", + "last_report_time": 1621346343, + "up_time": 204678, + "boot_time": 1621141665, + "etcd_version": "3.4.0", + "hostname": "MacBook-Pro.local", + "version": "2.5" + }, + "request_id": "fa2b9c86-71ef-43fa-bbf9-cf6c4fef6f8f" +} +``` + + + +### /apisix/admin/routes #### POST +##### Description: + +Create a route, and ID is generated by server + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| data | body | The request body | Yes | [route](#route) | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [route](#route) | + +#### GET +##### Description: + +Get the list of route + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| page | query | The current page number | No | int | +| page_size | query | The number of data returned per page | No | int | +| name | query | Keyword to search by name | No | string | +| uri | query | Keyword to search by uri | No | string | +| label | query | Keyword to search by label | No | string | +| status | query | Keyword to search by status | No | int | -##### Summary: -Check whether the SSL exists. +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | + +#### PUT +##### Description: + +Update the route by ID ##### Parameters | Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ------ | -| cert | body | cert of SSL | Yes | string | -| key | body | key of SSL | Yes | string | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | No | string | +| data | body | The request body | Yes | [route](#route) | ##### Responses -| Code | Description | Schema | -| ------- | ---------------- | --------------------- | -| 0 | SSL exists | [ApiError](#ApiError) | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | object | -### /apisix/admin/consumers +### /apisix/admin/routes/{id} + +#### DELETE +##### Description: + +Delete the route by ID + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | ID of the route | Yes | string | + +##### Responses + +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [universal_response_data](#universal_response_data) | #### GET +##### Description: + +Get the specified route by ID + +##### Parameters + +| Name | Located in | Description | Required | Schema | +| ---- | ---------- | ----------- | -------- | ---- | +| id | path | The id of route | Yes | string | + +##### Responses -##### Summary: +| Code | Description | Schema | +| ---- | ----------- | ------ | +| 200 | success | [route](#route) | Review comment: The response is `route` looks not very good. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
