Skip to content

ref(api): use token operationIds + summary for dashboard endpoints #117297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
betegon merged 1 commit into from
Jun 10, 2026
Merged

ref(api): use token operationIds + summary for dashboard endpoints #117297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/sentry/dashboards/endpoints/organization_dashboard_details.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ class OrganizationDashboardDetailsEndpoint(OrganizationDashboardBase):
}

@extend_schema(
operation_id="Retrieve an Organization's Custom Dashboard",
operation_id="getOrganizationDashboard",
summary="Retrieve an Organization's Custom Dashboard",
parameters=[GlobalParams.ORG_ID_OR_SLUG, DashboardParams.DASHBOARD_ID],
responses={
200: DashboardDetailsModelSerializer,
Expand All @@ -127,7 +128,8 @@ def get(
return self.respond(body)

@extend_schema(
operation_id="Delete an Organization's Custom Dashboard",
operation_id="deleteOrganizationDashboard",
summary="Delete an Organization's Custom Dashboard",
parameters=[GlobalParams.ORG_ID_OR_SLUG, DashboardParams.DASHBOARD_ID],
responses={
204: RESPONSE_NO_CONTENT,
Expand All @@ -154,7 +156,8 @@ def delete(
return self.respond(status=204)

@extend_schema(
operation_id="Edit an Organization's Custom Dashboard",
operation_id="updateOrganizationDashboard",
summary="Edit an Organization's Custom Dashboard",
parameters=[GlobalParams.ORG_ID_OR_SLUG, DashboardParams.DASHBOARD_ID],
request=DashboardDetailsSerializer,
responses={
Expand Down
6 changes: 4 additions & 2 deletions src/sentry/dashboards/endpoints/organization_dashboards.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,8 @@ class OrganizationDashboardsEndpoint(OrganizationEndpoint):
permission_classes = (OrganizationDashboardsPermission,)

@extend_schema(
operation_id="List an Organization's Custom Dashboards",
operation_id="listOrganizationDashboards",
summary="List an Organization's Custom Dashboards",
parameters=[GlobalParams.ORG_ID_OR_SLUG, VisibilityParams.PER_PAGE, CursorQueryParam],
request=None,
responses={
Expand Down Expand Up @@ -542,7 +543,8 @@ def handle_results(results: list[Dashboard]) -> list[DashboardListResponse]:
)

@extend_schema(
operation_id="Create a New Dashboard for an Organization",
operation_id="createOrganizationDashboard",
summary="Create a New Dashboard for an Organization",
parameters=[GlobalParams.ORG_ID_OR_SLUG],
request=DashboardSerializer,
responses={
Expand Down
Loading