Skip to content

chore(docs): add polaris-api-specs section #2598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pingtimeout merged 1 commit into from
Sep 18, 2025
Merged

chore(docs): add polaris-api-specs section #2598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions site/content/in-dev/unreleased/polaris-api-specs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
#
# 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.
#
title: 'Polaris API Reference'
type: docs
weight: 1100
---

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.
5 changes: 3 additions & 2 deletions ...dev/unreleased/polaris-catalog-service.md → .../polaris-api-specs/polaris-catalog-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
6 changes: 3 additions & 3 deletions .../unreleased/polaris-management-service.md → ...laris-api-specs/polaris-management-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion site/content/in-dev/unreleased/polaris-spark-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down