Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifications on breaking changes due to the latest changes in error responses #363

Open
rartych opened this issue Dec 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@rartych
Copy link
Collaborator

rartych commented Dec 19, 2024

Problem description

In section 5.4 of API Design Guidelines the following case is listed as an example for breaking change:

Modifying or adding new responses to existing operations. For example: creating a resource can return a 412 response code.

Changes introduced in PRs: #324 #329 #351 are renaming error codes and suggest removing some error definitions from API specifications (50x).

Expected action
Global guidance for API versioning in meta-release Spring24 especially the stable ones (v1.0) and without other major changes - is needed.
Updating section 5.4 of API Design Guidelines can be considered based on decision above..

Additional context

Analysis of Commonalities 0.5.0-alpha.1 changes

@rartych rartych added the documentation Improvements or additions to documentation label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant