fix: align API definitions with Design Guide and Commonalities artifacts - #62
Merged
Merged
Conversation
- release-test.yaml: add components section (securitySchemes, x-correlator, ErrorInfo, ServiceStatus), 401/403 error responses, fix x-camara-commonalities, externalDocs, apiRoot description — all inline, no external $ref - sample-service.yaml: sync from Commonalities #606 (title, externalDocs, apiRoot description, pagination, ResourceId maxLength, openId $ref) - CAMARA_common.yaml: sync from #606 (DateTime schema, openId description, components-only format, expanded description) - CAMARA_event_common.yaml: add from #606 for bundling/validation testing
hdamker-bot
approved these changes
Apr 1, 2026
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Aligns both API definitions with the CAMARA API Design Guide and syncs common files with the artifacts restructuring in Commonalities#606.
release-test.yaml (standalone, no external
$ref):componentssection:securitySchemes(openId),x-correlatorheader/parameter,ErrorInfo,ServiceStatusschemasx-camara-commonalities(0.6 → 0.7.0),externalDocsURL,apiRootdescriptionsample-service.yaml (uses
$refto common files):externalDocs,apiRootdescription, pagination on list response,ResourceIdmaxLength for UUIDCAMARA_common.yaml:
DateTimeschema,openIddescription, components-only formatCAMARA_event_common.yaml (new):
Does this PR introduce a breaking change?
Special notes for reviewers:
Both APIs pass Spectral lint with zero errors and zero warnings.
Common files synced from Commonalities#606 — may need minor updates as that PR progresses through review.
Changelog input