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.

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

doc: add apisix_pluginconfig document #1025

Merged
merged 4 commits into from
May 20, 2022
Merged

Conversation

neverCase
Copy link
Contributor

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches

What this PR does / why we need it:

issue: #638

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

@neverCase
Copy link
Contributor Author

@tao12345666333

Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

@neverCase
Copy link
Contributor Author

Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

LGTM

@tao12345666333 tao12345666333 added the documentation Improvements or additions to documentation label May 19, 2022
@tao12345666333 tao12345666333 added this to the 1.5.0 milestone May 19, 2022
| 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. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| plugins[].config | object | The plugin configuration, fields should be same as in APISIX. |
| plugins[].config | object | The plugin configuration, and fields should be the same as in APISIX. |

|---------------|----------|----------------------------------------------------|
| 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 |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| plugins[].enable | boolean | Whether the plugin is in use |
| plugins[].enable | boolean | Whether the plugin should be enabled |

Copy link
Member

Choose a reason for hiding this comment

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

@neverCase PTAL

Copy link
Member

Choose a reason for hiding this comment

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

I will merge first, for those small suggestions @neverCase could help to create a new PR :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, i will open another one

@juzhiyuan juzhiyuan merged commit 537b947 into apache:master May 20, 2022
@neverCase neverCase deleted the apc-doc branch May 20, 2022 02:30
lingsamuel pushed a commit to lingsamuel/apisix-ingress-controller that referenced this pull request May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants