Skip to content

docs(api): Document project performance general settings endpoint - #127398

Merged
DominikB2014 merged 1 commit into
masterfrom
dominikbuszowiecki/eng-8777-document-performance-general-settings
Oct 14, 2026
Merged

DominikB2014 merged 1 commit into
masterfrom
dominikbuszowiecki/eng-8777-document-performance-general-settings

Conversation

@DominikB2014

Copy link
Copy Markdown
Contributor

Adds OpenAPI docs to the project performance general settings endpoint.

  • @extend_schema on GET/POST with a typed response and a documented enable_images field
  • Endpoint stays PRIVATE since the settings only affect what the Sentry UI displays

Fixes ENG-8777

@DominikB2014
DominikB2014 requested a review from a team as a code owner October 14, 2026 17:10
@github-actions github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label Oct 14, 2026

@wmak wmak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does Kept private: mean in this context?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah should we say something like "This docstring is kept private"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's probably more clear, I'll make a follow up

@DominikB2014
DominikB2014 merged commit 0f5889d into master Oct 14, 2026
72 checks passed
@DominikB2014
DominikB2014 deleted the dominikbuszowiecki/eng-8777-document-performance-general-settings branch October 14, 2026 18:58
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants