Skip to content

Commit 9057fc3

Browse files
authored
chore(docs): add polaris-api-specs section (#2598)
1 parent ab91f27 commit 9057fc3

File tree

4 files changed

+34
-6
lines changed

4 files changed

+34
-6
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: 'Polaris API Reference'
21+
type: docs
22+
weight: 1100
23+
---
24+
25+
The Apache Polaris API offers a comprehensive set of endpoints that enable you to manage principals, principal-roles, catalogs, and catalog-roles programmatically.
26+
27+
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.

site/content/in-dev/unreleased/polaris-catalog-service.md renamed to site/content/in-dev/unreleased/polaris-api-specs/polaris-catalog-api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@
1717
# specific language governing permissions and limitations
1818
# under the License.
1919
#
20-
linkTitle: 'Catalog API Spec'
21-
weight: 900
20+
title: 'Apache Polaris Catalog Service OpenAPI Specification'
21+
linkTitle: 'Catalog API ↗'
22+
weight: 200
2223
params:
2324
show_page_toc: false
2425
---

site/content/in-dev/unreleased/polaris-management-service.md renamed to site/content/in-dev/unreleased/polaris-api-specs/polaris-management-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
# specific language governing permissions and limitations
1818
# under the License.
1919
#
20-
title: 'Apache Polaris Management Service OpenAPI'
21-
linkTitle: 'Management OpenAPI'
22-
weight: 800
20+
title: 'Apache Polaris Management Service OpenAPI Specification'
21+
linkTitle: 'Management API ↗'
22+
weight: 100
2323
params:
2424
show_page_toc: false
2525
---

site/content/in-dev/unreleased/polaris-spark-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ weight: 650
2323
---
2424

2525
Apache Polaris now provides Catalog support for Generic Tables (non-Iceberg tables), please check out
26-
the [Catalog API Spec]({{% ref "polaris-catalog-service" %}}) for Generic Table API specs.
26+
the [Polaris Catalog OpenAPI Spec]({{% ref "polaris-api-specs/polaris-catalog-api.md" %}}) for Generic Table API specs.
2727

2828
Along with the Generic Table Catalog support, Polaris is also releasing a Spark client, which helps to
2929
provide an end-to-end solution for Apache Spark to manage Delta tables using Polaris.

0 commit comments

Comments
 (0)