Skip to content

QUA-1518: Feat/field masking docs#1075

Merged
RafaelOsiro merged 6 commits intomainfrom
feat/field-masking-docs
Mar 20, 2026
Merged

QUA-1518: Feat/field masking docs#1075
RafaelOsiro merged 6 commits intomainfrom
feat/field-masking-docs

Conversation

@ets
Copy link
Contributor

@ets ets commented Mar 20, 2026

Document use of Field masking and impact

ets and others added 5 commits March 20, 2026 11:08
Auto Run document covering all pages that need to be created or
updated to reflect the new field masking feature: mask-a-field,
understanding-field-status, field-status-faq, source-record,
data-preview, export-operation, materialize-operation, and
field-status-api.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Documents where masking is applied (data preview, anomaly source
records, field profile histograms, anomaly assertion context, export
field profiles, and materialize snapshots) and how masked values
can be revealed (UI surfaces) vs. where they cannot (assertion
context, enrichment datastore outputs).

Updated pages:
- mask-a-field.md: full surface table, reveal section, unmask coverage
- understanding-field-status.md: expanded sensitive data protection
- field-status-faq.md: updated masking FAQ + 2 new entries
- source-record.md: masked fields section
- data-preview.md: masked fields section
- export-operation.md: field masking and export section
- materialize-operation.md: field masking and materialize section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Source record reveal toggling applies to all records attached to an
anomaly at once, not individually per-record. Updated all doc surfaces
where the inaccurate per-record language appeared.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… the UI qualifier

Replace all references to the literal `***MASKED***` placeholder with
plain language ("obfuscated") per documentation style guidance.
Also remove the "in the UI" qualifier from audit log callouts — reveal
behavior and logging apply platform-wide, not only to UI interactions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…rations

Export and Materialize operations do support revealed values via the
include_masked API parameter — they do not require unmasking the field
first. Updated all doc surfaces to accurately reflect that include_masked
is available on the API but not exposed in the UI.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@RafaelOsiro RafaelOsiro changed the title Feat/field masking docs QUA-1518: Feat/field masking docs Mar 20, 2026
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Mar 20, 2026
Copy link
Contributor

@RafaelOsiro RafaelOsiro left a comment

Choose a reason for hiding this comment

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

The content is ready.
The links have been tested.

I just found a strange file (possibly related to Maestro) that I don't think should be included in the project.

@RafaelOsiro RafaelOsiro merged commit d55cc45 into main Mar 20, 2026
1 check passed
@RafaelOsiro RafaelOsiro deleted the feat/field-masking-docs branch March 20, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants