fix: align API with CAMARA Commonalities r4.3 validation requirements - #33
Open
maheshc01 wants to merge 4 commits into
Open
fix: align API with CAMARA Commonalities r4.3 validation requirements#33maheshc01 wants to merge 4 commits into
maheshc01 wants to merge 4 commits into
Conversation
- Add 3 mandatory CAMARA info.description template blocks (authorization-and-authentication, additional-error-responses, request-body-strictness) - Set x-camara-commonalities: wip - Remove info.contact (S-020) - Fix apiRoot default (https→http) and description (single-line standard text) - Replace inline openId, x-correlator header/parameter with CAMARA_common.yaml refs - Replace inline XCorrelator, ErrorInfo schemas with CAMARA_common.yaml refs - Replace all Generic400/401/403/404/429 inline responses with CAMARA_common.yaml refs - Add descriptions to Duration, Rate, Compute, TimeUnitEnum, RateUnitEnum, ComputeUnitEnum, ApplicationProfile, ApplicationProfileRequest, NetworkQualityThresholds and their properties (S-011) - Rename schemas to PascalCase: targetMinCPU→TargetMinCPU, targetMinGPU→TargetMinGPU, gpuVendorType→GpuVendorType, gpuModelName→GpuModelName, targetMinMemory→TargetMinMemory, targetMinEphemeralStorage→TargetMinEphemeralStorage, targetMinPersistentStorage→TargetMinPersistentStorage (S-015) - Fix TargetMinGPU: add type: integer, format: int32, minimum: 0, maximum: 64 (S-016, S-310, S-311) - Add Duration.value maximum: 500 (S-311) - Add maxLength: 36 to all applicationProfileId path parameter schemas and ApplicationProfile.applicationProfileId (S-312) - Add maxLength: 256 and pattern to GpuModelName (S-312, S-313) - Delete placeholder README.MD (P-013) - Delete API-Readiness-Checklist.md (P-032)
CAMARA Validation — PASS0 errors, 0 warnings, 0 hints | Profile: standard |
…or strict PascalCase (S-015)
Kevsy
reviewed
Jul 21, 2026
Kevsy
reviewed
Jul 21, 2026
Kevsy
requested changes
Jul 21, 2026
Kevsy
left a comment
Kevsy
left a comment
Contributor
There was a problem hiding this comment.
^ see comments around GPU-related objects
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Contributor
Author
|
Hi @Kevsy. thank you for the review and feedback. I have applied the suggested feedback. |
Contributor
Author
|
@Kevsy gentle reminder on this. |
Contributor
Author
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 41 CAMARA validation warnings identified in the r4.3 validation run (issue #32), to unblock the Sync26 meta-release snapshot.
Changes
Mandatory info.description templates (P-026)
authorization-and-authenticationblockadditional-error-responsesblockrequest-body-strictnessblockInfo fixes
info.contact(S-020 — CAMARA APIs must not have individual contact info)x-camara-commonalities: wipServer config
apiRootdefault fromhttps://tohttp://(S-022)apiRootdescription to single-line standard CAMARA text (S-023)Common schema references
securitySchemes/openId→CAMARA_common.yamlheaders/x-correlator→CAMARA_common.yamlparameters/x-correlator→CAMARA_common.yamlXCorrelatorandErrorInfoschemas deleted — referenced viaCAMARA_common.yamlGeneric400/401/403/404/429inline responses replaced withCAMARA_common.yamlrefsSchema name fixes — PascalCase (S-015)
targetMinCPU→TargetMinCPUtargetMinGPU→TargetMinGPUgpuVendorType→GpuVendorTypegpuModelName→GpuModelNametargetMinMemory→TargetMinMemorytargetMinEphemeralStorage→TargetMinEphemeralStoragetargetMinPersistentStorage→TargetMinPersistentStorage$refusages inComputeResourcesThresholdsupdated accordinglySchema fixes
TargetMinGPU: addedtype: integer,format: int32,minimum: 0,maximum: 64(S-016, S-310, S-311)Duration.value: addedmaximum: 500(S-311)GpuModelName: addedmaxLength: 256,pattern: ^[^\r\n]*$(S-312, S-313)applicationProfileIdin all path parameters andApplicationProfileschema: addedmaxLength: 36(S-312)Duration,Rate,Compute,TimeUnitEnum,RateUnitEnum,ComputeUnitEnum,ApplicationProfile,ApplicationProfileRequest,NetworkQualityThresholds, and theirvalue/unitpropertiesPlaceholder file removal
code/API_definitions/README.MD(P-013)documentation/API_documentation/application-profiles-API-Readiness-Checklist.md(P-032)Test plan
$refpaths resolve correctly againstCAMARA_common.yaml