Skip to content

Make minor spec changes for XTable REST Service #715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions spec/rest-service-open-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ paths:
summary: Initiate XTable's runSync process to convert a source table format to the requested target table formats.
description: |
Reads the source table metadata from storage, converts it to the requested
target formats.
target formats. *Note* when converting to/from "HUDI", will require the user to set in the request, the following `partition-spec` property
within the `configurations` map.
operationId: convertTable
parameters:
- in: header
Expand Down Expand Up @@ -140,11 +141,11 @@ components:
description: List of desired output table formats (e.g., "ICEBERG", "HUDI", "DELTA")
configurations:
type: object
description: Additional configuration key/value pairs (e.g., storage credentials or other service configs)
description: Additional configuration key/value pairs (e.g. such as 'partition-spec', storage credentials or other service configs).
additionalProperties:
type: string

TargetTable:
ConvertedTable:
type: object
required:
- target-format
Expand All @@ -158,18 +159,21 @@ components:
description: Path where the converted metadata was written
target-schema:
type: string
description: Schema definition of the converted table
description: Schema definition of the requested target table format.
If "HUDI" is the `target-format`, the `target-schema` be an avro string representation.
If "ICEBERG" is the `target-format`, the `target-schema` will be a JSON string following Iceberg's REST Catalog spec for `Schema`.
if "DELTA" is the `target-format`, the `target-schema` will be be a JSON string following Delta's `StructType`.

ConvertTableResponse:
type: object
required:
- conversions
- converted-tables
properties:
conversions:
converted-tables:
type: array
description: A list of converted tables, one per requested format
items:
$ref: '#/components/schemas/TargetTable'
$ref: '#/components/schemas/ConvertedTable'

SubmittedConversionResponse:
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
@Getter
@Builder
public class ConvertTableResponse {
@JsonProperty("convertedTables")
@JsonProperty("converted-tables")
private List<ConvertedTable> convertedTables;

@JsonCreator
Expand Down