Commit 9d342bf
ref(api): use token operationIds + summary for core + api endpoints (#117337)
## Summary
operationId→token migration, **batch 1 of 3** (core + api endpoints,
**83 ops / 50 files**). Moves the human sentence into `summary` and sets
`operation_id` to a short camelCase REST token so the generated
`@sentry/api` SDK gets clean names; docs titles/slugs stay
byte-identical (derived from `summary`).
Most are straight CRUD (`getOrganization`, `listProjectKeys`,
`updateProject`, …). Verb-corrected and ad-hoc overrides where the path
couldn't express intent:
- non-CRUD verbs: `addProjectTeam`, `addOrganizationMember`,
`linkProjectRepository`, `registerProjectServiceHook`,
`provisionOrganizationScimV2User`/`Group`
- singleton GETs → `get`: `getOrganizationProfilingFlamegraph`,
`getOrganizationSessions`, `getOrganizationStatsSummary`,
`getProjectEventSourceMapDebug`
- consistency/clarity: symbol-source detail ops singular
(`delete`/`updateProjectSymbolSource`),
`listOrganizationTraceItemAttributes`, `listProjectDebugFiles`
## Test plan
- prek green (ruff/flake8/mypy + `@extend_schema` response-type check).
- CI `api docs test` regenerates + validates the spec
(`--fail-on-warn`); operations show token operationIds with the sentence
preserved as `summary`.
## Related (operationId→token migration)
- Convention: #117285 · Merged: replays #117166, dashboards #117297,
discover #117302
- Docs SEO foundation: getsentry/sentry-docs#18322 (merged)
- Batches 2 & 3 to follow (issues/integrations/releases/workflow_engine;
preprod/monitors/sentry_apps/notifications/seer/feedback)
1 parent bc68652 commit 9d342bf
53 files changed
Lines changed: 257 additions & 83 deletions
File tree
- src/sentry
- apidocs
- api/endpoints
- release_thresholds
- core/endpoints
- scim
- tests/apidocs
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
286 | 286 | | |
287 | 287 | | |
288 | 288 | | |
289 | | - | |
| 289 | + | |
| 290 | + | |
290 | 291 | | |
291 | 292 | | |
292 | 293 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
93 | 93 | | |
94 | 94 | | |
95 | 95 | | |
96 | | - | |
| 96 | + | |
| 97 | + | |
97 | 98 | | |
98 | 99 | | |
99 | 100 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
| 43 | + | |
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
158 | | - | |
| 158 | + | |
| 159 | + | |
159 | 160 | | |
160 | 161 | | |
161 | 162 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
132 | | - | |
| 132 | + | |
| 133 | + | |
133 | 134 | | |
134 | 135 | | |
135 | 136 | | |
| |||
Lines changed: 4 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
116 | 116 | | |
117 | 117 | | |
118 | 118 | | |
119 | | - | |
| 119 | + | |
| 120 | + | |
120 | 121 | | |
121 | 122 | | |
122 | 123 | | |
| |||
213 | 214 | | |
214 | 215 | | |
215 | 216 | | |
216 | | - | |
| 217 | + | |
| 218 | + | |
217 | 219 | | |
218 | 220 | | |
219 | 221 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
| 44 | + | |
| 45 | + | |
45 | 46 | | |
46 | 47 | | |
47 | 48 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
| 33 | + | |
33 | 34 | | |
34 | 35 | | |
35 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
364 | 364 | | |
365 | 365 | | |
366 | 366 | | |
367 | | - | |
| 367 | + | |
| 368 | + | |
368 | 369 | | |
369 | 370 | | |
370 | 371 | | |
| |||
746 | 747 | | |
747 | 748 | | |
748 | 749 | | |
749 | | - | |
| 750 | + | |
| 751 | + | |
750 | 752 | | |
751 | 753 | | |
752 | 754 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
| 43 | + | |
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
| |||
0 commit comments