Skip to content

Commit d2f6f9d

Browse files
committed
Update group metadata section
1 parent 16e34ca commit d2f6f9d

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

docs/v3/core/v3.0.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -810,29 +810,48 @@ above, but using a (currently made up) extension data type::
810810
Group metadata
811811
--------------
812812

813+
Mandatory
814+
^^^^^^^^^
815+
813816
A Zarr group metadata object must contain the following mandatory key:
814817

815818
``zarr_format``
816-
^^^^^^^^^^^^^^^
819+
"""""""""""""""
817820

818821
An integer defining the version of the storage specification to which the
819822
array store adheres, must be ``3`` here.
820823

821824
``node_type``
822-
^^^^^^^^^^^^^^^
825+
"""""""""""""""
823826

824827
A string defining the type of hierarchy node element, must be ``group``
825828
here.
826829

830+
Optional
831+
^^^^^^^^
832+
827833
Optional keys:
828834

829835
``attributes``
830-
^^^^^^^^^^^^^^
836+
""""""""""""""
831837

832838
The value must be an object. The object may contain any key/value
833839
pairs, where the key must be a string and the value can be an arbitrary
834840
JSON literal. Intended to allow storage of arbitrary user metadata.
835841

842+
Extensions
843+
^^^^^^^^^^
844+
845+
All other names found in the metadata object MUST be interpreted
846+
following the `extensions_section`_.
847+
An implementation MUST fail to open Zarr hierarchies, groups
848+
or arrays if any metadata fields are present which (a) the
849+
implementation does not recognize and (b) are not explicitly
850+
set to ``"must_understand": false``.
851+
852+
Example
853+
^^^^^^^
854+
836855
For example, the JSON document below defines a group::
837856

838857
{

0 commit comments

Comments
 (0)