Skip to content

Correct CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines#359

Merged
rartych merged 3 commits intocamaraproject:mainfrom
eric-murray:eric-murray-patch-2
Jan 8, 2025
Merged

Correct CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines#359
rartych merged 3 commits intocamaraproject:mainfrom
eric-murray:eric-murray-patch-2

Conversation

@eric-murray
Copy link
Collaborator

@eric-murray eric-murray commented Dec 16, 2024

What type of PR is this?

  • correction

What this PR does / why we need it:

Generic503 definition in CAMARA_common.yaml uses code value SERVICE_UNAVAILABLE when defined code in API design guidelines is UNAVAILABLE

Which issue(s) this PR fixes:

Fixes # N/A

Does this PR introduce a breaking change?

  • Yes
  • No

Only a typo fix

Special notes for reviewers:

None

Changelog input

 release-note
 - Correct CAMARA_common.yaml Generic503 error code to UNAVAILABLE

Additional documentation

None

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.

There is a misaligment. Good catch Eric!

Indeed, I have realised I made a mistake from my side in PR#316
code should be kept to "UNAVAILABLE" (set "UNAVAILABLE" in Line 765), and line 771 kept unchanged (so wrong value currently is in line 765)

https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#6-error-responses

`

503 | UNAVAILABLE | Service Unavailable. | Service is not available. Temporary situation usually related to maintenance process in the server side -- | -- | -- | -- `

@eric-murray eric-murray changed the title Update CAMARA_common.yaml Generic503 example to match defined error code Correct CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines Dec 17, 2024
@eric-murray
Copy link
Collaborator Author

@PedroDiez
OK. I updated my PR to fix the defined error code for Generic503

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

Copy link
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

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

@rartych rartych merged commit e3e9311 into camaraproject:main Jan 8, 2025
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.

4 participants