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 0cdc2db42f [doc] Make rest api a separate page
0cdc2db42f is described below
commit 0cdc2db42fc7cec534fff444a6fd2c5c523c3caf
Author: JingsongLi <[email protected]>
AuthorDate: Tue Mar 25 10:23:31 2025 +0800
[doc] Make rest api a separate page
---
docs/content/concepts/rest/overview.md | 8 ++------
docs/content/concepts/rest/rest-api.md | 10 ++++++++++
.../layouts/shortcodes/generated/rest_catalog.html | 22 ----------------------
3 files changed, 12 insertions(+), 28 deletions(-)
diff --git a/docs/content/concepts/rest/overview.md
b/docs/content/concepts/rest/overview.md
index 6a26f4e75b..df2349bd18 100644
--- a/docs/content/concepts/rest/overview.md
+++ b/docs/content/concepts/rest/overview.md
@@ -29,7 +29,7 @@ under the License.
## Overview
Paimon REST Catalog provides a lightweight implementation to access the
catalog service. Paimon could access the
-catalog service through a catalog server which implements REST API. You can
see all APIs in [REST
API](https://github.com/apache/paimon/blob/master/paimon-open-api/rest-catalog-open-api.yaml).
+catalog service through a catalog server which implements REST API. You can
see all APIs in [REST API]({{< ref "concepts/rest/rest-api" >}}).
{{< img src="/img/rest-catalog.svg">}}
@@ -50,7 +50,7 @@ catalog service through a catalog server which implements
REST API. You can see
## Conclusion
-REST Catalog offers adaptable solution for accessing the catalog service.
According to [REST
API](https://github.com/apache/paimon/blob/master/paimon-open-api/rest-catalog-open-api.yaml)
is decoupled
+REST Catalog offers adaptable solution for accessing the catalog service.
According to [REST API]({{< ref "concepts/rest/rest-api" >}}) is decoupled
from the catalog service.
Technology-specific Logic is encapsulated on the catalog server. At the same
time, the catalog server supports any
@@ -62,7 +62,3 @@ 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/content/concepts/rest/rest-api.md
b/docs/content/concepts/rest/rest-api.md
new file mode 100644
index 0000000000..2871add447
--- /dev/null
+++ b/docs/content/concepts/rest/rest-api.md
@@ -0,0 +1,10 @@
+---
+title: "REST API"
+layout: "custom-page"
+bookToc: false
+---
+
+<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>
diff --git a/docs/layouts/shortcodes/generated/rest_catalog.html
b/docs/layouts/shortcodes/generated/rest_catalog.html
deleted file mode 100644
index 29c52a7a8b..0000000000
--- a/docs/layouts/shortcodes/generated/rest_catalog.html
+++ /dev/null
@@ -1,22 +0,0 @@
-{{/*
-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
