Commit ca46495
feat(api): Document issue/release/team params; mark legacy endpoints deprecated (#117874)
Surfaces real-but-undocumented params on three public endpoints so the
generated OpenAPI schema matches what the handlers already accept, and
marks two long-prose-deprecated endpoints with a machine-readable flag.
Follow-up to #117843 — that PR added params via `@extend_schema`, but
for these endpoints drf-spectacular can't surface them: the
issue/release list schemas come from the hand-authored deprecated API
docs, and the team `name` field was explicitly excluded.
**Params documented**
- **List a Project's Issues** — `sort` and `limit` (deprecated-docs
JSON). `sort` omits the feature-flagged `recommended` value per review.
- **List an Organization's Releases** — `project` and `per_page`
(deprecated-docs JSON).
- **Update a Team** — `name`. Already accepted via the serializer's
`Meta.fields` but hidden by `exclude_fields`; now an explicit optional
field. Runtime validation is unchanged — both callers
(`TeamDetailsEndpoint.put`, SCIM `_rename_team_operation`) use partial
updates.
**Deprecation marked** (`deprecated: true`)
- **List a Project's Issues** — superseded by the org-scoped issues
endpoint.
- **Submit User Feedback** — superseded by the User Feedback Widget.
This is a soft-deprecation annotation only: no removal is planned and
runtime behavior is unchanged. It makes the existing prose deprecation
machine-readable so doc renderers and downstream consumers (e.g. Seer's
code-mode typed API library, which derives its surface from this spec)
can act on it.
All changes are additive — no params removed, no types narrowed, no new
required fields. `sentry django spectacular --validate --fail-on-warn`
passes clean.
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>1 parent 9fa05b2 commit ca46495
4 files changed
Lines changed: 46 additions & 2 deletions
File tree
- api-docs/paths
- events
- projects
- releases
- src/sentry/core/endpoints
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
| |||
54 | 55 | | |
55 | 56 | | |
56 | 57 | | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
57 | 77 | | |
58 | 78 | | |
59 | 79 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
| 76 | + | |
76 | 77 | | |
77 | 78 | | |
78 | 79 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
24 | 43 | | |
25 | 44 | | |
26 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
38 | 37 | | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
39 | 43 | | |
40 | 44 | | |
41 | 45 | | |
| |||
0 commit comments