dev-v0.2.0 - Aligment with API Design Guidelines Commonality - Add "status" field in error definitions #13
Conversation
This file contains 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
bigludo7
approved these changes
Jan 10, 2023
jpengar
changed the title
This was referenced Jan 10, 2023
jpengar
added a commit
that referenced
this pull request
Mar 14, 2023
…s latest project status (#30) * jpengar/add-error-status-v0.2.0 (#13) * jpengar/add-403-error-token-context (#14) * jpengar/rfc4594-based-change-for-issue-23-v0.2.0 (#25) * dev-v0.2.0 - Update API documentation according to v0.2.0 API definition (#19) * jpengar/update-api-documentation-v0.2.0 * update api version in doc
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.
NOTE
This PR replace PR #7 being done against
mainbranch. This PR introduces same already approved changes from PR #7 but against a new branchdev-v0.2.0in order to properly handle API definition versions in github repository.Changes
PR to align API definition with the API Design Guidelines Commonality recently approved in CAMARA: https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-design-guidelines.md
Actually, the API proposal was already aligned with those guidelines except for one last change included before their approval in CAMARA Commonalities. That last change was to include a
statusfield in the API error definition which corresponds with the HTTP response status code: https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-design-guidelines.md#6-error-responsesSo this PR basically adds this new
statusfield as the only functional change. And also include some other non-functional optimisations to re-use schema definitions related to API errors when possible.