Repository navigation
Upgrade API definitions to Commonalities r4.4 (#188) - #194
Merged
tlohmar merged 1 commit intoOct 7, 2026
Merged
Conversation
Align the four API definitions with Commonalities r4.4 (0.9.0), whose common files were synced in camaraproject#191. - Bump info.x-camara-commonalities to 0.9 and apply the reworded "Additional CAMARA error responses" info.description template. - Replace the deprecated Generic* error responses per operation with the r4.4 catalogue: BadRequest400, BadRequestWithRange400, NotFound404, Unauthenticated401 and PermissionDenied403, and SinkGone410 on the callbacks. This also drops INVALID_TOKEN_CONTEXT, which r4.4 removed from 403. - List operations use BadRequest400, as invalid page/perPage values return 400 INVALID_ARGUMENT (Design Guide 4.1). - Keep local responses only where the catalogue does not fit: a 400 on POST /networks and POST /accesses that adds the sink-related codes INVALID_CREDENTIAL, INVALID_TOKEN and INVALID_SINK, the DEDICATED_NETWORK.* 404 codes on POST /networks, a 404 DEDICATED_NETWORK_ACCESSES.NETWORK_IDENTIFIER_NOT_FOUND on POST /accesses, and narrowed 409s on POST /accesses (INCOMPATIBLE_STATE) and the add/remove devices operations (ABORTED, INCOMPATIBLE_STATE). - Example labels: use the API prefix for locally defined examples, keep GENERIC_ for references to common examples, and define the shared 409 INCOMPATIBLE_STATE example once. - Replace the two inline sink definitions with the common Sink schema. - Test definitions: add createAccess_404.01_networkid_not_found, and make the pagination scenarios of listNetworks, readNetworkProfiles and retrieveNetworkServiceAreas expect INVALID_ARGUMENT, renaming their tags from *_out_of_range_pagination to *_invalid_pagination.
jimfengjinhua
requested review from
PeterKovacs2,
carlosromerog,
eric-murray and
tlohmar
as code owners
October 2, 2026 12:25
tlohmar
reviewed
Oct 5, 2026
| value: | ||
| status: 409 | ||
| code: INCOMPATIBLE_STATE | ||
| message: A referenced resource is in an incompatible state. |
Contributor
There was a problem hiding this comment.
Hmm, this message text is more generic than the generic error examples in Commonalities. I create an Issue in Commonalities, that the message in the example should not list state names explicitly.
tlohmar
approved these changes
Oct 5, 2026
tlohmar
left a comment
tlohmar
left a comment
Contributor
There was a problem hiding this comment.
Looks good as base for followup work
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
2 participants
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.
Align the four API definitions with Commonalities r4.4 (0.9.0), whose common files were synced in #191.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #188
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.