Skip to content

Fix response contracts in Discovery OpenAPI files#616

Open
aaronzi wants to merge 1 commit into
IDTA-01001-3-1-3_workingfrom
aaronzi/issue-595-and-596
Open

Fix response contracts in Discovery OpenAPI files#616
aaronzi wants to merge 1 commit into
IDTA-01001-3-1-3_workingfrom
aaronzi/issue-595-and-596

Conversation

@aaronzi
Copy link
Copy Markdown
Member

@aaronzi aaronzi commented May 21, 2026

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:

  • Updated V3.1_SSP-001.yaml for PostAllAssetLinksById:
    • Removed 404 Not Found from POST /lookup/shells/{aasIdentifier}
    • Removed 409 Conflict from POST /lookup/shells/{aasIdentifier}
  • Mirrored the same response-contract changes in V3.1.yaml to keep the aggregated OpenAPI specification consistent.

Documentation Updates:

  • Updated changelog.adoc under Changes w.r.t. V3.1.2 to V3.1.3 (Minor Changes):
    • Added entry for issue 595 (remove 404 for POST /lookup/shells/{aasIdentifier})
    • Added entry for issue 596 (remove 409 for POST /lookup/shells/{aasIdentifier})

Related Issues

See #595 and #596

IMPORTANT!

Merge #615 first

Comment thread documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc Dismissed
Comment thread documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc Dismissed
@aaronzi aaronzi added this to the 3.1.3 milestone May 21, 2026
@aaronzi aaronzi changed the base branch from main to IDTA-01001-3-1-3_working May 21, 2026 07:30
Remove status codes 404 and 409 for POST /lookup/shells/{aasIdentifier} to align with create-or-replace and replace/update semantics.
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.

2 participants