Skip to content

docs(appium): Describe how to log sensitive data#21232

Merged
mykola-mokhnach merged 4 commits intoappium:masterfrom
mykola-mokhnach:sensitive_doc
May 1, 2025
Merged

docs(appium): Describe how to log sensitive data#21232
mykola-mokhnach merged 4 commits intoappium:masterfrom
mykola-mokhnach:sensitive_doc

Conversation

@mykola-mokhnach
Copy link
Collaborator

No description provided.

@github-actions github-actions bot added appium core Documentation related to writing, reading, or generating documentation labels Apr 28, 2025
@eglitise
Copy link
Collaborator

I would also suggest adding a brief bullet point about this document in developing/index.md

[util.format](https://nodejs.org/api/util.html#utilformatformat-args) API.

- While sending the appropriate server request, where this log line is used and should be masked,
add the custom header `X-Appium-Is-Sensitive` with its value set to `1` or `true`.
Copy link
Member

Choose a reason for hiding this comment

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

Headers are case-insnsitive, so I believe not necessary to address but here could address the header key is case-insensitive

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

added

@mykola-mokhnach mykola-mokhnach merged commit 63963e9 into appium:master May 1, 2025
5 checks passed
@mykola-mokhnach mykola-mokhnach deleted the sensitive_doc branch May 1, 2025 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

appium core Documentation related to writing, reading, or generating documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants