Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API: Add deprecation notice for updating folder UID #68543

Merged
merged 2 commits into from May 16, 2023

Conversation

papagian
Copy link
Contributor

@papagian papagian commented May 16, 2023

What is this feature?

Adds a deprecation notice for updating folder UIDs using the API: PUT /api/folders/:uid

Why do we need this feature?

UIDs as identifiers should be immutable. Related to #60983

Who is this feature for?

[Add information on what kind of user the feature is for.]

Which issue(s) does this PR fix?:

Fixes #

Special notes for your reviewer:

  • After merging this we need to update also What's new doc
  • the OpenAPI specs contain changes unrelated to this (they seem to be outdated)

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

Deprecation notice

Starting with 10.0, changing the folder UID is deprecated. It will be removed in a future release. Please avoid using it because it can result in folder losing its permissions.

@papagian papagian added no-changelog Skip including change in changelog/release notes backport v10.0.x labels May 16, 2023
@papagian papagian added this to the 10.0.x milestone May 16, 2023
@papagian papagian requested review from a team and Eve832 as code owners May 16, 2023 12:48
@papagian papagian requested review from sakjur, zserge and yangkb09 and removed request for a team May 16, 2023 12:48
@grafanabot
Copy link
Contributor

Hello @papagian!
Backport pull requests need to be either:

  • Pull requests which address bugs,
  • Urgent fixes which need product approval, in order to get merged,
  • Docs changes.

Please, if the current pull request addresses a bug fix, label it with the type/bug label.
If it already has the product approval, please add the product-approved label. For docs changes, please add the type/docs label.
If the pull request modifies CI behaviour, please add the type/ci label.
If none of the above applies, please consider removing the backport label and target the next major/minor release.
Thanks!

fix spelling
@papagian papagian merged commit 14fb4ff into main May 16, 2023
11 checks passed
@papagian papagian deleted the papagian/deprecate-changing-folder-uid branch May 16, 2023 15:28
grafanabot pushed a commit that referenced this pull request May 16, 2023
* API: Add deprecation notice for updating folder UID

(cherry picked from commit 14fb4ff)
ryantxu pushed a commit that referenced this pull request May 16, 2023
* API: Add deprecation notice for updating folder UID
@papagian papagian added add to changelog and removed no-changelog Skip including change in changelog/release notes labels May 17, 2023
papagian added a commit that referenced this pull request May 17, 2023
API: Add deprecation notice for updating folder UID (#68543)

* API: Add deprecation notice for updating folder UID

(cherry picked from commit 14fb4ff)

Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
@zerok zerok modified the milestones: 10.0.x, 10.0.0-preview May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants