Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: Clarify that masking in Connection extra JSON is keyword-dependent#58587

Merged
potiuk merged 1 commit intoapache:mainfrom
kalluripradeep:patch-1
Nov 26, 2025
Merged

docs: Clarify that masking in Connection extra JSON is keyword-dependent#58587
potiuk merged 1 commit intoapache:mainfrom
kalluripradeep:patch-1

Conversation

Copy link
Contributor

kalluripradeep commented Nov 22, 2025

What changes

Updated the documentation to clarify that Airflow only masks keys in a Connection's extra JSON field if their names contain specific sensitive keywords, not all keys.

Why

The current documentation states "keys from a Connection's extra (JSON) field" which is misleading as it implies all keys are masked. In reality, only keys whose names contain sensitive keywords (like password, token, api_key, etc.) are masked.

Fixes

Closes #58514

Testing

Documentation change only - no code changes required.

Updated documentation to clarify that only keys containing sensitive keywords are masked in Connection's extra JSON field, not all keys.

Fixes apache#58514
Copy link

boring-cyborg bot commented Nov 22, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better .
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

potiuk approved these changes Nov 26, 2025
potiuk added this to the Airflow 3.1.4 milestone Nov 26, 2025
potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Nov 26, 2025
potiuk merged commit 19e0a9a into apache:main Nov 26, 2025
66 checks passed
Copy link

boring-cyborg bot commented Nov 26, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

ephraimbuddy added the type:doc-only Changelog: Doc Only label Dec 1, 2025
ephraimbuddy pushed a commit that referenced this pull request Dec 2, 2025
...58587)

Updated documentation to clarify that only keys containing sensitive keywords are masked in Connection's extra JSON field, not all keys.

Fixes #58514

(cherry picked from commit 19e0a9a)
ephraimbuddy pushed a commit that referenced this pull request Dec 3, 2025
...58587)

Updated documentation to clarify that only keys containing sensitive keywords are masked in Connection's extra JSON field, not all keys.

Fixes #58514

(cherry picked from commit 19e0a9a)
Copilot AI pushed a commit to jason810496/airflow that referenced this pull request Dec 5, 2025
...pache#58587)

Updated documentation to clarify that only keys containing sensitive keywords are masked in Connection's extra JSON field, not all keys.

Fixes apache#58514
itayweb pushed a commit to itayweb/airflow that referenced this pull request Dec 6, 2025
...pache#58587)

Updated documentation to clarify that only keys containing sensitive keywords are masked in Connection's extra JSON field, not all keys.

Fixes apache#58514
Subham-KRLX pushed a commit to Subham-KRLX/airflow that referenced this pull request Mar 4, 2026
...pache#58587)

Updated documentation to clarify that only keys containing sensitive keywords are masked in Connection's extra JSON field, not all keys.

Fixes apache#58514
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

potiuk potiuk approved these changes

Assignees

No one assigned

Labels

area:secrets backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation type:doc-only Changelog: Doc Only

Projects

None yet

Milestone

Airflow 3.1.4

Development

Successfully merging this pull request may close these issues.

Docs: Clarify that masking in Connection 'extra' JSON is keyword-dependent

3 participants