amogh-jahagirdar commented on code in PR #9695:
URL: https://github.com/apache/iceberg/pull/9695#discussion_r1641406745
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -2106,6 +2210,32 @@ components:
items:
$ref: '#/components/schemas/PartitionStatisticsFile'
+ PlanTask:
+ description:
+ An opaque JSON object that contains information provided by the REST
server
+ to be utilized by clients for distributed table scan planning; should
be supplied
+ as input in `PlanTable` operation.
+ type: object
+
+ FileScanTask:
+ type: object
+ required:
+ - data-file
+ properties:
+ data-file:
+ $ref: '#/components/schemas/DataFile'
+ delete-files:
+ oneOf:
+ - type: array
+ items:
+ $ref: '#/components/schemas/PositionDeleteFile'
+ - type: array
+ items:
+ $ref: '#/components/schemas/EqualityDeleteFile'
+ residual-filter:
+ description: filters that are not fully applied by the server and
should be pushed down to the file reader when reading the file. When not
present, the residual should be calculated on the client or the original filter
should be used.
Review Comment:
Nit: I think we should replace the instances of "should be" with a stronger
word like "must".
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -3789,6 +4003,21 @@ components:
EmptyResponse:
$ref: '#/components/examples/ListNamespacesEmptyExample'
+ PayloadTooLargeWithPlanResponse:
+ description:
+ Payload is too large. Required to use /preplan before /plan
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IcebergErrorResponse'
+ example: {
+ "error": {
+ "message": " Cannot plan scan: too many task results; use
/preplan to split planning across multiple requests",
Review Comment:
Nit: Can we remove the unneccessary space before `Cannot` in the example.
--
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-unsubscr...@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org
