This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/paimon.git
The following commit(s) were added to refs/heads/master by this push:
new 4efa4ae023 [rest] Introduce `Redoc` to visualize Rest API (#5336)
4efa4ae023 is described below
commit 4efa4ae02362f1e05f51520383a1e0c441e80ed8
Author: Yubin Li <[email protected]>
AuthorDate: Tue Mar 25 10:19:32 2025 +0800
[rest] Introduce `Redoc` to visualize Rest API (#5336)
---
docs/README.md | 2 +-
docs/content/concepts/rest/overview.md | 4 ++++
.../layouts/shortcodes/generated/rest_catalog.html | 22 ++++++++++++++++++++++
3 files changed, 27 insertions(+), 1 deletion(-)
diff --git a/docs/README.md b/docs/README.md
index fb96248516..c6901b5953 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -25,7 +25,7 @@ From this directory:
hugo -b "" serve
```
-The site can be viewed at http://localhost:1313/
+The site can be viewed at http://localhost:1313/docs/master/
# Contribute
diff --git a/docs/content/concepts/rest/overview.md
b/docs/content/concepts/rest/overview.md
index 105f4d6f7e..6a26f4e75b 100644
--- a/docs/content/concepts/rest/overview.md
+++ b/docs/content/concepts/rest/overview.md
@@ -62,3 +62,7 @@ RESTCatalog supports multiple access authentication methods,
including the follo
1. [Bear Token]({{< ref "concepts/rest/bear" >}}).
2. [DLF Token]({{< ref "concepts/rest/dlf" >}}).
+
+## API
+
+{{< generated/rest_catalog >}}
\ No newline at end of file
diff --git a/docs/layouts/shortcodes/generated/rest_catalog.html
b/docs/layouts/shortcodes/generated/rest_catalog.html
new file mode 100644
index 0000000000..29c52a7a8b
--- /dev/null
+++ b/docs/layouts/shortcodes/generated/rest_catalog.html
@@ -0,0 +1,22 @@
+{{/*
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/}}
+<body>
+ <redoc
spec-url="https://raw.githubusercontent.com/apache/paimon/master/paimon-open-api/rest-catalog-open-api.yaml";></redoc>
+ <script
src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js";></script>
+</body>
\ No newline at end of file
