This is an automated email from the ASF dual-hosted git repository.
baoyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
The following commit(s) were added to refs/heads/master by this push:
new ebe81bd23 docs: update document about openapi exporter (#2778)
ebe81bd23 is described below
commit ebe81bd2300f5125a517dbd1292cfdcc74aeca36
Author: Joanthan Chen <[email protected]>
AuthorDate: Mon Mar 27 09:43:47 2023 +0800
docs: update document about openapi exporter (#2778)
---
.../assets/images/modules/data_loader/openapi3-7.png | Bin 0 -> 84460 bytes
.../assets/images/modules/data_loader/openapi3-8.png | Bin 0 -> 43830 bytes
.../assets/images/modules/data_loader/openapi3-9.png | Bin 0 -> 35521 bytes
docs/en/latest/api/api.md | 19 +++++++++++++++++++
docs/en/latest/modules/data_loader/openapi3.md | 7 ++++++-
5 files changed, 25 insertions(+), 1 deletion(-)
diff --git a/docs/assets/images/modules/data_loader/openapi3-7.png
b/docs/assets/images/modules/data_loader/openapi3-7.png
new file mode 100644
index 000000000..97d0427b8
Binary files /dev/null and
b/docs/assets/images/modules/data_loader/openapi3-7.png differ
diff --git a/docs/assets/images/modules/data_loader/openapi3-8.png
b/docs/assets/images/modules/data_loader/openapi3-8.png
new file mode 100644
index 000000000..1372e50e9
Binary files /dev/null and
b/docs/assets/images/modules/data_loader/openapi3-8.png differ
diff --git a/docs/assets/images/modules/data_loader/openapi3-9.png
b/docs/assets/images/modules/data_loader/openapi3-9.png
new file mode 100644
index 000000000..504f1ec9a
Binary files /dev/null and
b/docs/assets/images/modules/data_loader/openapi3-9.png differ
diff --git a/docs/en/latest/api/api.md b/docs/en/latest/api/api.md
index b270c4e8f..2b43da632 100644
--- a/docs/en/latest/api/api.md
+++ b/docs/en/latest/api/api.md
@@ -200,6 +200,25 @@ Return the service list according to the specified page
number and page size, an
| 0 | list response | [ [service](#service) ] |
| default | unexpected error | [ApiError](#ApiError) |
+### /apisix/admin/export/routes/{ids}
+
+#### Summary
+
+Export specific or all routes as OpenAPI schema.
+
+##### Parameters
+
+| Name | Located in | Description
| Required | Schema |
+|------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------|
-------- | ------- |
+| ids | path | To export specific routes, please provide the
route IDs separated by commas. If you leave the ids field empty, all routes
will be exported. | No | integer |
+
+##### Responses
+
+| Code | Description | Schema
|
+| -------
|----------------------|-------------------------------------------------------------------------------------------------------|
+| 0 | openapi json content | [ [OpenAPI
schema](https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.0/schema.json)
] |
+| default | unexpected error | [ApiError](#ApiError)
|
+
### /apisix/admin/ssl
#### GET
diff --git a/docs/en/latest/modules/data_loader/openapi3.md
b/docs/en/latest/modules/data_loader/openapi3.md
index 1541f07ef..f3c5be6c4 100644
--- a/docs/en/latest/modules/data_loader/openapi3.md
+++ b/docs/en/latest/modules/data_loader/openapi3.md
@@ -116,4 +116,9 @@ Use the test tool to call the API to determine if it is
configured correctly.
### Export
-Not supported yet.
+1. Open the route, and select routes you want to export.
+ 
+2. Click `Export OpenAPI` button.
+ 
+3. Select the export format, eg `Yaml`. Then click `Confirm` to export.
+ 
