Skip to content
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.

Sign up for GitHub

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

Match LoadArraySchemaResponse property names with core capnp spec. #473

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Match LoadArraySchemaResponse property names with core capnp spec. #473

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f10c45b
Match property names with core capnp spec.
shaunrd0 Aug 5, 2024
bcf622a
Use ArraySchemaMap in v1 route.
shaunrd0 Aug 7, 2024
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
29 changes: 24 additions & 5 deletions openapi-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,26 @@ definitions:
type: "ArraySchema"
embedded: true

ArraySchemaMap:
type: object
description: array's schemas
properties:
entries:
description: List of array schemas entries
type: array
x-omitempty: true
items:
$ref: "#/definitions/ArraySchemaEntry"

ArraySchemaEntry:
type: object
description: key/value pair representing an array schema map entry
properties:
key:
type: string
value:
$ref: "#/definitions/ArraySchema"

AttributeBufferHeader:
description: Represents an attribute buffer header information
type: object
Expand Down Expand Up @@ -4816,13 +4836,12 @@ definitions:
description: Contains the latest schema and all schemas for the opened array
type: object
properties:
latest_array_schema:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we add a comment here, explaining that this must match what core expects?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I was thinking along the same lines, how to avoid that very nasty issue in the future (great job finding it!!).

Since there is no automated way, maybe adding a comment in this file in a very visible way and updating our own documentation could help a bit: https://github.com/TileDB-Inc/TileDB-Cloud-REST/blob/7c23501a9d7d491bc09028b5cb8c223d68c306c7/docs/UpgradeCapnpSchemas.md

schema:
description: latest array schema
$ref: "#/definitions/ArraySchema"
all_array_schemas:
arraySchemasAll:
description: map of all array schemas
type: object
additionalProperties:
$ref: "#/definitions/ArraySchema"
$ref: "#/definitions/ArraySchemaMap"

RetryStrategy:
description: RetryStrategy provides controls on how to retry a taskgraph node
Expand Down
Loading