This is an automated email from the ASF dual-hosted git repository.
pingtimeout pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 9057fc395 chore(docs): add polaris-api-specs section (#2598)
9057fc395 is described below
commit 9057fc39545c138c0c6074e92a36643da8d85c03
Author: Artur Rakhmatulin <[email protected]>
AuthorDate: Thu Sep 18 18:14:34 2025 +0100
chore(docs): add polaris-api-specs section (#2598)
---
.../_index.md} | 11 ++++++-----
.../polaris-catalog-api.md} | 5 +++--
.../polaris-management-api.md} | 6 +++---
site/content/in-dev/unreleased/polaris-spark-client.md | 2 +-
4 files changed, 13 insertions(+), 11 deletions(-)
diff --git a/site/content/in-dev/unreleased/polaris-catalog-service.md
b/site/content/in-dev/unreleased/polaris-api-specs/_index.md
similarity index 64%
copy from site/content/in-dev/unreleased/polaris-catalog-service.md
copy to site/content/in-dev/unreleased/polaris-api-specs/_index.md
index 02fed63f4..3f4a98498 100644
--- a/site/content/in-dev/unreleased/polaris-catalog-service.md
+++ b/site/content/in-dev/unreleased/polaris-api-specs/_index.md
@@ -17,10 +17,11 @@
# specific language governing permissions and limitations
# under the License.
#
-linkTitle: 'Catalog API Spec'
-weight: 900
-params:
- show_page_toc: false
+title: 'Polaris API Reference'
+type: docs
+weight: 1100
---
-{{< redoc-polaris "generated/bundled-polaris-catalog-service.yaml" >}}
+The Apache Polaris API offers a comprehensive set of endpoints that enable you
to manage principals, principal-roles, catalogs, and catalog-roles
programmatically.
+
+It follows REST standards, using clear, resource-based URLs, standard HTTP
methods, response codes, and secure authentication. With the Polaris API, you
can create, manage, and query Iceberg catalogs efficiently.
\ No newline at end of file
diff --git a/site/content/in-dev/unreleased/polaris-catalog-service.md
b/site/content/in-dev/unreleased/polaris-api-specs/polaris-catalog-api.md
similarity index 89%
rename from site/content/in-dev/unreleased/polaris-catalog-service.md
rename to
site/content/in-dev/unreleased/polaris-api-specs/polaris-catalog-api.md
index 02fed63f4..4774c16ca 100644
--- a/site/content/in-dev/unreleased/polaris-catalog-service.md
+++ b/site/content/in-dev/unreleased/polaris-api-specs/polaris-catalog-api.md
@@ -17,8 +17,9 @@
# specific language governing permissions and limitations
# under the License.
#
-linkTitle: 'Catalog API Spec'
-weight: 900
+title: 'Apache Polaris Catalog Service OpenAPI Specification'
+linkTitle: 'Catalog API ↗'
+weight: 200
params:
show_page_toc: false
---
diff --git a/site/content/in-dev/unreleased/polaris-management-service.md
b/site/content/in-dev/unreleased/polaris-api-specs/polaris-management-api.md
similarity index 89%
rename from site/content/in-dev/unreleased/polaris-management-service.md
rename to
site/content/in-dev/unreleased/polaris-api-specs/polaris-management-api.md
index 0b66b9daa..eea43448b 100644
--- a/site/content/in-dev/unreleased/polaris-management-service.md
+++ b/site/content/in-dev/unreleased/polaris-api-specs/polaris-management-api.md
@@ -17,9 +17,9 @@
# specific language governing permissions and limitations
# under the License.
#
-title: 'Apache Polaris Management Service OpenAPI'
-linkTitle: 'Management OpenAPI'
-weight: 800
+title: 'Apache Polaris Management Service OpenAPI Specification'
+linkTitle: 'Management API ↗'
+weight: 100
params:
show_page_toc: false
---
diff --git a/site/content/in-dev/unreleased/polaris-spark-client.md
b/site/content/in-dev/unreleased/polaris-spark-client.md
index b78168e19..c990e565a 100644
--- a/site/content/in-dev/unreleased/polaris-spark-client.md
+++ b/site/content/in-dev/unreleased/polaris-spark-client.md
@@ -23,7 +23,7 @@ weight: 650
---
Apache Polaris now provides Catalog support for Generic Tables (non-Iceberg
tables), please check out
-the [Catalog API Spec]({{% ref "polaris-catalog-service" %}}) for Generic
Table API specs.
+the [Polaris Catalog OpenAPI Spec]({{% ref
"polaris-api-specs/polaris-catalog-api.md" %}}) for Generic Table API specs.
Along with the Generic Table Catalog support, Polaris is also releasing a
Spark client, which helps to
provide an end-to-end solution for Apache Spark to manage Delta tables using
Polaris.
