You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/02/24 01:34:18 UTC
[GitHub] [apisix] Firstsawyou opened a new pull request #3649: docs: update admin-api.md
Firstsawyou opened a new pull request #3649:
URL: https://github.com/apache/apisix/pull/3649
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
### Pre-submission checklist:
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [ ] Have you modified the corresponding document?
* [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581693613
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When the `Admin API` is enabled, it will occupy the API prefixed with `/apisix/admin`. Therefore, in order to avoid conflicts between your design API and `/apisix/admin`, it is recommended that the port of the data plane and the control plane be different. You can customize the Admin API port through `port_admin` in `conf/config.yaml`.
Review comment:
it is recommended that the port of the data plane and the control plane be different.
=>
it is recommended to use a different port for the Admin API.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581567903
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When `Admin API` is enabled, Apache APISIX will occupy the API prefixed with `/apisix/admin`. Therefore, when you design an API, please try to avoid using it.
Review comment:
if we use `try to` here, once users use this way, what should they do?
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] Firstsawyou commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581818847
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When the `Admin API` is enabled, it will occupy the API prefixed with `/apisix/admin`. Therefore, in order to avoid conflicts between your design API and `/apisix/admin`, it is recommended that the port of the data plane and the control plane be different. You can customize the Admin API port through `port_admin` in `conf/config.yaml`.
Review comment:
updated.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] Firstsawyou commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581635901
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When `Admin API` is enabled, Apache APISIX will occupy the API prefixed with `/apisix/admin`. Therefore, when you design an API, please try to avoid using it.
Review comment:
updated.
The Admin API port can be customized through `port_admin` in `conf/config.yaml`.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #3649:
URL: https://github.com/apache/apisix/pull/3649
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581567775
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When `Admin API` is enabled, Apache APISIX will occupy the API prefixed with `/apisix/admin`. Therefore, when you design an API, please try to avoid using it.
Review comment:
```suggestion
Note: When `Admin API` is enabled, Apache APISIX will occupy the API prefixed with `/apisix/admin`. Therefore, when you design an API, please AVOID using it.
```
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] Firstsawyou commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581640216
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When `Admin API` is enabled, Apache APISIX will occupy the API prefixed with `/apisix/admin`. Therefore, when you design an API, please try to avoid using it.
Review comment:
updated.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #3649: docs: update admin-api.md
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3649:
URL: https://github.com/apache/apisix/pull/3649#discussion_r581584893
##########
File path: doc/admin-api.md
##########
@@ -35,6 +35,8 @@
*Description*：Route matches requests based on preset rules, and loads the appropriate plugin according to the matching result, then forwarding requests to target Upstream.
+Note: When `Admin API` is enabled, Apache APISIX will occupy the API prefixed with `/apisix/admin`. Therefore, when you design an API, please try to avoid using it.
Review comment:
Instead of avoiding `/apisix/admin`, we should warn user to choice a different port from the data panel.
----------------------------------------------------------------
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:
users@infra.apache.org