Skip to content

fix: x-camara-commonalities to use full version string#599

Open
hdamker wants to merge 1 commit intocamaraproject:mainfrom
hdamker:fix/x-camara-commonalities-full-version
Open

fix: x-camara-commonalities to use full version string#599
hdamker wants to merge 1 commit intocamaraproject:mainfrom
hdamker:fix/x-camara-commonalities-full-version

Conversation

@hdamker
Copy link
Collaborator

@hdamker hdamker commented Mar 13, 2026

What type of PR is this?

  • correction

What this PR does / why we need it:

Updates the x-camara-commonalities extension field to use the full version string (e.g. 0.7.0 or 0.7.0-rc.1) instead of just the minor version (e.g. "0.7").

With the introduction of release automation (tooling#119), this field is set automatically using the version from VERSION.yaml at the Commonalities release tag. The original restriction to minor-only was motivated by manual maintenance effort, which no longer applies.

Changes:

  • API Design Guide (section 5.3.7): updated guideline text and example to use full version string
  • CAMARA_common.yaml: "0.7"0.7.0
  • event-subscription-template.yaml: "0.7"0.7.0

Which issue(s) this PR fixes:

Fixes #598

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

The release automation tooling already writes the full version string. This PR aligns the guideline and artifacts with the automated behavior.

Changelog input

 release-note
x-camara-commonalities extension field now uses full version string (e.g. 0.7.0) instead of minor-only (e.g. 0.7)

Additional documentation

docs
Updated section 5.3.7 of CAMARA-API-Design-Guide.md

…roject#598)

With the introduction of release automation, the x-camara-commonalities
field is set automatically and can now use the full version string from
VERSION.yaml instead of just the minor version. Updated the API Design
Guide and artifacts accordingly.
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

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

LGTM

@PedroDiez
Copy link
Contributor

@hdamker one doubt, intention is to use this model since Signal26, isn't?

@Kevsy
Copy link
Collaborator

Kevsy commented Mar 16, 2026

LGTM, but a related question: should there be a schema definition for `x-commonalities-version' ? The Open API Specification has no constraints for the extension value datatype, but should we (e.g. a regex?)

@hdamker
Copy link
Collaborator Author

hdamker commented Mar 17, 2026

LGTM, but a related question: should there be a schema definition for `x-commonalities-version' ? The Open API Specification has no constraints for the extension value datatype, but should we (e.g. a regex?)

@Kevsy Good question. Since this is purely a static metadata field (never part of API requests/responses), a schema wouldn't really add value. The format is already defined by convention — it's the version string from VERSION.yaml at the Commonalities release tag, so it follows semver. And our tooling already ensures it programmatically, which can do more than a regex (e.g., checking it matches the actual Commonalities release used).

@hdamker
Copy link
Collaborator Author

hdamker commented Mar 17, 2026

@hdamker one doubt, intention is to use this model since Signal26, isn't?

@PedroDiez Yes, the intention is to apply this from Spring26 (not renamed to Signal26 btw) onwards. The release automation will set this field automatically using the version from VERSION.yaml at the Commonalities release tag.

Copy link
Contributor

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

LGTM

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.

x-camara-commonalities field should use full version string

4 participants