Skip to content

MET-543: Publish explicit telemetry read contracts - #94

Draft
sam-bretz wants to merge 1 commit into
sam/met-550-bounded-analytical-readsfrom
sam/met-543-typed-telemetry
Draft

sam-bretz wants to merge 1 commit into
sam/met-550-bounded-analytical-readsfrom
sam/met-543-typed-telemetry

Conversation

@sam-bretz

Copy link
Copy Markdown
Collaborator

What Changed

MET-543 documents explicit successful and error response schemas for usage, timeseries, environments and calls.

How It Works

Schema-only FastAPI response declarations preserve existing values and auth. Required and nullable fields, units, filters, completeness and call cursor semantics are explicit. Environment values include null for untagged records; future additive metadata remains allowed. See docs/operations/telemetry-read-contracts.md.

Stack parent: MET-550 #93, commit c84a3ed. The shared application has a separate draft; consumers need no payload migration, and MET-545 owns final packaged rolling-release checks.

QA Overview

880 core/server tests passed with disposable PostgreSQL (one existing dependency warning); focused schema tests 26 passed; new-module/test Ruff passed. Actual HTTP responses validated against this build's served schemas, including nonempty/null fields, untagged environment choices, cursor pages, auth/query/validation errors and a real five-second lock timeout with recovery.

Final independent Claude review found no actionable findings after correcting its null-environment schema/coverage findings. No runtime output filtering, UI change, migration or provider calls. OSS has no operational metrics exporter; no throughput or hosted/installed fleet claim. Draft only, test services cleaned up.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant