jackye1995 commented on code in PR #9695:
URL: https://github.com/apache/iceberg/pull/9695#discussion_r1742315149
##########
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:
+1
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -3647,6 +4080,105 @@ components:
type: integer
description: "List of equality field IDs"
+ PlanTableScanRequest:
+ type: object
+ properties:
+ snapshot-id:
+ description:
+ Identifier for the snapshot to scan in a point-in-time scan
+ type: integer
+ format: int64
+ select:
+ description: List of selected schema fields
+ type: array
+ items:
+ $ref: '#/components/schemas/FieldName'
+ filter:
+ description:
+ Expression used to filter the table data
+ $ref: '#/components/schemas/Expression'
+ case-sensitive:
+ description: Enables case sensitive field matching for filter and
select
+ type: boolean
+ default: true
+ use-snapshot-schema:
+ description:
+ Whether to use the schema at the time the snapshot was written.
+
+ When time travelling, the snapshot schema should be used (true).
+ When scanning a branch, the table schema should be used (false).
+ type: boolean
+ default: false
+ start-snapshot-id:
+ description: Starting snapshot ID for an incremental scan (exclusive)
+ type: integer
+ format: int64
+ end-snapshot-id:
+ description:
+ Ending snapshot ID for an incremental scan (inclusive).
+
+ Required when start-snapshot-id is specified.
+ type: integer
+ format: int64
+ stats-fields:
+ description:
+ List of fields for which the service should send column stats.
+ type: array
+ items:
+ $ref: '#/components/schemas/FieldName'
+
+ FieldName:
+ description:
+ A full field name (including parent field names), such as those passed
+ in APIs like Java `Schema#findField(String name)`.
+
+ The nested field name follows these rules
+ - Nested struct fields are named by concatenating field names at each
+ struct level using dot (`.`) delimiter, e.g.
+ employer.contact_info.address.zip_code
+ - Nested fields in a map key are named using the keyword `key`, e.g.
+ employee_address_map.key.first_name
+ - Nested fields in a map value are named using the keyword `value`,
+ e.g. employee_address_map.value.zip_code
+ - Nested fields in a list are named using the keyword `element`, e.g.
+ employees.element.first_name
+ type: string
+
+ FetchScanTasksRequest:
+ type: object
+ required:
+ - plan-task
+ properties:
+ plan-task:
+ $ref: '#/components/schemas/PlanTask'
+
+ PlanTask:
+ description:
+ An opaque JSON object provided by the REST server that represents a
Review Comment:
I would +1 for using a string. using an opaque object seems to be a bit
difficult to parse and use, just after prototyping this at server side. There
are also concerns from our security engineers for opening another injection
surface directly in API model, that is not protected by either the service's
data model layer, nor string parsers that are typically more easily reviewed.
But these are all solvable issues. Curious what others think.
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -629,7 +887,7 @@ paths:
The snapshots to return in the body of the metadata. Setting the
value to `all` would
return the full set of snapshots currently valid for the table.
Setting the value to
`refs` would load all snapshots referenced by branches or tags.
-
+
Review Comment:
nit: remove unnecessary newline changes
--
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
