Skip to content

Conversation

@Marenz
Copy link
Contributor

@Marenz Marenz commented Feb 10, 2026

Reverses the previous rename so that key is the canonical parameter name in Dispatcher.__init__().

  • auth_key remains supported but emits a deprecation warning
  • Docstring examples updated to use key and DISPATCH_API_KEY
  • Backwards compatible

Reverse the previous rename: `key` is now the canonical parameter
name in Dispatcher.__init__(). `auth_key` remains supported but
emits a deprecation warning. Docstring examples updated to use
`key` and `DISPATCH_API_KEY`.

Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
@Marenz Marenz requested a review from a team as a code owner February 10, 2026 09:50
@Marenz Marenz requested review from stefan-brus-frequenz and removed request for a team February 10, 2026 09:50
@github-actions github-actions bot added the part:dispatcher Affects the high-level dispatcher interface label Feb 10, 2026
@llucax
Copy link
Contributor

llucax commented Feb 10, 2026

I would hold on this, but it looks like we are moving towards removing the auth_ and secret_ prefixes, so I would be fine to merge this if you are extra eager. But we need to build consensus and change all other libraries, otherwise it just creates confusion.

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

Labels

part:dispatcher Affects the high-level dispatcher interface

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants