Skip to content

RFC-8: v2 - #667

Draft
normanrz wants to merge 1 commit into
ome:mainfrom
normanrz:rfc8-revision-2
Draft

normanrz wants to merge 1 commit into
ome:mainfrom
normanrz:rfc8-revision-2

Conversation

@normanrz

@normanrz normanrz commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

This PR updates the RFC-8 text with the revisions developed in ome/ngff-rfc8-revisions. They follow the round-1 review, Damien Goutte-Gattat's extensibility proposal and Benedikt Best's comment in #627. A summary of all changes, with rules and examples, is in rfc8_revision_changes.md.

Summary of changes

Area Round-1 RFC-8 Revised RFC-8
Node types collection, multiscale, singlescale collection, multiscale. Singlescale is removed and deferred to a sub-RFC.
Type-specific metadata attributes dictionary traits list of typed objects
Free-form metadata attributes Removed. Everything beyond the node fields is a trait.
Extensions Prefixed names (myorg:foo) URI-based types declared in an extensionManifest
Type tiers — Built-in types are core (MUST), recommended (SHOULD) or optional (MAY); custom types start as optional
IDs Optional on nodes, unique per document Required on every declaration, unique per document, restricted character set, UUIDv7 recommended if UUIDs are used
Names Required, unique within the collection Optional, not required to be unique
References {"id": …} {"type": …, "ref": …}, plus an optional path, or a plain ID string where the field fixes the target type
Paths {"type": "zarr", "path": …} {"type": "zarr", "format": "relative", "href": …}
Multiscale layout Singlescale child nodes data list of array objects with downsamplingTransformations
Consolidated metadata — Non-normative section: an optional cache for IO performance
HCS, labels, bioformats2raw, remote references, snake_case, singlescale, legacy multiscales In RFC-8 or not covered Deferred to sub-RFCs

The revision also:

  • Defines the extension manifest, schemas (JSON Schema or LinkML) and the mustUnderstand flag.
  • Adds rules for path resolution, including cycle detection.
  • Adds user story 11 (training crops), new prior art and abandoned ideas, and future work on extensibility.
  • Adds Damien Goutte-Gattat, Draga Doncila Pop and Juan Nunez-Iglesias as co-authors.

Future work

The RFC lists these as future work rather than part of this revision:

  • Restricting which traits can be used on which node types.
  • Revising the mustUnderstand flag.
  • A strategy for managing extensions.

🤖 Generated with Claude Code

Update the RFC-8 text with the revisions developed in
https://github.com/ome/ngff-rfc8-revisions.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@github-actions

Copy link
Copy Markdown
Contributor

Automated Review URLs

@normanrz normanrz changed the title RFC-8: revision 2 RFC-8: v2 Nov 16, 2026
@normanrz
normanrz marked this pull request as draft November 16, 2026 12:15

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant