API keys: Add deprecation to api keys #65948
Merged
Conversation
This file contains 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
eleijonmarck
commented
Apr 4, 2023
| @@ -17,7 +17,7 @@ An API key is a randomly generated string that external systems use to interact | |||
|
|
|||
| When you create an API key, you specify a **Role** that determines the permissions associated with the API key. Role permissions control that actions the API key can perform on Grafana resources. | |||
|
|
|||
| > **Note:** If you use Grafana v8.5 or newer, use service accounts instead of API keys. For more information, refer to [Grafana service accounts]({{< relref "../service-accounts/" >}}). | |||
| > **Note:** If you use Grafana v9.1 or newer, use service accounts instead of API keys. For more information, refer to [Grafana service accounts]({{< relref "../service-accounts/" >}}). | |||
There was a problem hiding this comment.
not part of deprecation, fix for wrong version in docs
eleijonmarck
changed the title
eleijonmarck
requested review from
a team,
Eve832 and
GrafanaWriter
as code owners
eleijonmarck
requested review from
papagian,
zserge,
mildwonkey and
sakjur
and removed request for
a team
IevaVasiljeva
approved these changes
Apr 11, 2023
pkg/api/apikey.go
Outdated
| @@ -20,6 +20,11 @@ import ( | |||
| // | |||
| // Will return auth keys. | |||
| // | |||
| // Deprecated: true. | |||
| // | |||
| // Deprecated please use GET /api/serviceaccounts and GET /api/serviceaccounts/{id}/tokens instead | |||
There was a problem hiding this comment.
super nit: I'd add a punctuation mark after deprecated. Something like Deprecated: please use... or Deprecated. Please use....
There was a problem hiding this comment.
i do not think it's nit. this is about clear communication on this. and should be reviewed as such
alexmobo
pushed a commit
that referenced
this pull request
Apr 14, 2023
* add: deprecation to api keys write path * boolean w. meessage * add read and delete endpoints * better description of deprecation * updated with puncutations
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.
What is this feature?
Adds deprecation notice for the create path of API keys w. a link to the new documentation outlining how to migrate your API calls to service accounts.
linking to page -https://grafana.com/docs/grafana/next/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-the-api
notes
Part of a bigger sunsetting of API keys - #53567