OpenAPI: Add planning-mode to loadTable response #11156
Open
+37
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jackye1995
reviewed
Sep 18, 2024
| @@ -3138,6 +3149,8 @@ components: | |||
| description: May be null if the table is staged as part of a transaction | |||
| metadata: | |||
| $ref: '#/components/schemas/TableMetadata' | |||
| planning-mode: | |||
| $ref: '#/components/schemas/PlanningMode' | |||
| config: | |||
| type: object | |||
There was a problem hiding this comment.
Looks like from the sync meeting, we are saying the planning mode should be in config, something like:
config:
type: object
properties:
planning-mode:
$ref: '#/components/schemas/PlanningMode'
additionalProperties:
type: string
Is this the right understanding?
jackye1995
reviewed
Sep 18, 2024
| PlanningMode: | ||
| description: Indicates to clients if a service supports server-side planning for a given table. | ||
| type: string | ||
| enum: ["unsupported", "supported", "required"] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently in the iceberg community we landed a new set of scan planning apis within the rest spec #9695.
The following spec change in this pr aims to provide a way for client to know when to call the new scan planning apis. Within a rest catalog, services may choose to support scan planning for all tables or for a subset of tables. In this case we think it would be best to make the change in the
loadTableresponse to indicate if scan planning is supported for the table.cc @rdblue @danielcweeks @jackye1995 @amogh-jahagirdar