You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/02/21 13:40:31 UTC
[GitHub] [apisix-dashboard] starsz commented on a change in pull request #1486: chore: update doc about JSONSchema sync and remove useless codes
starsz commented on a change in pull request #1486:
URL: https://github.com/apache/apisix-dashboard/pull/1486#discussion_r579809094
##########
File path: docs/FAQ.md
##########
@@ -33,27 +33,23 @@ If you are using Apache APISIX below v2.0, be aware that the data from the etcd
### 4. After modifying the plugin schema or creating a custom plugin in Apache APISIX, why can't I find it on the dashboard?
-Since the Dashboard caches the jsonschema data of the plugins in Apache APISIX, you need to synchronize the data in the Dashboard after you create your custom plugins in Apache APISIX, which currently **only supports manual operation**, this issue will be optimized in the following versions. Please follow the following guide.
+Since the Dashboard caches the jsonschema data of the plugins in Apache APISIX, you need to synchronize the data in the Dashboard after you create your custom plugins in Apache APISIX, which currently **only supports manual operation**. Please follow the following guide.
-1. Install [Lua](https://www.lua.org/download.html) and `zip`.
+1. Confirm that your APISIX is running and has enabled control API (enabled by default and only runs local access)
+Refer to the beginning in:
+https://github.com/apache/apisix/blob/master/doc/control-api.md
-2. Execute the following commands.
+2. Execute the following commands to export jsonchema on your APISIX server (if it is configured for non-local access, it does not need to be executed on your APISIX server, and the access IP and port should be modified accordingly)
```sh
-# `$version` is the version number of Apache APISIX, e.g. master or 2.1.
-$ api/build-tools/schema-sync.sh $version
+curl 127.0.0.1:9090/v1/schema> schema.json
Review comment:
How about
```
curl 127.0.0.1:9090/v1/schema > schema.json
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org