feat(ipa): Add sensitive fields guidance to IPA-111 and IPA-117#113
Closed
wtrocki wants to merge 1 commit into
Closed
feat(ipa): Add sensitive fields guidance to IPA-111 and IPA-117#113wtrocki wants to merge 1 commit into
wtrocki wants to merge 1 commit into
Conversation
Migrate PR #77 content into structured <Guideline> components per CONTRIBUTING.md. Addresses review feedback: atomic guidelines, enforcement prop, correct/incorrect examples, workflows. IPA-111: mark sensitive fields, write-only / reveal-once patterns, redacted sibling properties. IPA-117: use format:password on secrets, not on redacted siblings.
wtrocki
requested review from
andmatei,
andreaangiolillo,
drinkbird,
lovisaberggren,
maks-m-mongo-leaf,
matt-condon and
saisundar
|
There is an existing patch(es) for this commit SHA: Please note that the status that is posted is not in the context of this PR but rather the (latest) existing patch and that may affect some tests that may depend on the particular PR. If your tests do not rely on any PR-specific values (like base or head branch name) then your tests will report the same status. If you would like a patch to run in the context of this PR and abort the other(s), comment 'evergreen retry'. |
wtrocki
commented
Jun 19, 2026
|
|
||
| <Guideline id="IPA-111-must-mark-sensitive-fields" given="schema" enforcement="review" effort="reason" dependsOn={["IPA-117"]}> | ||
|
|
||
| Sensitive fields **must** be marked in OpenAPI so that consumers and tooling can |
Member
Author
There was a problem hiding this comment.
@AgustinBettati I was not sure about having 2 IPA here as they cover similar areas. Let me know if you think it is ok to merge them.
New format does support examples which makes IPA 117 an example of IPA 111.
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
1 participant
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.
Migrate PR #77 content into structured Addresses my review feedback: atomic guidelines, enforcement prop, correct/incorrect examples, workflows.