Skip to content

Spec, OpenAPI: Define hex case for binary and fixed values (#18352) #18433

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

Open
zhang-arvin wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −7
Open

Spec, OpenAPI: Define hex case for binary and fixed values (#18352) #18433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions format/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1881,8 +1881,8 @@ The binary single-value serialization can be used to store the lower and upper b
| **`timestamptz_ns`** | **`JSON string`** | `"2017-11-16T22:31:08.123456789+00:00"` | Stores ISO-8601 standard timestamp with nanosecond precision; must include a zone offset and it must be '+00:00' |
| **`string`** | **`JSON string`** | `"iceberg"` | |
| **`uuid`** | **`JSON string`** | `"f79c3e09-677c-4bbd-a479-3f349cb785e7"` | Stores the lowercase uuid string |
| **`fixed(L)`** | **`JSON string`** | `"000102ff"` | Stored as a hexadecimal string |
| **`binary`** | **`JSON string`** | `"000102ff"` | Stored as a hexadecimal string |
| **`fixed(L)`** | **`JSON string`** | `"000102FF"` | Stored as a hexadecimal string; writers should emit uppercase, readers must accept either case |
| **`binary`** | **`JSON string`** | `"000102FF"` | Stored as a hexadecimal string; writers should emit uppercase, readers must accept either case |
| **`struct`** | **`JSON object by field ID`** | `{"1": 1, "2": "bar"}` | Stores struct fields using the field ID as the JSON field name; field values are stored using this JSON single-value format |
| **`list`** | **`JSON array of values`** | `[1, 2, 3]` | Stores a JSON array of values that are serialized using this JSON single-value format |
| **`map`** | **`JSON object of key and value arrays`** | `{ "keys": ["a", "b"], "values": [1, 2] }` | Stores arrays of keys and values; individual keys and values are serialized using this JSON single-value format |
Expand Down
4 changes: 2 additions & 2 deletions open-api/rest-catalog-open-api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1203,15 +1203,15 @@ class TimestampTzNanoTypeValue(RootModel[str]):
class FixedTypeValue(RootModel[str]):
root: str = Field(
...,
description='Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length',
description='Fixed length type values are stored and serialized as a hexadecimal string preserving the fixed length. Writers should emit uppercase hexadecimal characters; readers must accept either case',
examples=['78797A'],
)


class BinaryTypeValue(RootModel[str]):
root: str = Field(
...,
description='Binary type values are stored and serialized as an uppercase hexadecimal string',
description='Binary type values are stored and serialized as a hexadecimal string. Writers should emit uppercase hexadecimal characters; readers must accept either case',
examples=['78797A'],
)

Expand Down
9 changes: 6 additions & 3 deletions open-api/rest-catalog-open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5463,14 +5463,17 @@ components:
FixedTypeValue:
type: string
description:
"Fixed length type values are stored and serialized as an uppercase hexadecimal string
preserving the fixed length"
"Fixed length type values are stored and serialized as a hexadecimal string
preserving the fixed length. Writers should emit uppercase hexadecimal
characters; readers must accept either case"
example: "78797A"

BinaryTypeValue:
type: string
description:
"Binary type values are stored and serialized as an uppercase hexadecimal string"
"Binary type values are stored and serialized as a hexadecimal string.
Writers should emit uppercase hexadecimal characters; readers must accept
either case"
example: "78797A"

CountMap:
Expand Down
Loading