Hi Team,

I’d like to start a discussion about removing the use of allowEmptyValue in
the REST Catalog API, in light of OAI/OpenAPI-Specification#1632.

The use of allowEmptyValue is not recommended, and it is likely to be
removed in a future revision of the OpenAPI specification.

This option has proven to be ambiguous (issue #1573), as demonstrated by
the need for a recent improvement (PR #13129) which allows omitting the
pageToken parameter in the first paginated request.

I propose removing allowEmptyValue from the specification now, while
maintaining backwards-compatible behavior until the next major release.

I’d appreciate any thoughts or suggestions from the community. I’m also
happy to contribute to this effort.

Kind regards,
Elphas

References:
- OAI/OpenAPI-Specification#1632:
https://github.com/OAI/OpenAPI-Specification/pull/1632
- issue #1573: https://github.com/OAI/OpenAPI-Specification/issues/1573
- PR #13129: https://github.com/apache/iceberg/pull/13129
- Published OpenAPI Specification:
https://spec.openapis.org/oas/v3.1.1.html#common-fixed-fields
- allowEmptyValue in pageToken parameter:
https://github.com/apache/iceberg/blob/7b8bd29ce80bc78ed882f0613f7570e78e325988/open-api/rest-catalog-open-api.yaml#L1883
- allowEmptyValue in parent parameter:
https://github.com/apache/iceberg/blob/7b8bd29ce80bc78ed882f0613f7570e78e325988/open-api/rest-catalog-open-api.yaml#L266

Reply via email to