Skip to content

OpenAPI: Add Basic Auth to the REST spec#15892

Open
roryqi wants to merge 2 commits intoapache:mainfrom
roryqi:spec
Open

OpenAPI: Add Basic Auth to the REST spec#15892
roryqi wants to merge 2 commits intoapache:mainfrom
roryqi:spec

Conversation

@roryqi
Copy link
Copy Markdown
Contributor

@roryqi roryqi commented Apr 5, 2026

Updated the OpenAPI specification to include Basic Authentication, reflecting the support already present in the Iceberg RESTCatalog. I'm uncertain if we need to initiate a discussion on the dev mailing list for this.

@roryqi roryqi changed the title Add basic auth for the rest spec OpenAPI: Add basic auth for the rest spec Apr 5, 2026
@roryqi
Copy link
Copy Markdown
Contributor Author

roryqi commented Apr 5, 2026

@kelvin9314 @singhpk234 Could u help review this pull request?

@roryqi roryqi changed the title OpenAPI: Add basic auth for the rest spec OpenAPI: Add Basic Auth to the REST spec Apr 5, 2026
Copy link
Copy Markdown
Contributor

@singhpk234 singhpk234 left a comment

Choose a reason for hiding this comment

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

Thanks for raising this @roryqi

IIUC you are talking of basic header ? if yes it think its pretty common to send the base64 of clientId : secret,

IRC servers such as Apache Polaris already support this : https://github.com/apache/polaris/blob/main/runtime/service/src/main/java/org/apache/polaris/service/auth/internal/service/DefaultOAuth2ApiService.java#L84

other IRC client such as DuckDb already send them :
https://github.com/duckdb/duckdb-iceberg/blob/main/src/catalog/rest/storage/authorization/oauth2.cpp#L163

Nevertheless i would still recommend opening ML Discuss thread !

security:
- OAuth2: [catalog]
- BearerAuth: []
- BasicAuth: []
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are you talking of Basic header ?
If yes i think we would need to define it bit better like bearer: https://github.com/roryqi/iceberg/blob/0519d2d1fe3427299d1191b64bcd0376f7f43bf0/open-api/rest-catalog-open-api.yaml#L5265

Copy link
Copy Markdown
Contributor Author

@roryqi roryqi Apr 5, 2026

Choose a reason for hiding this comment

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

Yes, I am talking of Basic header.

OpenAPI has defined Bearer header and Basic header.
You can see
https://swagger.io/docs/specification/v3_0/authentication/bearer-authentication/
https://swagger.io/docs/specification/v3_0/authentication/basic-authentication/

I will add the definition, too.

Thanks for your review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants