Skip to content

feat: add control API#3048

Merged
spacewander merged 5 commits into
apache:masterfrom
spacewander:ca
Dec 18, 2020
Merged

feat: add control API#3048
spacewander merged 5 commits into
apache:masterfrom
spacewander:ca

Conversation

@spacewander

Copy link
Copy Markdown
Member

Signed-off-by: spacewander [email protected]

What this PR does / why we need it:

Pre-submission checklist:

  • 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 first

Signed-off-by: spacewander <[email protected]>
@spacewander
spacewander marked this pull request as ready for review December 15, 2020 04:13
Comment thread .travis/apisix_cli_test/test_ci_only.sh Outdated
Comment thread doc/control-api.md Outdated
Comment thread doc/control-api.md Outdated
port: 9090
```

Note that the control API server should not be configured to listen the public traffic!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Comment thread 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread apisix/control/v1.lua Outdated
-- /v1/schema
{
methods = {"GET"},
uri = "/schema",

Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Comment thread conf/config-default.yaml
Comment thread apisix/control/router.lua Outdated
Comment thread apisix/plugins/example-plugin.lua
Signed-off-by: spacewander <[email protected]>
@spacewander

Copy link
Copy Markdown
Member Author

Related issue: #2798 #3022

@membphis membphis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread conf/config-default.yaml
Comment thread doc/control-api.md

## Control API Added via plugin

Plugin can add its control API when it is enabled.

Copy link
Copy Markdown
Contributor

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?

Copy link
Copy Markdown
Member Author

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

@nic-chen nic-chen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@spacewander
spacewander merged commit 924a30d into apache:master Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants