danielcweeks commented on code in PR #9695:
URL: https://github.com/apache/iceberg/pull/9695#discussion_r1739346673
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -2774,6 +3062,140 @@ components:
additionalProperties:
type: string
+ ScanTasks:
+ type: object
+ description:
+ Scan and planning tasks for server-side scan planning
+
+
+ - `plan-tasks` contains opaque units of planning work
+
+ - `file-scan-tasks` contains a partial list of table scan tasks
+
+ - `delete-files` contains delete files referenced by file scan tasks
+
+
+ Each plan task must be passed to the fetchScanTasks endpoint to fetch
+ the file scan tasks for the plan task.
+
+
+ The list of delete files must contain all delete files referenced by
+ the file scan tasks.
+ properties:
+ delete-files:
+ description: Delete files referenced by file scan tasks
+ type: array
+ items:
+ $ref: '#/components/schemas/DeleteFile'
+ file-scan-tasks:
+ type: array
+ items:
+ $ref: '#/components/schemas/FileScanTask'
+ plan-tasks:
+ type: array
+ items:
+ $ref: '#/components/schemas/PlanTask'
+
+ CompletedPlanningResult:
+ type: object
+ description: Completed server-side planning result
+ allOf:
+ - $ref: '#/components/schemas/ScanTasks'
+ - type: object
+ required:
+ - status
+ properties:
+ status:
+ $ref: '#/components/schemas/PlanStatus'
+ enum: ["completed"]
+
+ CompletedPlanningWithIDResult:
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/CompletedPlanningResult'
+ - type: object
+ properties:
+ plan-id:
+ description: ID used to track a planning request
+ type: string
+
+ FailedPlanningResult:
+ type: object
+ description: Failed server-side planning result
+ allOf:
+ - $ref: '#/components/schemas/IcebergErrorResponse'
+ - type: object
+ required:
+ - status
+ properties:
+ status:
+ $ref: '#/components/schemas/PlanStatus'
+ enum: ["failed"]
+
+ AsyncPlanningResult:
+ type: object
+ required:
+ - status
+ properties:
+ status:
+ $ref: '#/components/schemas/PlanStatus'
+ enum: ["submitted"]
+ plan-id:
+ description: ID used to track a planning request
+ type: string
+
+ EmptyResult:
Review Comment:
```suggestion
EmptyPlanningResult:
```
To keep result names consistent.
--
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
