Skip to content
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

Separate Polaris-native API from Iceberg Rest Catalog API spec #906

Merged
merged 27 commits into from
Feb 4, 2025
Merged

Separate Polaris-native API from Iceberg Rest Catalog API spec #906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
e792fff
Add policy management APIs spec
HonahX Jan 13, 2025
35df43b
update errors and fix format issues
HonahX Jan 13, 2025
9e3d993
Update spec based on discussion
HonahX Jan 14, 2025
d7526ac
update rest spec and generate models
HonahX Jan 16, 2025
7162da6
add implementation example
HonahX Jan 16, 2025
9b5d926
Merge branch 'main' into honahx_policy_management_apis
HonahX Jan 16, 2025
35f2c11
update to new branch
HonahX Jan 16, 2025
608f521
update rest spec
HonahX Jan 17, 2025
7993dc0
fix import in PolarisCatalogHandlerWrapper
HonahX Jan 17, 2025
b87a4de
clean up
HonahX Jan 22, 2025
b8a1959
remove unnecessary change
HonahX Jan 22, 2025
97c3803
PoC
HonahX Jan 23, 2025
d65742d
separate policy management api out
HonahX Jan 23, 2025
eda146b
add blank line
HonahX Jan 23, 2025
bad36cf
add missing file
HonahX Jan 23, 2025
c86a4c4
add license header
HonahX Jan 23, 2025
50def94
make models auto-generated
HonahX Jan 23, 2025
ba05af5
remove unnecessary models
HonahX Jan 23, 2025
af44410
Merge branch 'main' into honahx_api_split_try
HonahX Jan 28, 2025
9a6727f
use ref for securityschemes
HonahX Jan 28, 2025
5771c0b
separate apis and add comments
HonahX Jan 29, 2025
469a47c
add README and do some rename
HonahX Jan 29, 2025
d258e93
change name
HonahX Jan 29, 2025
a948ef3
move rest-catalog-open-api back to root
HonahX Jan 30, 2025
f53cd61
add doc and generated bundle file
HonahX Jan 30, 2025
0976130
fix style
HonahX Jan 30, 2025
28f835f
Thanks Jack!
HonahX Jan 31, 2025
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
2 changes: 1 addition & 1 deletion api/iceberg-service/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ dependencies {
}

openApiGenerate {
inputSpec = "$rootDir/spec/rest-catalog-open-api.yaml"
inputSpec = "$rootDir/spec/polaris-catalog-service.yaml"
generatorName = "jaxrs-resteasy"
outputDir = "$projectDir/build/generated"
apiPackage = "org.apache.polaris.service.catalog.api"
Expand Down
29 changes: 29 additions & 0 deletions spec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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
HonahX marked this conversation as resolved.
Show resolved Hide resolved
- `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-apis` - Contains the specifications of Polaris-native API
- `rest-catalog-open-api.yaml` - Contains the specification for Iceberg Rest Catalog API
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we might want to rename this as iceberg-rest-catalog-open-api.yaml just to be clear.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I plan to do the rename in a follow-up PR because

  1. The current rest-catalog-open-api.yaml is referenced in our hugo site setting
  2. We need to extract additional stuff from rest-catalog-open-api.yaml to make it match a released version of API.

I think we can do the above 2 together in one separate PR so the current one won't contain too many changes


## Generated Specification Files
The specification files in the generated folder are automatically created using OpenAPI bundling tools such as
[Redocly CLI](https://github.com/Redocly/redocly-cli).

These files should not be manually edited (except adding license header). They are intended for preview purposes only,
such as rendering a preview on a website.

Whenever the source specification files are updated, the generated files must be re-generated to reflect those changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is re-generation manual or part of build process? I think we could make it part of build process if it's manual. Not a blocker for this PR though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently it's manual. I think once we find a way to render local rest spec YAML instead of referring to GitHub main branch one, we can make this automatic.


Below are steps to generate `bundled-polaris-catalog-service.yaml`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to also commit the generated file? If possible I think we should have that in .gitignore

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it is a weird but it is necessary for Polaris's hugo site to render preview.
https://github.com/apache/polaris/blob/main/site/content/in-dev/unreleased/rest-catalog-open-api.md?plain=1#L27

polaris/site/layouts/shortcodes/redoc-polaris.html

Line 39 in 569bf02

{{- $url = printf "https://raw.githubusercontent.com/apache/polaris/refs/heads/main/spec/%s" $spec }}

The site need a url of the yaml to render the preview: https://polaris.apache.org/in-dev/unreleased/rest-catalog-open-api/, so we have to push it to the github

We can remove the generated one from github if our site can render a local yaml, but that to my current understanding will require non-trivial change to our site so we may explore later.

### Install redocly-cli
```
npm install @redocly/cli -g
```

### Generate the Bundle
```
redocly bundle spec/polaris-catalog-open-api.yaml -o spec/generated/generated-polaris-catalog-service.yaml
```


Loading