Skip to content

Fix CAMARA validation warnings from Actions run 30633755325 - #66

Merged
JoseMConde merged 1 commit into
camaraproject:mainfrom
DLondonoD:fix/camara-validation-warnings
Jul 31, 2026
Merged

Fix CAMARA validation warnings from Actions run 30633755325#66
JoseMConde merged 1 commit into
camaraproject:mainfrom
DLondonoD:fix/camara-validation-warnings

Conversation

@DLondonoD

Copy link
Copy Markdown
Contributor

What type of PR is this?

correction

What this PR does / why we need it:

Fixes the CAMARA Validation warnings reported in Actions run #30633755325 (https://github.
com/camaraproject/EdgeApplicationManagement/actions/runs/30633755325):

  • [P-016] Adds writeOnly: true to AccessTokenCredential.accessTokenType. Every other CAMARA API sharing this
    same Commonalities-derived schema (SimSwap, DeviceLocation, QualityOnDemand) already marks this field writeOnly; this
    repo's copy was missing it, exposing a secret-classified field in responses.
  • [S-040] Documents the x-correlator response header on the 7 response objects that didn't declare it: the 5
    custom 409 Conflict error responses (submitApp, deleteApp, createAppInstance, createAppDeployment,
    updateAppDeployment) and the 2 top-level 204 responses (deleteApp, deleteAppInstance).

The remaining 15 [S-313] hints (free-form/implementation-dependent strings without a format/pattern/enum) were
reviewed and intentionally left unchanged, following the same precedent already established in #46. Rationale documented
in #65.

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

No behavioral/runtime change — this only corrects the API definition to match the validator's mandatory rules
(writeOnly on secret fields, x-correlator header documentation on all responses). See # for the
rationale on the S-313 hints left unresolved.

Changelog input

release-note Add writeOnly to AccessTokenCredential.accessTokenType and document the x-correlator response header on
409/204 responses, per CAMARA validation warnings.

Additional documentation

This section can be blank.

docs

- [P-016] Add writeOnly: true to AccessTokenCredential.accessTokenType.
  Every other CAMARA API defining this same Commonalities-derived
  schema (SimSwap, DeviceLocation, QualityOnDemand) already marks it
  writeOnly; this repo's copy was missing it.

- [S-040] Document the x-correlator response header on the 7 response
  objects that didn't declare it: the 5 custom '409 Conflict' error
  responses (submitApp, deleteApp, createAppInstance,
  createAppDeployment, updateAppDeployment) and the 2 top-level '204'
  responses (deleteApp, deleteAppInstance). The callback '204'
  responses already documented it and were left untouched.

- [S-313] No change. Verified all 15 hints against the current spec:
  they fall into the same categories already justified in camaraproject#46 for the
  r1.2 release review (name-like fields, version-like fields, and
  other intentionally free-form/opaque strings such as bearer tokens,
  usernames, and filesystem paths). Adding a regex pattern to any of
  them would impose an artificial restriction not required by the API
  and reduce interoperability. Leaving undocumented here per the same
  rationale; no new issue needed since it's the same precedent.

@JoseMConde JoseMConde left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JoseMConde
JoseMConde merged commit eba92a2 into camaraproject:main Jul 31, 2026
2 checks passed
This was referenced Jul 31, 2026
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