Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: paraphrasing some descriptions about plugins #1028

Merged
merged 1 commit into from
May 21, 2022
Merged

doc: paraphrasing some descriptions about plugins #1028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/en/latest/references/apisix_pluginconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ Spec describes the desired state of an ApisixPluginConfig object.
|---------------|----------|----------------------------------------------------|
| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
| plugins[].enable | boolean | Whether the plugin is in use |
| plugins[].config | object | The plugin configuration, fields should be same as in APISIX. |
| plugins[].enable | boolean | Whether the plugin would be used |
| plugins[].config | object | The configuration of the plugin that must have the same fields as in APISIX. |
4 changes: 2 additions & 2 deletions docs/en/latest/references/apisix_route_v2beta3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Meaning of each field in the spec of ApisixRoute are followed, the top level fie
| http[].backends[].subset | string | Subset specifies a subset for the target Service. The subset should be pre-definedin ApisixUpstream about this service.
| http[].plugins | array | A series of APISIX plugins that will be executed once this route rule is matched |
| http[].plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins.
| http[].plugins[].enable | boolean | Whether the plugin is in use |
| http[].plugins[].config | object | The plugin configuration, fields should be same as in APISIX. |
| http[].plugins[].enable | boolean | Whether the plugin would be used |
| http[].plugins[].config | object | The configuration of the plugin that must have the same fields as in APISIX. |
| http[].websocket | boolean | Whether enable websocket proxy. |
| stream | array | ApisixRoutes' stream route rules, which contains TCP or UDP rules.|
| stream[].protocol | string (required) | The protocol of rule. Support `TCP` or `UDP`|
Expand Down