Skip to content

Message spec review#413

Merged
duglin merged 1 commit into
xregistry:mainfrom
lailabougria:message-spec-review
Oct 22, 2025
Merged

Message spec review#413
duglin merged 1 commit into
xregistry:mainfrom
lailabougria:message-spec-review

Conversation

@lailabougria

@lailabougria lailabougria commented Oct 13, 2025

Copy link
Copy Markdown
Contributor

Proposed Changes

  • typos, cleanup
  • Explain how "basemessage" can be leveraged to reuse/extend an existing msgDef
  • Explain "context attributes" in the message spec
    • how they can have "templates" that are filled-in with environment provided data
    • how they can be used to help convert message - e.g. to turn an event into a CloudEvent
  • Document why the message spec recommends a single message definition version
    • and why "on the wire" edits should be avoided]
    • and recommendation on how to map incoming msg to its msgDef (use CE 'type' -> msgID)

Comment thread endpoint/spec.md Outdated

This specification limits the number of versions of a message definition to
one, indicated by the `maxversions` attribute in the model. That means that a
message definition is not versioned, and should not be altered once it is

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

SHOULD NOT

not even for typos or other non-on-the-wire changes?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The challenge is that the specification then should define what constitutes an acceptable change.

Comment thread endpoint/spec.md Outdated
adds another layer of complexity that can overcomplicate matching the right
message definition and schema. In addition, message definition metadata can be
relied upon by intermediaries and consumers, and changing a message
definition may break those. Therefore, a change in the message definition,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/may/can/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

Comment thread endpoint/spec.md Outdated
relied upon by intermediaries and consumers, and changing a message
definition may break those. Therefore, a change in the message definition,
once it's flowing through a given system, is considered a breaking change,
which should be reflected by the introduction of a new message definition

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

SHOULD

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

Fixes xregistry#406

Signed-off-by: Clemens Vasters <clemens@vasters.com>
Signed-off-by: Laila Bougria <laila@igindo.com>
@duglin
duglin force-pushed the message-spec-review branch from ffcb9e1 to 9071629 Compare October 15, 2025 14:14
@duglin

duglin commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

@clemensv please look over the edts to see if you're ok with them. In particular the stuff about maxversions

@duglin

duglin commented Oct 22, 2025

Copy link
Copy Markdown
Contributor

Approved on the 10/16 call

@duglin
duglin merged commit 2350521 into xregistry:main Oct 22, 2025
2 checks passed
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.

Explain "context attributes" in the message spec

3 participants