Add example of JSON pointers using array indexes. #1501
Merged
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.
A very small change to the docs but I found the current explanation a bit obscure.
https://www.openpolicyagent.org/docs/latest/decision-logs/#masking-sensitive-data
For people who are familiar with JSON Pointers, I thinks it's obvious to use array indices, but for others, maybe it's better to show examples.
In addition, was thinking about adding a detailed example like below but left it as a simple phrase.
Things I've tested
mask["/input/secrets/0"]
Result (Example of pointers to array not taking effect)
mask["/input/secrets/0/value"]
Result(Example of pointer to object inside an array which is allowed)
I would appreciate any feedback :)
Thank you!