Skip to content

Mark credential fields as writeOnly in EAM schema - #55

Merged
JoseMConde merged 1 commit into
camaraproject:mainfrom
DLondonoD:fix/issue-47
Jul 28, 2026
Merged

Mark credential fields as writeOnly in EAM schema#55
JoseMConde merged 1 commit into
camaraproject:mainfrom
DLondonoD:fix/issue-47

Conversation

@DLondonoD

Copy link
Copy Markdown
Contributor

What type of PR is this?

correction

What this PR does / why we need it:

Marks two credential-carrying fields as writeOnly: true so the OpenAPI
spec explicitly documents they must never be returned in a response body:

  • AppManifest.appRepo.credentials — password/personal access token used
    to access the app image repository. Without writeOnly, nothing in the
    spec prevented this value from leaking in getApps / getApp responses.
  • AccessTokenCredential.accessToken — notification access token. writeOnly
    had been dropped and maxLength widened to 8192 with no stated reason.
    This restores writeOnly: true and reverts maxLength to 4096 to match
    the canonical schema in Commonalities (CAMARA_event_common.yaml).

Which issue(s) this PR fixes:

Fixes #47

Special notes for reviewers:

No behavioral/runtime change — this only tightens the API contract
(writeOnly + maxLength) to align with the CAMARA Design Guide expectation
that credential material is write-only, and with the canonical Commonalities
AccessTokenCredential schema.

Changelog input

release-note Mark AppManifest.appRepo.credentials and AccessTokenCredential.accessToken as writeOnly; restore
accessToken maxLength to 4096 to match Commonalities.

Additional documentation

This section can be blank.

docs

@JoseMConde
JoseMConde merged commit 86ebbd3 into camaraproject:main Jul 28, 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.

Credentials/access tokens missing writeOnly

3 participants