feat(api): Type Feedback issue metadata#120246
Draft
betegon wants to merge 1 commit into
Draft
Conversation
Expose modern User Feedback fields through the shared issue response schema so generated clients can reuse them while retaining generic metadata for other issue types.
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.
The public issue list and detail schemas currently expose metadata as a generic object, forcing generated clients such as @sentry/api to redefine the stable fields returned for modern User Feedback.
Add a typed Feedback metadata branch while keeping the generic object fallback needed by heterogeneous issue endpoints. The fallback stays first so generated Zod parsers preserve unknown and future metadata keys. There is no runtime API behavior change.
This will let getsentry/cli#1266 derive its Feedback metadata from a future @sentry/api release instead of maintaining the field list locally.
Test plan
.venv/bin/pytest -q tests/sentry/apidocs/test_extensions.pyPATH="$PWD/.venv/bin:$PATH" make build-api-docs