Make key the canonical parameter, deprecate auth_key#263
Open
Marenz wants to merge 1 commit intofrequenz-floss:v1.x.xfrom
Open
Make key the canonical parameter, deprecate auth_key#263Marenz wants to merge 1 commit intofrequenz-floss:v1.x.xfrom
key the canonical parameter, deprecate auth_key#263Marenz wants to merge 1 commit intofrequenz-floss:v1.x.xfrom
Conversation
Reverse the previous rename: `key` and `DISPATCH_API_KEY` are now the canonical names. `auth_key` and `DISPATCH_API_AUTH_KEY` remain supported but emit deprecation warnings. The CLI option --api-key/DISPATCH_API_KEY is now primary, while --auth-key/DISPATCH_API_AUTH_KEY is deprecated. Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
llucax
reviewed
Feb 10, 2026
Contributor
llucax
left a comment
There was a problem hiding this comment.
I would hold on this one too:
- We need to make sure we agree on whatever name you want to propose, to avoid having to change everything again (including CLI args, constructor parameters and env variables, I would align them ideally, so either
--api-key/api_key=/_API_KEYor--key/key=/_KEY`, but not a mix of both). - I would do the change top-down (i.e. change
client-basefirst), so it gets more visibility and all projects get updated, otherwise it only adds more confusion if some projects use one and others the other - Unrelated, but I would consider removing the env var support, at least for the client library (we can keep it as a CLI-only feature, it makes more sense there). Even when "automatic auth" can be convenient, I guess making auth explicit in code is not a crazy requirement.
Contributor
Author
It is a CLI only feature, the client/library itself knows nothing about env vars :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reverses the previous rename so that
key/DISPATCH_API_KEYare the canonical names again.DispatchApiClient.__init__():keyis the primary parameter,auth_keyemits a deprecation warning--api-key/DISPATCH_API_KEYis primary,--auth-key/DISPATCH_API_AUTH_KEYis deprecated