Skip to content

Add ORD Overlays support for patching ORD information - #148

Open
Fannon wants to merge 2 commits into
mainfrom
ord-overlay-ord-target
Open

Add ORD Overlays support for patching ORD information#148
Fannon wants to merge 2 commits into
mainfrom
ord-overlay-ord-target

Conversation

@Fannon

@Fannon Fannon commented Jun 5, 2026

Copy link
Copy Markdown
Member

Added

  • Bumped ORD Overlay spec to 0.2 and reintroduced the ordId selector (OverlaySelectorByOrdId).
    • A patch can now target an ORD resource itself (e.g. an API Resource or Event Resource) by its ORD ID and patch its ORD-level metadata (title, description, tags, visibility, ...) without going through a referenced definition file.
    • When all patches in an overlay use selector.ordId, the document-level target MAY be omitted — each patch carries its own resource identifier and a single overlay file MAY patch multiple ORD resources at once.
    • ORD Aggregators MUST apply such overlays when building their ORD Discovery API and related indexes so that ORD-level overlay changes are reflected in discovery, filtering, and searching.
    • The ordOverlay enum now accepts both "0.1" (kept for backward compatibility with overlays produced under ORD 1.16.0) and "0.2" (new overlays SHOULD use "0.2").

@Fannon Fannon self-assigned this Jun 5, 2026
@Fannon Fannon added this to the 1.17.0 milestone Jun 5, 2026
@Fannon
Fannon requested a review from swennemers June 5, 2026 11:21
@open-resource-discovery-bot

Copy link
Copy Markdown
PR Preview

QR code for preview link

🚀 View preview at:
https://open-resource-discovery.github.io/pr-preview/specification/pr-148/

Built to branch main at 2026-06-05 11:24 UTC.
open-resource-discovery/pr-preview-action

x-introduced-in-version: "1.15.0"
description: |-
ORD Overlay file for patching referenced resource definition files.
ORD Overlay file for patching ORD resources and/or referenced resource definition files.

@swennemers swennemers Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think we should allow patching ORD resources at this place, next to the resource definitions

Suggested change
ORD Overlay file for patching ORD resources and/or referenced resource definition files.
ORD Overlay file for patching referenced resource definition files.

x-introduced-in-version: "1.15.0"
description: |-
ORD Overlay file for patching metadata / resource definition files.
ORD Overlay file for patching ORD resources and/or referenced resource definition files.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

see above

Comment on lines +40 to +43
Version `0.2` adds the `ordId` selector for patching ORD resource metadata directly,
and allows the document-level `target` to be omitted when all patches use `selector.ordId`.
Version `0.1` is still accepted for backward compatibility with overlays produced under
ORD 1.16.0; new overlays SHOULD use `"0.2"`.

@swennemers swennemers Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

sure that we want the changelog in the description? do we have an alternative place for this.

@Fannon Fannon added the enhancement New feature or request label Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants