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

request help: use the disable property to disable plugin #2882

Closed
juzhiyuan opened this issue Nov 28, 2020 · 7 comments
Closed

request help: use the disable property to disable plugin #2882

juzhiyuan opened this issue Nov 28, 2020 · 7 comments
Labels
discuss doc Documentation things plugin

Comments

@juzhiyuan
Copy link
Member

juzhiyuan commented Nov 28, 2020

Issue description

Should we update plugins' docs to use the disable property instead of omitting the plugin's data to disable that plugin? This could prevent lost plugin's data when disabling it.

e.g https://github.com/apache/apisix/blob/master/doc/plugins/api-breaker.md#disable-plugin

Environment

  • apisix version (cmd: apisix version): No
  • OS: No
@juzhiyuan juzhiyuan changed the title request help: request help: use the disable property to disable plugin Nov 28, 2020
@juzhiyuan juzhiyuan added discuss doc Documentation things plugin labels Nov 28, 2020
@membphis
Copy link
Member

We can add a new section about this way, add a reference to the doc of plugin.

@spacewander
Copy link
Member

Isn't this behavior broken now? Add a disable field doesn't trigger the destory method of the plugin. And re-enable a plugin doesn't the init method.

@spacewander
Copy link
Member

Better not mention this experimental feature in the doc.

@spacewander
Copy link
Member

OK, I was misled right now. It is disable a plugin for a route/service, not disable a plugin. We should clarify it in the doc. The current doc mess enable / disable a plugin for a route/service with enable / disable a plugin, and many people are mislead.

@spacewander
Copy link
Member

I think the plugins' doc need to be rewritten to show the difference. There is no need to show the disable a plugin for a route/service in every doc since they are similar.

@juzhiyuan
Copy link
Member Author

juzhiyuan commented Nov 28, 2020

@spacewander
Copy link
Member

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss doc Documentation things plugin
Projects
None yet
Development

No branches or pull requests

3 participants