-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add control API #3048
feat: add control API #3048
Conversation
Signed-off-by: spacewander <[email protected]>
Co-authored-by: John Bampton <[email protected]>
Co-authored-by: John Bampton <[email protected]>
doc/control-api.md
Outdated
port: 9090 | ||
``` | ||
|
||
Note that the control API server should not be configured to listen the public traffic! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that the control API server should not be configured to listen the public traffic! | |
Note that the control API server should not be configured to listen to public traffic! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
doc/control-api.md
Outdated
## Control API Added via plugin | ||
|
||
Plugin can add its control API when it is enabled. | ||
If a plugin adds such control API, please refer to each plugin's documentation for those APIs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If a plugin adds such control API, please refer to each plugin's documentation for those APIs. | |
If a plugin adds such a control API, please refer to each plugin's documentation for those APIs. |
apisix/control/v1.lua
Outdated
-- /v1/schema | ||
{ | ||
methods = {"GET"}, | ||
uri = "/schema", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use uris
is better, we'll remove uri
later
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
Signed-off-by: spacewander <[email protected]>
Signed-off-by: spacewander <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
||
## Control API Added via plugin | ||
|
||
Plugin can add its control API when it is enabled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we add the control API example in plugin-develop.md?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, but we can do it later. It seems the plugin-develop.md
is outdated and need to be rewritten.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: spacewander [email protected]
What this PR does / why we need it:
Pre-submission checklist: