Skip to content

docs(inbox): Document personal inbox API operations - #131914

Merged
cvxluo merged 1 commit into
masterfrom
cvxluo/document-personal-inbox-api-operations
Nov 20, 2026
Merged

cvxluo merged 1 commit into
masterfrom
cvxluo/document-personal-inbox-api-operations

Conversation

@cvxluo

@cvxluo cvxluo commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

Add some API examples + more docstrings to the inbox API

@github-actions github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label Nov 19, 2026
@cvxluo
cvxluo force-pushed the cvxluo/document-personal-inbox-api-operations branch from 01b5d16 to 5d6d982 Compare November 19, 2026 22:53
@cvxluo
cvxluo marked this pull request as ready for review November 19, 2026 23:45
@cvxluo
cvxluo requested review from a team as code owners November 19, 2026 23:45
@cvxluo
cvxluo requested a review from a team November 19, 2026 23:45

class InboxExamples:
LIST_ITEMS = [
OpenApiExample("List personal inbox items", value=[INBOX_ITEM], response_only=True)

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.

i wonder if the word "personal" is doing unnecessary lifting? since inbox is inherently/universally personal? not rlly important tho

Comment thread src/sentry/inbox/filters.py Outdated
required=False,
help_text="Match items containing any of these event types.",
help_text=(
"Filter by event type. Supported values: `issue.user_assigned`, "

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.

i wonder if we should reference an enum somewhere instead of listing out values here? my concern being that these may get out of date

Co-authored-by: Codex <codex@openai.com>
@cvxluo
cvxluo force-pushed the cvxluo/document-personal-inbox-api-operations branch from 5d6d982 to 9a09009 Compare November 20, 2026 21:48
@github-actions

Copy link
Copy Markdown
Contributor

decision-model-linter

api

src/sentry/inbox/filters.py

  • warn makesExistingInputStricter = TRUE (0.91): Rejecting input an endpoint accepted before, or changing a field's default, breaks existing callers, and the API spec often doesn't show it. Make the change backward compatible (keep the field optional, accept the old values, or keep the old default), or treat it as a breaking change and coordinate it.

decision-model-linter: 25 calls on 5 files, 62,930 input tokens, $0.0026, model typesafe/jev-1.13-20260917

@cvxluo
cvxluo merged commit be77bdc into master Nov 20, 2026
80 checks passed
@cvxluo
cvxluo deleted the cvxluo/document-personal-inbox-api-operations branch November 20, 2026 21:57
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