This is an automated email from the ASF dual-hosted git repository.
adutra 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 2f9adaf00 OpenAPI specs: update README with detailed API
specifications (#3629)
2f9adaf00 is described below
commit 2f9adaf0076af4e38de00eaf87e6aabc35394e80
Author: Alexandre Dutra <[email protected]>
AuthorDate: Tue Feb 3 09:50:52 2026 +0100
OpenAPI specs: update README with detailed API specifications (#3629)
---
spec/README.md | 36 ++++++++++++++++++++++++++++--------
1 file changed, 28 insertions(+), 8 deletions(-)
diff --git a/spec/README.md b/spec/README.md
index 8d2c0d0f0..21e728872 100644
--- a/spec/README.md
+++ b/spec/README.md
@@ -17,14 +17,34 @@
under the License.
-->
-# Polaris API Specifications
-
-Polaris provides two sets of OpenAPI specifications:
-- `polaris-management-service.yml` - Defines the management APIs for using
Polaris to create and manage Iceberg catalogs and their principals
-- `polaris-catalog-service.yaml` - Defines the specification for the Polaris
Catalog API, which encompasses both the Iceberg REST Catalog API
- and Polaris-native API.
- - `polaris-catalog-apis` - Contains the specification for Polaris-specific
Catalog APIs
- - `iceberg-rest-catalog-open-api.yaml` - Contains the specification for
Iceberg Rest Catalog API
+# Apache Polaris API Specifications
+
+Apache Polaris provides the following OpenAPI specifications:
+
+- [polaris-management-service.yml](polaris-management-service.yml) - Defines
the management APIs for creating and managing
+ principals, principal roles, catalogs and catalog roles.
+
+- [polaris-catalog-service.yaml](polaris-catalog-service.yaml) - Defines the
specification for the Apache Polaris
+ Catalog API, which encompasses both the Apache Iceberg REST Catalog API and
Apache
+ Polaris-native APIs:
+
+ - [iceberg-rest-catalog-open-api.yaml](iceberg-rest-catalog-open-api.yaml)
- Contains the specification for
+ Apache Iceberg Rest Catalog API.
+
+ - [polaris-catalog-apis](polaris-catalog-apis) - This folder contains the
specifications for Apache
+ Polaris-specific Catalog APIs:
+
+ -
[generic-tables-api.yaml](polaris-catalog-apis/generic-tables-api.yaml) -
Contains the specification for
+ the Generic Tables API.
+
+ -
[notifications-api.yaml](polaris-catalog-apis/notifications-api.yaml) -
Contains the specification for
+ the Notifications API.
+
+ - [policy-apis.yaml](polaris-catalog-apis/policy-apis.yaml) - Contains
the specification for the Policy APIs.
+
+ - [oauth-tokens-api.yaml](polaris-catalog-apis/oauth-tokens-api.yaml)
- Contains the specification for the
+ internal OAuth Token endpoint, extracted from the Apache Iceberg
REST Catalog API.
+
## Generated Specification Files
The specification files in the generated folder are automatically created
using OpenAPI bundling tools such as
