Repository navigation
docs(api): Document project performance general settings endpoint - #127398
Merged
DominikB2014 merged 1 commit intoOct 14, 2026
Merged
DominikB2014 merged 1 commit into
DominikB2014 merged 1 commit into
Conversation
wmak
approved these changes
Oct 14, 2026
wmak
left a comment
Member
There was a problem hiding this comment.
questions about one part, but lgtm
| @cell_silo_endpoint | ||
| class ProjectPerformanceGeneralSettingsEndpoint(ProjectEndpoint): | ||
| """ | ||
| Kept private: these settings only control what the Sentry UI displays (e.g. image |
Member
There was a problem hiding this comment.
What does Kept private: mean in this context?
Contributor
Author
There was a problem hiding this comment.
The api publish status is set to private, meaning it never reaches public docs.
Our goal is to eventually make most APIs public. This Api is 100% ui specific, it's an exception so I added a note explaining that
Member
There was a problem hiding this comment.
Ah should we say something like "This docstring is kept private"?
Contributor
Author
There was a problem hiding this comment.
Yeah that's probably more clear, I'll make a follow up
DominikB2014
deleted the
dominikbuszowiecki/eng-8777-document-performance-general-settings
branch
October 14, 2026 18:58
adrianviquez
pushed a commit
that referenced
this pull request
Oct 14, 2026
This was referenced Oct 15, 2026
DominikB2014
added a commit
that referenced
this pull request
Oct 23, 2026
#127420) Follow-up to #127398, addressing [this review comment](#127398 (comment)). The class docstring opened with "Kept private:", which wasn't clear on its own. It now says outright that the endpoint is kept private (excluded from the public API docs) and why. This only changes the docstring. <!-- junior-request-attribution:start --> via @DominikB2014. <!-- junior-request-attribution:end --> <!-- junior-session-footer:start --> <!-- junior-conversation-id:slack%3AD0BAH48EJL8%3A1792004793.050039 --> -- [View Junior Session](https://junior-prod.sentry.dev/conversations/slack%3AD0BAH48EJL8%3A1792004793.050039) [[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AD0BAH48EJL8%3A1792004793.050039/?project=4510944073809921) <!-- junior-session-footer:end --> Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: Dominik Buszowiecki <44422760+DominikB2014@users.noreply.github.com>
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
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.
Adds OpenAPI docs to the project performance general settings endpoint.
@extend_schemaon GET/POST with a typed response and a documentedenable_imagesfieldFixes ENG-8777