fix: align API with CAMARA Commonalities r4.3 validation requirements - #42
Merged
Merged
Conversation
- Add 3 mandatory CAMARA info.description template blocks (authorization-and-authentication, additional-error-responses, request-body-strictness, identifying-device-from-access-token) - Set x-camara-commonalities: wip - Fix apiRoot description to single-line standard CAMARA text (S-023) - Replace inline openId, x-correlator header/parameter with CAMARA_common.yaml refs - Replace inline Device, DeviceResponse, PhoneNumber, NetworkAccessIdentifier, DeviceIpv4Addr, SingleIpv4Addr, Port, SingleIpv6Addr schemas with CAMARA_common.yaml refs - Replace inline XCorrelator, ErrorInfo schemas with CAMARA_common.yaml refs - Replace all Generic400/401/403/404/422/429 inline responses with CAMARA_common.yaml refs - Update inline x-correlator path parameter to use components/parameters ref - Add maxLength: 36 to ApplicationEndpointsId, AppId, EdgeCloudZoneId, ApplicationProfileId (S-312) - Add maxLength: 64 to EdgeCloudRegion, EdgeCloudProvider, EdgeCloudZoneName (S-312) - Add format: ipv4, maxLength: 15 to Ipv4Address (S-310, S-312) - Add format: ipv6, maxLength: 45 to Ipv6Address (S-312) - Add maxLength: 253 and FQDN pattern to Fqdn (S-312, S-313) - Add maxLength: 2048 and pattern to applicationEndpointDescription (S-312, S-313) - Add maxLength: 256 and pattern to applicationServerProviderName (S-312, S-313) - Add maxItems: 50 to applicationEndpoints array (S-309) - Add maxItems: 1 to ipv4Addresses and ipv6Addresses arrays (S-309) - Delete API-Readiness-Checklist.md (P-032)
maheshc01
requested review from
FabrizioMoggio,
JoseMConde,
Kevsy,
gainsley,
gunjald and
seralogar
as code owners
July 20, 2026 19:55
CAMARA Validation — PASS0 errors, 0 warnings, 0 hints | Profile: standard |
Contributor
Author
|
thank you for the review.. will merge it and create the snapshot for the release. |
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
3 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.
Summary
Fixes all 29 CAMARA validation warnings identified in the r4.3 validation run (issue #41), to unblock the Sync26 meta-release snapshot.
Changes
Mandatory info.description templates (P-026)
authorization-and-authenticationblockadditional-error-responsesblockrequest-body-strictnessblockidentifying-device-from-access-tokenblockCommon schema references (replaces all inline definitions)
securitySchemes/openId→CAMARA_common.yamlheaders/x-correlator→CAMARA_common.yamlparameters/x-correlator→CAMARA_common.yaml(also updated inline path param to use component ref)Device,DeviceResponse,PhoneNumber,NetworkAccessIdentifier,DeviceIpv4Addr→DeviceIpv4Address,SingleIpv4Addr→SingleIpv4Address,Port(min:1),SingleIpv6Addr→DeviceIpv6Addressdeleted and replaced withCAMARA_common.yamlrefsXCorrelator,ErrorInfodeleted and replaced withCAMARA_common.yamlrefsGeneric400/401/403/404/422/429inline responses replaced withCAMARA_common.yamlrefsServer config
x-camara-commonalities: wipapiRootdescription to single-line standard CAMARA text (S-023)String constraints (S-312)
maxLength: 36added to ApplicationEndpointsId, AppId, EdgeCloudZoneId, ApplicationProfileIdmaxLength: 64added to EdgeCloudRegion, EdgeCloudProvider, EdgeCloudZoneNameformat: ipv4, maxLength: 15added to Ipv4Address (was missing format entirely)format: ipv6, maxLength: 45added to Ipv6Address (was missing format entirely)maxLength: 253and FQDN pattern added to FqdnmaxLength: 2048, pattern: ^[^\r\n]*$added to applicationEndpointDescriptionmaxLength: 256, pattern: ^[^\r\n]*$added to applicationServerProviderNameArray constraints (S-309)
maxItems: 50added toapplicationEndpointsmaxItems: 1added toipv4Addressesandipv6Addresses(one address per endpoint)Placeholder file removal
documentation/API_documentation/Application-Endpoint-Discovery-API-Readiness-Checklist.md(P-032)Test plan
$refpaths resolve correctly againstCAMARA_common.yaml