You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ok...@apache.org on 2022/09/20 06:44:18 UTC

[apisix] branch master updated: docs: use 9180 as Admin API's port and add X-API-KEY (#7942)

This is an automated email from the ASF dual-hosted git repository.

okaybase pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 54c691492 docs: use 9180 as Admin API's port and add X-API-KEY (#7942)
54c691492 is described below

commit 54c691492f767703a313477c360ac5864c9e31a1
Author: okaybase <75...@users.noreply.github.com>
AuthorDate: Tue Sep 20 14:44:08 2022 +0800

    docs: use 9180 as Admin API's port and add X-API-KEY (#7942)
    
    * use 9180 as Admin API's port
    
    * use 9180 as Admin API's port
    
    * use 9180 as Admin API's port
    
    * use 9180 as Admin API's port
    
    * use 9180 as Admin API's port
    
    * use 9180 as Admin API's port
    
    * use 9180 as Admin API's port
    
    * add X-API-KEY for requesting Admin API
---
 docs/en/latest/plugins/basic-auth.md   | 2 +-
 docs/en/latest/plugins/forward-auth.md | 2 +-
 docs/en/latest/plugins/ldap-auth.md    | 2 +-
 docs/en/latest/plugins/opa.md          | 2 +-
 docs/zh/latest/plugins/opa.md          | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/en/latest/plugins/basic-auth.md b/docs/en/latest/plugins/basic-auth.md
index 5b999bb41..687748391 100644
--- a/docs/en/latest/plugins/basic-auth.md
+++ b/docs/en/latest/plugins/basic-auth.md
@@ -127,7 +127,7 @@ HTTP/1.1 401 Unauthorized
 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.
 
 ```shell
-curl http://127.0.0.1:9180/apisix/admin/routes/1 -X PUT -d '
+curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "methods": ["GET"],
     "uri": "/hello",
diff --git a/docs/en/latest/plugins/forward-auth.md b/docs/en/latest/plugins/forward-auth.md
index 35a8bfd6c..2620959a6 100644
--- a/docs/en/latest/plugins/forward-auth.md
+++ b/docs/en/latest/plugins/forward-auth.md
@@ -159,7 +159,7 @@ Location: http://example.com/auth
 To disable the `forward-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.
 
 ```shell
-curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value='
+curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "methods": ["GET"],
     "uri": "/hello",
diff --git a/docs/en/latest/plugins/ldap-auth.md b/docs/en/latest/plugins/ldap-auth.md
index 537cddb65..761c99b70 100644
--- a/docs/en/latest/plugins/ldap-auth.md
+++ b/docs/en/latest/plugins/ldap-auth.md
@@ -143,7 +143,7 @@ HTTP/1.1 401 Unauthorized
 To disable the `ldap-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.
 
 ```shell
-curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value='
+curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "methods": ["GET"],
     "uri": "/hello",
diff --git a/docs/en/latest/plugins/opa.md b/docs/en/latest/plugins/opa.md
index d32907458..3c1c32fa6 100644
--- a/docs/en/latest/plugins/opa.md
+++ b/docs/en/latest/plugins/opa.md
@@ -302,7 +302,7 @@ curl -X GET 127.0.0.1:9080/get
 To disable the `opa` 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.
 
 ```shell
-curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value='
+curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "methods": ["GET"],
     "uri": "/hello",
diff --git a/docs/zh/latest/plugins/opa.md b/docs/zh/latest/plugins/opa.md
index 816ffb049..d560142e3 100644
--- a/docs/zh/latest/plugins/opa.md
+++ b/docs/zh/latest/plugins/opa.md
@@ -303,7 +303,7 @@ curl -X GET 127.0.0.1:9080/get
 当你需要禁用 `opa` 插件时,可以通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:
 
 ```shell
-curl http://127.0.0.1:2379/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "methods": ["GET"],
     "uri": "/hello",