Skip to content

fix(analytics): declare real error codes on unified-metric routes #2134

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
aleksdotbar merged 2 commits into from
Aug 3, 2026
Merged

fix(analytics): declare real error codes on unified-metric routes #2134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adefe78
fix(analytics): declare real error codes for metric-definitions
aleksdotbar Aug 3, 2026
15c16f6
fix(analytics): declare real error codes for metric-results/drilldown
aleksdotbar Aug 3, 2026
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
88 changes: 4 additions & 84 deletions docs/components/backend/analytics/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3209,16 +3209,6 @@
},
"description": "Metric definitions"
},
"400": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/problem+json": {
Expand All @@ -3229,46 +3219,6 @@
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Conflict"
},
"429": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Too Many Requests"
},
"500": {
"content": {
"application/problem+json": {
Expand Down Expand Up @@ -3333,16 +3283,6 @@
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/problem+json": {
Expand All @@ -3353,15 +3293,15 @@
},
"description": "Not Found"
},
"409": {
"415": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Conflict"
"description": "Unsupported Media Type"
},
"429": {
"content": {
Expand Down Expand Up @@ -3447,35 +3387,15 @@
},
"description": "Forbidden"
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Not Found"
},
"409": {
"415": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Conflict"
},
"429": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Too Many Requests"
"description": "Unsupported Media Type"
},
"500": {
"content": {
Expand Down
16 changes: 13 additions & 3 deletions src/backend/services/analytics/src/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,11 @@ fn build_operations(router: Router, openapi: &dyn OpenApiRegistry) -> Router {
StatusCode::OK,
"Metric results",
)
.standard_errors(openapi)
.error_400(openapi)
.error_401(openapi)
.error_403(openapi)
.error_415(openapi)
.error_500(openapi)
.handler(metric_results::query_metric_results)
.register(router, openapi);

Expand Down Expand Up @@ -345,7 +349,12 @@ fn build_operations(router: Router, openapi: &dyn OpenApiRegistry) -> Router {
StatusCode::OK,
"Metric evidence",
)
.standard_errors(openapi)
.error_400(openapi)
.error_401(openapi)
.error_404(openapi)
.error_415(openapi)
.error_429(openapi)
.error_500(openapi)
.handler(metric_drilldown::query_metric_drilldown)
.register(router, openapi);

Expand Down Expand Up @@ -480,7 +489,8 @@ fn build_operations(router: Router, openapi: &dyn OpenApiRegistry) -> Router {
StatusCode::OK,
"Metric definitions",
)
.standard_errors(openapi)
.error_401(openapi)
.error_500(openapi)
.handler(metric_definitions::list_metric_definitions)
.register(router, openapi);

Expand Down
2 changes: 1 addition & 1 deletion src/ingestion/tests/e2e/api/test_metric_results.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def test_metric_results_400_reversed_period(api) -> None:
def test_metric_results_400_unknown_metric_key(api) -> None:
"""An unknown `metric_key` is resolved against the catalog and rejected as a
400 (`unavailable`) — NOT a 404. Pins that the compute endpoint has no
not-found path (the spec's declared 404 is `.standard_errors` boilerplate)."""
not-found path, which is why the spec declares no 404 for it."""
body = _request(
metrics=[{"metric_key": "e2e.definitely-not-a-real-metric", "views": [{"view": "period"}]}],
)
Expand Down
2 changes: 0 additions & 2 deletions src/ingestion/tests/e2e/lib/api_coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,6 @@
"POST /v1/admin/metric-thresholds": frozenset({404, 409}), # 404 boilerplate; 409=#1664
# persons 200/404 covered via the in-process Identity stub (#1691); rest boilerplate
"GET /v1/persons/{email}": frozenset({400, 403, 409}),
# 404/409 boilerplate; 403 IS reachable (person outside the caller's visible set)
"POST /v1/metric-results": frozenset({404, 409}),
# saved-query CRUD + run (#1965): 403 (no role gate — cross-tenant is 404 by
# opacity) and 409 (no conflict path) are `.standard_errors` boilerplate.
"GET /v1/queries": frozenset({400, 403, 404, 409}), # boilerplate: list, no input/lookup/conflict
Expand Down
Loading