feat(api): Badge experimental endpoints on API reference pages - #19320
Draft
DominikB2014 wants to merge 1 commit into
Draft
feat(api): Badge experimental endpoints on API reference pages#19320DominikB2014 wants to merge 1 commit into
DominikB2014 wants to merge 1 commit into
Conversation
Sentry marks endpoints published under the PUBLIC_EXPERIMENTAL status with x-sentry-experimental on the operation, but nothing read it, so those endpoints rendered as though they were stable. Model the extension, carry it onto the API type next to the existing deprecated flag, and render a badge above the request block.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
the
Priority: Needs Triage
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.
Sentry publishes some endpoints under a new
PUBLIC_EXPERIMENTALstatus (getsentry/sentry#123914), which stampsx-sentry-experimental: trueon the operation inopenapi-derefed.json. Nothing here read it — the operation type only modelled tag-levelx-extensions — so those endpoints rendered as though they were stable. This models the extension, carries it onto theAPItype next to the existingdeprecatedflag, and renders a badge above the request block. Until this lands, Sentry prepends a text notice to the description as a fallback; that can be dropped once the badge ships.