ref(api): use token operationIds + summary for dashboard endpoints#117297
Merged
Conversation
Second area of the operationId->token migration (after replays). Move the human sentence into summary= and set operation_id to a short camelCase REST token, so the generated @sentry/api SDK gets clean names (listOrganizationDashboards, getOrganizationDashboard, ...) while the docs title/slug stay byte-identical (derived from summary).
github-actions
Bot
added
the
Scope: Backend
gricha
approved these changes
Jun 10, 2026
betegon
added a commit
that referenced
this pull request
Jun 10, 2026
…17302) ## Summary Third area of the operationId→token migration. Move the human sentence into `summary` and set `operation_id` to a short camelCase REST token, so the generated `@sentry/api` SDK gets clean names while docs titles/slugs stay byte-identical (derived from `summary`). 5 operations, 2 files. The path is `/discover/saved/`, so the pure structural token drops the resource noun (`…DiscoverSaved`). Overridden to the endpoint's own term — `DiscoverSavedQuery` (per `DiscoverSavedQuerySerializer`) — for clarity: - `listOrganizationDiscoverSavedQueries` - `createOrganizationDiscoverSavedQuery` - `getOrganizationDiscoverSavedQuery` - `updateOrganizationDiscoverSavedQuery` - `deleteOrganizationDiscoverSavedQuery` ## Test plan - `make build-api-docs` regenerates the spec and passes `--validate --fail-on-warn`; operations show token operationIds with the sentence preserved as `summary`. - prek green (ruff/flake8/mypy + the `@extend_schema` response-type check). ## Related (operationId→token migration) - Convention doc (`src/AGENTS.md`): #117285 - Replays pilot: #117166 · Dashboards: #117297 - Docs SEO foundation: getsentry/sentry-docs#18322 (merged)
This was referenced Jun 10, 2026
amy-chen23
pushed a commit
that referenced
this pull request
Jun 10, 2026
…117297) ## Summary Second area of the operationId→token migration. OpenAPI `operationId` is meant to be a machine identifier, but Sentry uses the human sentence — which the generated `@sentry/api` SDK turns into function names and the API reference renders as the page title + URL slug. This moves the sentence into `summary` and sets `operation_id` to a short camelCase REST token for the **dashboard** endpoints. The SDK gets clean names; paired with the merged docs change (title/slug derive from `summary`), the docs titles and SEO URLs stay byte-identical. 5 operations, 2 files, all textbook CRUD (no exceptions): `listOrganizationDashboards` · `createOrganizationDashboard` · `getOrganizationDashboard` · `updateOrganizationDashboard` · `deleteOrganizationDashboard` ## Test plan - `make build-api-docs` regenerates the spec and passes `--validate --fail-on-warn`; dashboard ops show token operationIds with the sentence preserved as `summary`. - prek green (ruff/flake8/mypy + the `@extend_schema` response-type check). ## Related (operationId→token migration) - Convention documented in `src/AGENTS.md`: #117285 - Replays pilot (first area): #117166 - Docs SEO foundation (title/slug from summary): getsentry/sentry-docs#18322 (merged)
amy-chen23
pushed a commit
that referenced
this pull request
Jun 10, 2026
…17302) ## Summary Third area of the operationId→token migration. Move the human sentence into `summary` and set `operation_id` to a short camelCase REST token, so the generated `@sentry/api` SDK gets clean names while docs titles/slugs stay byte-identical (derived from `summary`). 5 operations, 2 files. The path is `/discover/saved/`, so the pure structural token drops the resource noun (`…DiscoverSaved`). Overridden to the endpoint's own term — `DiscoverSavedQuery` (per `DiscoverSavedQuerySerializer`) — for clarity: - `listOrganizationDiscoverSavedQueries` - `createOrganizationDiscoverSavedQuery` - `getOrganizationDiscoverSavedQuery` - `updateOrganizationDiscoverSavedQuery` - `deleteOrganizationDiscoverSavedQuery` ## Test plan - `make build-api-docs` regenerates the spec and passes `--validate --fail-on-warn`; operations show token operationIds with the sentence preserved as `summary`. - prek green (ruff/flake8/mypy + the `@extend_schema` response-type check). ## Related (operationId→token migration) - Convention doc (`src/AGENTS.md`): #117285 - Replays pilot: #117166 · Dashboards: #117297 - Docs SEO foundation: getsentry/sentry-docs#18322 (merged)
3 tasks
betegon
added a commit
that referenced
this pull request
Jun 17, 2026
…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)⚠️ Merge note: the schema publish job has no concurrency guard — **don't merge the 3 batches simultaneously** (caused a partial-release race last time). Space them out.
billyvg
pushed a commit
that referenced
this pull request
Jun 17, 2026
…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)⚠️ Merge note: the schema publish job has no concurrency guard — **don't merge the 3 batches simultaneously** (caused a partial-release race last time). Space them out.
betegon
added a commit
that referenced
this pull request
Jun 17, 2026
…leases/workflow endpoints (#117339) ## Summary operationId→token migration, **batch 2 of 3** (issues, integrations, releases, workflow_engine — **62 ops / 38 files**). Sentence → `summary`, `operation_id` → short camelCase REST token; docs titles/slugs unchanged (derived from `summary`). Overrides where the path/verb didn't capture intent: - `resolveOrganizationEventId` / `resolveOrganizationShortId` (resolve verb + `Id` casing) - `upload{Organization,Project}ReleaseFile`, `getOrganizationConfigIntegrations` - `getProjectOwnership` kept consistent with `updateProjectOwnership` Bulk operations correctly keep the plural form (`deleteOrganizationIssues`, `updateOrganizationDetectors`, `updateOrganizationWorkflows`) vs their singular detail counterparts. ## Test plan - prek green; CI `api docs test` regenerates + validates the spec (`--fail-on-warn`). ## Related - Batch 1 (core+api): #117337 · Convention: #117285 · Merged: #117166 #117297 #117302 - Batch 3 (preprod/monitors/sentry_apps/notifications/seer/feedback) to follow.⚠️ Don't merge the batches simultaneously — the schema publish job has no concurrency guard (caused a partial-release race before). Space them out.
betegon
added a commit
that referenced
this pull request
Jun 18, 2026
…y_apps/notifications/seer/feedback endpoints (#117403) ## Summary operationId→token migration, **batch 3 of 3** (preprod, monitors, sentry_apps, notifications, seer, feedback — **35 ops / 22 files**). Sentence → `summary`, `operation_id` → short camelCase REST token; docs titles/slugs unchanged (derived from `summary`). Overrides: - `startOrganizationIssueAutofix` / `getOrganizationIssueAutofixState` (seer) - unified all preprod ops to `PreprodArtifact` casing (structural produced inconsistent `Preprodartifacts`), and fixed the latest-base singleton to `getOrganizationPreprodArtifactSnapshotLatestBase` (was a mislabeled `list`) monitors map to the `Detector`/`Monitor` paths as-is; notifications-action ops are self-consistent. ## Test plan - prek green; CI `api docs test` regenerates + validates the spec (`--fail-on-warn`). ## Related - Batch 1 (core+api): #117337 · Batch 2 (issues/integrations/releases/workflow): #117339 - Convention: #117285 · Merged: #117166 #117297 #117302⚠️ Don't merge the batches simultaneously — the schema publish job has no concurrency guard (caused a partial-release race before). Space them out (merge one, wait for its `openapi` publish, then the next).
sehr-m
pushed a commit
that referenced
this pull request
Jun 23, 2026
…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)⚠️ Merge note: the schema publish job has no concurrency guard — **don't merge the 3 batches simultaneously** (caused a partial-release race last time). Space them out.
sehr-m
pushed a commit
that referenced
this pull request
Jun 23, 2026
…leases/workflow endpoints (#117339) ## Summary operationId→token migration, **batch 2 of 3** (issues, integrations, releases, workflow_engine — **62 ops / 38 files**). Sentence → `summary`, `operation_id` → short camelCase REST token; docs titles/slugs unchanged (derived from `summary`). Overrides where the path/verb didn't capture intent: - `resolveOrganizationEventId` / `resolveOrganizationShortId` (resolve verb + `Id` casing) - `upload{Organization,Project}ReleaseFile`, `getOrganizationConfigIntegrations` - `getProjectOwnership` kept consistent with `updateProjectOwnership` Bulk operations correctly keep the plural form (`deleteOrganizationIssues`, `updateOrganizationDetectors`, `updateOrganizationWorkflows`) vs their singular detail counterparts. ## Test plan - prek green; CI `api docs test` regenerates + validates the spec (`--fail-on-warn`). ## Related - Batch 1 (core+api): #117337 · Convention: #117285 · Merged: #117166 #117297 #117302 - Batch 3 (preprod/monitors/sentry_apps/notifications/seer/feedback) to follow.⚠️ Don't merge the batches simultaneously — the schema publish job has no concurrency guard (caused a partial-release race before). Space them out.
sehr-m
pushed a commit
that referenced
this pull request
Jun 23, 2026
…y_apps/notifications/seer/feedback endpoints (#117403) ## Summary operationId→token migration, **batch 3 of 3** (preprod, monitors, sentry_apps, notifications, seer, feedback — **35 ops / 22 files**). Sentence → `summary`, `operation_id` → short camelCase REST token; docs titles/slugs unchanged (derived from `summary`). Overrides: - `startOrganizationIssueAutofix` / `getOrganizationIssueAutofixState` (seer) - unified all preprod ops to `PreprodArtifact` casing (structural produced inconsistent `Preprodartifacts`), and fixed the latest-base singleton to `getOrganizationPreprodArtifactSnapshotLatestBase` (was a mislabeled `list`) monitors map to the `Detector`/`Monitor` paths as-is; notifications-action ops are self-consistent. ## Test plan - prek green; CI `api docs test` regenerates + validates the spec (`--fail-on-warn`). ## Related - Batch 1 (core+api): #117337 · Batch 2 (issues/integrations/releases/workflow): #117339 - Convention: #117285 · Merged: #117166 #117297 #117302⚠️ Don't merge the batches simultaneously — the schema publish job has no concurrency guard (caused a partial-release race before). Space them out (merge one, wait for its `openapi` publish, then the next).
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
2 participants
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.
Summary
Second area of the operationId→token migration. OpenAPI
operationIdis meant to be a machine identifier, but Sentry uses the human sentence — which the generated@sentry/apiSDK turns into function names and the API reference renders as the page title + URL slug.This moves the sentence into
summaryand setsoperation_idto a short camelCase REST token for the dashboard endpoints. The SDK gets clean names; paired with the merged docs change (title/slug derive fromsummary), the docs titles and SEO URLs stay byte-identical.5 operations, 2 files, all textbook CRUD (no exceptions):
listOrganizationDashboards·createOrganizationDashboard·getOrganizationDashboard·updateOrganizationDashboard·deleteOrganizationDashboardTest plan
make build-api-docsregenerates the spec and passes--validate --fail-on-warn; dashboard ops show token operationIds with the sentence preserved assummary.@extend_schemaresponse-type check).Related (operationId→token migration)
src/AGENTS.md: docs(api): document operation_id naming convention #117285MailPluginandMailAdapterso that we can monitor the migration. #18322 (merged)