Simplify supplementary error documentation - #126
Open
YadingFang wants to merge 1 commit into
Open
YadingFang wants to merge 1 commit into
YadingFang wants to merge 1 commit into
Conversation
CAMARA Validation — PASS0 errors, 0 warnings, 0 hints | Profile: standard |
YadingFang
marked this pull request as ready for review
September 15, 2026 03:35
YadingFang
requested review from
Wojiaozhenghao and
XunliYang
as code owners
September 15, 2026 03:35
Contributor
Author
|
@tanjadegroot I addressed #124 by removing the duplicated 422 error-code catalogue from the supplementary API documentation and keeping the OpenAPI definition as the authoritative source for operation-specific status and error codes. This follows the second option suggested in the issue and should help avoid similar documentation drift in future releases. Could you please take a look? |
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.
What type of PR is this?
documentation
What this PR does / why we need it:
Addresses the documentation consistency finding recorded in #124 after the r2.2 release review.
The supplementary API documentation currently maintains its own list of
422business error codes in addition to the OpenAPI definition. This duplicated error catalogue can become out of sync when the API definition evolves, as happened whenEVENT_NOTIFICATIONS_NOT_SUPPORTEDwas added for Commonalities r4.4 alignment.This PR simplifies the supplementary documentation so that the OpenAPI definition remains the authoritative source for operation-specific HTTP status codes and CAMARA error codes.
The changes:
422business error-code catalogue fromdocumentation/API_documentation/click-to-dial_API.mdErrorInfostructure and a generic error-response exampleNo API definition or test behavior is changed by this PR.
Which issue(s) this PR fixes:
Fixes #124
Special notes for reviewers:
This is intentionally a documentation-only change.
The goal is not only to add the missing
EVENT_NOTIFICATIONS_NOT_SUPPORTEDentry, but to avoid future inconsistencies by removing the duplicated error-code catalogue from the supplementary documentation.The OpenAPI definition remains the normative source for the errors applicable to each operation.