You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "kevinjqliu (via GitHub)" <gi...@apache.org> on 2025/11/19 18:29:02 UTC
[I] Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status [iceberg]
kevinjqliu opened a new issue, #14632:
URL: https://github.com/apache/iceberg/issues/14632
### Apache Iceberg version
main (development)
### Query engine
None
### Please describe the bug 🐞
Thanks to #14480 and a lot of other great efforts, I was able to try out the scan planning apis that is now in the `iceberg-rest-fixture`.
I provided LLM with the scan planning openapi spec so that I can quickly generate a rest client to interact with the apis and found this discrepancy.
#### Description
The OpenAPI specification indicates that the response field for planning status should be `status`, but the server implementation currently returns `plan-status` instead.
`status`
* https://github.com/apache/iceberg/blob/bec6793af822cb791fa5975b41b8936631556c46/open-api/rest-catalog-open-api.yaml#L3370-L3381
`plan-status`
* https://github.com/apache/iceberg/blob/bec6793af822cb791fa5975b41b8936631556c46/core/src/main/java/org/apache/iceberg/rest/responses/PlanTableScanResponseParser.java#L36
* https://github.com/apache/iceberg/blob/bec6793af822cb791fa5975b41b8936631556c46/core/src/main/java/org/apache/iceberg/rest/responses/FetchPlanningResultResponseParser.java#L36
#### Suggested Fix
1. **Update the implementation** to align with the OpenAPI spec by returning `status` instead of `plan-status`.
2. **Update the OpenAPI spec** to align with implementation and use `plan-status` instead of `status`
### Willingness to contribute
- [x] I can contribute a fix for this bug independently
- [x] I would be willing to contribute a fix for this bug with guidance from the Iceberg community
- [ ] I cannot contribute a fix for this bug at this time
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status [iceberg]
Posted by "singhpk234 (via GitHub)" <gi...@apache.org>.
singhpk234 commented on issue #14632:
URL: https://github.com/apache/iceberg/issues/14632#issuecomment-3556306306
Thanks for reporting
considering we have `plan-id` and `plan-task`, `plan-status` seems reasonable, I can now think how this confusion arised when i was implementing
Let me put a PR for this in the spec and we can gather feedbacks from more folks
cc @amogh-jahagirdar @nastra
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status [iceberg]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on issue #14632:
URL: https://github.com/apache/iceberg/issues/14632#issuecomment-3563237022
@singhpk234 should we also backport these 2 for the 1.10.x branch?
https://github.com/apache/iceberg/pull/14631
https://github.com/apache/iceberg/pull/14626
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status [iceberg]
Posted by "singhpk234 (via GitHub)" <gi...@apache.org>.
singhpk234 commented on issue #14632:
URL: https://github.com/apache/iceberg/issues/14632#issuecomment-3557584216
Thinking of this more it will break clients that are existing like duck-db
https://github.com/duckdb/duckdb-iceberg/blob/main/src/rest_catalog/objects/completed_planning_result.cpp#L31
better to fix this in java then 😕 i guess for a long time the spec without any impl, has been there hard to go other wise now as it would break other clients.
I will put a PR for fixing in java and then back port
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status [iceberg]
Posted by "singhpk234 (via GitHub)" <gi...@apache.org>.
singhpk234 closed issue #14632: Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status
URL: https://github.com/apache/iceberg/issues/14632
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Scan Planning: Mismatch between OpenAPI spec and implementation, plan-status vs status [iceberg]
Posted by "nastra (via GitHub)" <gi...@apache.org>.
nastra commented on issue #14632:
URL: https://github.com/apache/iceberg/issues/14632#issuecomment-3558460050
yeah I think fixing the java impl is the right thing to do, because we don't know whether anyone already implements this according to the spec
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org