fix: comment out placeholders in CAMARA_common.yaml for $ref consumption#602
Open
hdamker wants to merge 1 commit intocamaraproject:mainfrom
Open
fix: comment out placeholders in CAMARA_common.yaml for $ref consumption#602hdamker wants to merge 1 commit intocamaraproject:mainfrom
hdamker wants to merge 1 commit intocamaraproject:mainfrom
Conversation
Comment out {{SPECIFIC_CODE}} and {{field}} placeholder patterns in
Generic error responses (400, 403, 404, 409, 422). Commented lines
remain as documentation for API developers. The file becomes directly
consumable via $ref by bundling tools, Spectral, and YAML parsers.
Fixes camaraproject#601
Contributor
|
If we want to use yamllint for artifacts (for now no linting is implemented in Commonalities) then we need to consider that https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.comments_indentation The quick fixes are:
|
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
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:
Comments out
{{SPECIFIC_CODE}}and{{field}}placeholder patterns in Generic error responses (400, 403, 404, 409, 422) ofCAMARA_common.yaml. The commented lines remain as human-readable documentation for API developers, while the file becomes directly consumable via$refby bundling tools, Spectral, and YAML parsers.This unblocks
$ref-based consumption of common schemas as discussed in #577 and the bundling design in ReleaseManagement#436.Three types of placeholder occurrences are commented out:
- "{{SPECIFIC_CODE}}"incodeenums (5 responses)GENERIC_4xx_{{SPECIFIC_CODE}}:entries with their value blocks (5 responses)"{{field}} is not consistent with access token."(1 occurrence in Generic403)Which issue(s) this PR fixes:
Fixes #601
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input
Additional documentation