Skip to content

Commit 1467514

Browse files
authored
docs: update disable plugin section in plugin docs (#9894)
1 parent 7ed4926 commit 1467514

156 files changed

Lines changed: 265 additions & 265 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/en/latest/plugins/api-breaker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ HTTP/1.1 502 Bad Gateway
108108
</html>
109109
```
110110

111-
## Disable Plugin
111+
## Delete Plugin
112112

113-
To disable the `api-breaker` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
113+
To remove the `api-breaker` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
114114

115115
```shell
116116
curl http://127.0.0.1:9180/apisix/admin/routes/1 \

docs/en/latest/plugins/authz-casbin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,9 +234,9 @@ And only users with admin privileges can access the endpoints:
234234
curl -i http://127.0.0.1:9080/res -H 'user: alice' -X GET
235235
```
236236

237-
## Disable Plugin
237+
## Delete Plugin
238238

239-
To disable the `authz-casbin` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
239+
To remove the `authz-casbin` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
240240

241241
```shell
242242
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

docs/en/latest/plugins/authz-casdoor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ After successfully logging in, Casdoor will redirect this user to the `callback_
8989

9090
Once this is done, the user is redirected to the original URL they wanted to visit.
9191

92-
## Disable Plugin
92+
## Delete Plugin
9393

94-
To disable the `authz-casdoor` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
94+
To remove the `authz-casdoor` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
9595

9696
```shell
9797
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

docs/en/latest/plugins/authz-keycloak.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,9 @@ The image below shows how the policies are configured in the Keycloak server:
200200

201201
![Keycloak policy design](https://raw.githubusercontent.com/apache/apisix/master/docs/assets/images/plugin/authz-keycloak.png)
202202

203-
## Disable Plugin
203+
## Delete Plugin
204204

205-
To disable the `authz-keycloak` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
205+
To remove the `authz-keycloak` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
206206

207207
```shell
208208
curl http://127.0.0.1:9180/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

docs/en/latest/plugins/aws-lambda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,9 @@ Server: APISIX/2.11.0
194194
"Hello, APISIX!"
195195
```
196196

197-
## Disable Plugin
197+
## Delete Plugin
198198

199-
To disable the `aws-lambda` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
199+
To remove the `aws-lambda` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
200200

201201
```shell
202202
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

docs/en/latest/plugins/azure-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,9 @@ Server: APISIX/2.11.0
171171
Hello, APISIX
172172
```
173173

174-
## Disable Plugin
174+
## Delete Plugin
175175

176-
To disable the `azure-functions` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
176+
To remove the `azure-functions` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
177177

178178
```shell
179179
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

docs/en/latest/plugins/basic-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ HTTP/1.1 401 Unauthorized
125125
{"message":"Invalid user authorization"}
126126
```
127127

128-
## Disable Plugin
128+
## Delete Plugin
129129

130-
To disable the `jwt-auth` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
130+
To remove the `jwt-auth` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
131131

132132
```shell
133133
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

docs/en/latest/plugins/batch-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,6 @@ This will give a response:
211211
]
212212
```
213213

214-
## Disable Plugin
214+
## Delete Plugin
215215

216216
You can remove `batch-requests` from your list of Plugins in your configuration file (`conf/config.yaml`).

docs/en/latest/plugins/body-transformer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ curl -s http://127.0.0.1:9080/ws -H 'content-type: application/json' -X POST -d
257257
}
258258
```
259259

260-
## Disable Plugin
260+
## Delete Plugin
261261

262-
To disable the `body-transformer` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
262+
To remove the `body-transformer` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
263263

264264
```shell
265265
curl http://127.0.0.1:9180/apisix/admin/routes/test_ws \

docs/en/latest/plugins/cas-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ or path only (e.g. `/anything/logout`), but it is recommended to be path only to
8888
These uris need to be captured by the route where the current APISIX is located.
8989
For example, if the `uri` of the current route is `/api/v1/*`, `cas_callback_uri` can be filled in as `/api/v1/cas_callback`.
9090

91-
## Disable Plugin
91+
## Delete Plugin
9292

93-
To disable the `cas-auth` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
93+
To remove the `cas-auth` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
9494

9595
```shell
9696
curl http://127.0.0.1:9180/apisix/admin/routes/cas1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

0 commit comments

Comments
 (0)