Fix response contracts in Discovery OpenAPI files#616
Open
aaronzi wants to merge 1 commit into
Open
Conversation
Remove status codes 404 and 409 for POST /lookup/shells/{aasIdentifier} to align with create-or-replace and replace/update semantics.
63cbd71 to
bf09788
Compare
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.
This pull request updates the AAS Discovery response contract for POST
/lookup/shells/{aasIdentifier}to align with the operation’s effective create-or-replace behavior. Specifically, 404 Not Found and 409 Conflict were removed from the documented responses for this operation, so the contract now reflects successful create/update via 201, invalid requests via 400, and generic errors via default. The changelog for 3.1.3 was also extended to document both fixes.API Specification Fixes:
V3.1_SSP-001.yamlfor PostAllAssetLinksById:/lookup/shells/{aasIdentifier}/lookup/shells/{aasIdentifier}V3.1.yamlto keep the aggregated OpenAPI specification consistent.Documentation Updates:
changelog.adocunder Changes w.r.t. V3.1.2 to V3.1.3 (Minor Changes):Related Issues
See #595 and #596
IMPORTANT!
Merge #615 first