Skip to content

Commit 51a8844

Browse files
committed
Document API key naming deprecations
Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
1 parent 868f17b commit 51a8844

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎RELEASE_NOTES.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Raise `ValueError` when `start_time` passed to `create()` is neither a `datetime
88

99
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1010

11+
- `DispatchApiClient` now uses `key` as the canonical authentication parameter;
12+
`auth_key` remains supported but is deprecated. Likewise, the CLI now prefers
13+
`--api-key` / `DISPATCH_API_KEY` over the deprecated `--auth-key` /
14+
`DISPATCH_API_AUTH_KEY` names.
15+
1116
## New Features
1217

1318
<!-- Here goes the main new features and examples or instructions on how to use them -->

0 commit comments

Comments
 (0)