Mark credential fields as writeOnly in EAM schema - #55
Merged
Conversation
DLondonoD
requested review from
FabrizioMoggio,
JoseMConde,
Kevsy,
gainsley,
maheshc01 and
seralogar
as code owners
July 21, 2026 12:54
seralogar
approved these changes
Jul 28, 2026
This was referenced Jul 31, 2026
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?
correction
What this PR does / why we need it:
Marks two credential-carrying fields as
writeOnly: trueso the OpenAPIspec explicitly documents they must never be returned in a response body:
AppManifest.appRepo.credentials— password/personal access token usedto access the app image repository. Without
writeOnly, nothing in thespec prevented this value from leaking in
getApps/getAppresponses.AccessTokenCredential.accessToken— notification access token.writeOnlyhad been dropped and
maxLengthwidened to8192with no stated reason.This restores
writeOnly: trueand revertsmaxLengthto4096to matchthe 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 expectationthat credential material is write-only, and with the canonical Commonalities
AccessTokenCredentialschema.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.