jackye1995 commented on code in PR #9252:
URL: https://github.com/apache/iceberg/pull/9252#discussion_r1420933770
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -530,6 +530,111 @@ paths:
5XX:
$ref: '#/components/responses/ServerErrorResponse'
+ /v1/{prefix}/namespaces/{namespace}/tables/{table}/scans:
+ parameters:
+ - $ref: '#/components/parameters/prefix'
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ post:
+ tags:
+ - Catalog API
+ summary: Create a table scan for the table
+ description:
+ Creates a table scan for the table.
+ operationId: createScan
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateScanRequest'
+ responses:
+ 200:
+ $ref: '#/components/responses/CreateScanResponse'
+ 400:
+ $ref: '#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref: '#/components/responses/ForbiddenResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, the table does not exist
+ - NoSuchNamespaceException, the namespace does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorModel'
+ examples:
+ TableDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 419:
+ $ref: '#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref: '#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref: '#/components/responses/ServerErrorResponse'
+
+
+
+ /v1/{prefix}/namespaces/{namespace}/tables/{table}/scans/{scan}:
+ parameters:
+ - $ref: '#/components/parameters/prefix'
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ - $ref: '#/components/parameters/scan'
+ get:
+ tags:
+ - Catalog API
+ summary: Gets a list of FileScanTasks
+ operationId: getScanTasks
+ description:
+ Gets a list of FileScanTasks
+ parameters:
+ - in: query
+ name: shard
+ description:
+ Reads a single or multiple shards in parallel, to obtain a list of
file scan tasks.
Review Comment:
the description seems to be wrong, it's always a single shard in a single
request
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
