Skip to content

v2 spec: add optional dimension_separator (see #707) #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.

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

Merged
merged 4 commits into from
Apr 21, 2021
Merged

v2 spec: add optional dimension_separator (see #707) #715

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b3bf13
v2 spec: add optional dimension_separator (see #707)
joshmoore Apr 8, 2021
f287140
Update dim. sep. description after feedback
joshmoore Apr 15, 2021
049e4af
Remove `MUST NOT` restriction for other keys
joshmoore Apr 16, 2021
7f039f3
Merge tag 'v2.7.1' into dim_sep
joshmoore Apr 16, 2021
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
13 changes: 12 additions & 1 deletion docs/spec/v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,18 @@ filters
filters are to be applied. Each codec configuration object MUST contain a
``"id"`` key identifying the codec to be used.

Other keys MUST NOT be present within the metadata object.
The following keys MAY be present within the object:

dimension_separator
If present, either the string ``"."`` or ``"/""`` definining the separator placed
between the dimensions of a chunk. If the value is not set, then the
default MUST be assumed to be ``"."``, leading to chunk keys of the form "0.0".
Arrays defined with ``"/"`` as the dimension separator can be considered to have
nested, or hierarchical, keys of the form "0/0" that SHOULD where possible
produce a directory-like structure.

Other keys SHOULD NOT be present within the metadata object and SHOULD be
ignored by implementations.

For example, the JSON object below defines a 2-dimensional array of 64-bit
little-endian floating point numbers with 10000 rows and 10000 columns, divided
Expand Down