docs(edge3): clarify WorkerQueuesBase.team_name is an experimental hint, cross-ref workload.rst#66718
Conversation
|
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
|
jscheffl
left a comment
There was a problem hiding this comment.
I asusme some static checkf ails as generated FastAPI spec is not updated. Please fix.
No real harm to change api docs but usually they are not read by humands and are just for code generators. So not surewhat this would improve... but as also no harm OK for merge in my view.
|
If you want to be really consistent, please add the same note also to CLI |
|
@omkhar ping - some static checks fail, please use |
|
@omkhar A few things need addressing before review — see our Pull Request quality criteria. Issues found:
What to do next:
No rush — take your time. We appreciate your contribution and are happy to wait for updates. If you have questions, feel free to ask on the Airflow Slack. Note: This comment was drafted by an AI-assisted triage tool and may contain mistakes. Once you have addressed the points above, an Apache Airflow maintainer — a real person — will take the next look at your PR. We use this two-stage triage process so that our maintainers' limited time is spent where it matters most: the conversation with you. |
The current WorkerQueuesBase.team_name description implies the field provides team isolation when set. workload.rst documents the actual contract: ``[core] multi_team`` is experimental, and the Execution API does not enforce team boundaries today. This commit aligns the field description with that documented stance so operators reading only the API datamodel see the same caveats workload.rst already states. No behavior change. No new APIs. Docs only. Signed-off-by: Omkhar Arasaratnam <omkhar@gmail.com>
ca1921b to
3eaed3f
Compare
…d docs Mirrors PR-A's WorkerQueuesBase.team_name docstring on the three other surfaces where the team_name flag is user-visible: the airflow edge worker CLI --help, providers/edge3/docs/deployment.rst, and the multi-team section of providers/edge3/docs/edge_executor.rst.
|
Apologies for the delay — back at it. Just pushed two commits:
The workflow runs are in `action_required` state (first-time contributor gate) — would appreciate a maintainer approval click when convenient. Thanks for the patience. |
|
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
The current
WorkerQueuesBase.team_namefield description implies the field provides team isolation when set.workload.rstdocuments the actual contract:[core] multi_teamis experimental, and the Execution API does not enforce team boundaries today. This PR aligns the field description with that documented stance so operators reading only the API datamodel see the same caveatsworkload.rstalready states.No behavior change. No new APIs. Docs / docstring only.
Before:
After:
Cross-reference:
airflow-core/docs/security/workload.rstsection "No team-level isolation in Execution API (experimental multi-team feature)".