Skip to content

Clarification meaning of {{API_NAME}}.{{SPECIFIC_CODE}}#541

Merged
rartych merged 7 commits intocamaraproject:mainfrom
PedroDiez:clarification_meaning_API_NAME.SPECIFIC_CODE
Dec 3, 2025
Merged

Clarification meaning of {{API_NAME}}.{{SPECIFIC_CODE}}#541
rartych merged 7 commits intocamaraproject:mainfrom
PedroDiez:clarification_meaning_API_NAME.SPECIFIC_CODE

Conversation

@PedroDiez
Copy link
Copy Markdown
Contributor

@PedroDiez PedroDiez commented Oct 10, 2025

What type of PR is this?

  • documentation

What this PR does / why we need it:

This PR deals with some clarification required in order to state clearly how to define an specific API exception under the {{API_NAME}}.{{SPECIFIC_CODE}} scheme

Which issue(s) this PR fixes:

Fixes #538

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

N/A

Changelog input

  Clarification meaning of {{API_NAME}}.{{SPECIFIC_CODE}}

Additional documentation

N/A

@PedroDiez PedroDiez self-assigned this Oct 10, 2025
@PedroDiez PedroDiez added the documentation Improvements or additions to documentation label Oct 10, 2025
@PedroDiez PedroDiez added the Spring26 Scope of Spring26 (H1-2026) meta-release label Oct 10, 2025
patrice-conil
patrice-conil previously approved these changes Oct 10, 2025
View reviewed changes
Copy link
Copy Markdown
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

tlohmar
tlohmar approved these changes Oct 13, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@tlohmar tlohmar left a comment

Choose a reason for hiding this comment

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

Looks good.

@rartych
Copy link
Copy Markdown
Contributor

rartych commented Oct 13, 2025

In CAMARA_common.yaml we have

                    enum:
                      - INVALID_ARGUMENT
                      - OUT_OF_RANGE
                      - "{{SPECIFIC_CODE}}"

But in examples code and message are not written in quotes:

            GENERIC_400_{{SPECIFIC_CODE}}:
              description: Specific Syntax Exception regarding a field that is relevant in the context of the API
              value:
                status: 400
                code: { { SPECIFIC_CODE } }
                message: { { SPECIFIC_CODE_MESSAGE } }

This raises linting errors - I did the exercise to check if CAMARA_common.yaml is not propagating linting problems in API definitions. Here it is not the case because the pleaceholders should be replaced in API definitions, but to avoid this error even when linting CAMARA_common.yaml I propose to change code and message attribute:

            GENERIC_400_{{SPECIFIC_CODE}}:
              description: Specific Syntax Exception regarding a field that is relevant in the context of the API
              value:
                status: 400
                code: "{{SPECIFIC_CODE}}"
                message: Message for specific code

The same for:
GENERIC_403_{{SPECIFIC_CODE}},
GENERIC_404_{{SPECIFIC_CODE}},
GENERIC_409_{{SPECIFIC_CODE}},
GENERIC_422_{{SPECIFIC_CODE}}

rartych
rartych reviewed Oct 14, 2025
View reviewed changes
@tlohmar
Copy link
Copy Markdown
Contributor

tlohmar commented Oct 14, 2025

Yes, LGTM

@PedroDiez
Copy link
Copy Markdown
Contributor Author

PedroDiez commented Oct 15, 2025

Have proposed in commit b9f4c2e

            code: "{{SPECIFIC_CODE}}"
            message: "{{SPECIFIC_CODE_MESSAGE}}"

Also fine if you think is better to set message: Message for specific code (@rartych, @patrice-conil, @tlohmar).
Will adapt in such a case, based on your view

@PedroDiez
Copy link
Copy Markdown
Contributor Author

PedroDiez commented Oct 27, 2025

Ready for review

@tlohmar tlohmar mentioned this pull request Oct 30, 2025
Merged
rartych
rartych previously approved these changes Nov 24, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@rartych rartych left a comment

Choose a reason for hiding this comment

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

LGTM

@rartych rartych mentioned this pull request Nov 24, 2025
Open
jlurien
jlurien previously approved these changes Nov 24, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@jlurien jlurien 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 PedroDiez dismissed stale reviews from jlurien and rartych via c507c58 November 24, 2025 17:15
@PedroDiez PedroDiez requested review from jlurien and rartych November 24, 2025 17:16
patrice-conil
patrice-conil approved these changes Nov 25, 2025
View reviewed changes
Copy link
Copy Markdown
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

@rartych rartych merged commit 2029927 into camaraproject:main Dec 3, 2025
1 check passed
@clundie-CL clundie-CL mentioned this pull request Jan 26, 2026
Open
This was referenced Mar 4, 2026
Closed
Closed
Closed
Open
@hdamker hdamker mentioned this pull request Mar 10, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jlurien jlurien jlurien approved these changes

@patrice-conil patrice-conil patrice-conil approved these changes

@rartych rartych rartych approved these changes

@shilpa-padgaonkar shilpa-padgaonkar Awaiting requested review from shilpa-padgaonkar

+1 more reviewer

@tlohmar tlohmar tlohmar approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@PedroDiez PedroDiez

Labels

documentation Improvements or additions to documentation Spring26 Scope of Spring26 (H1-2026) meta-release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Meaning of {{API_NAME}}.{{SPECIFIC_CODE}}

5 participants

@PedroDiez @rartych @tlohmar @jlurien @patrice-conil