ref(apis): Add suggested_api to cell-related deprecated APIs#119065
Open
mjq wants to merge 1 commit into
Open
Conversation
github-actions
Bot
added
the
Scope: Backend
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
1 participant
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.
We have a bunch of APIs marked
@deprecateddue to incompatibility with cells (missing orgs in their path). This is meant to be a very small QoL improvement to readers and callers to point out the proper org-scoped endpoint to use instead.For readers: Personally I did this because I got confused by seeing the
@deprecatedannotation on an endpoint I knew was still in use, before realizing that the same endpoint code is mounted at two named URLs, and only one was deprecated. This hopefully helps future readers see that the endpoint as a whole isn't deprecated, just one of the URLs pointing to it.For callers: this will put the new path in
X-Sentry-Replacement-Endpoint. IDK if anyone's checking them, but I don't think it can hurt.If there's any risk here we can scrap the PR, it's a marginal improvement at best.
🤖 Used Claude to find candidate endpoints, find the replacement names, and confirm that every
suggested_apiactually exists in urls.py.