docs(api): sync OpenAPI specs with current backend handlers - #322
Merged
Conversation
…on pages, alert-source nav, accuracy fixes (doc-review 2026-08-27)
- Field-level corrections across all modules (on-call, monitors, rum, platform, safari): fix request/response property types, binding-derived constraints (required/min/max/oneof), omitempty nullability, enums, and missing or inaccurate descriptions - Remove retired monitors endpoints /monit/rule/status, /monit/preview/sync and /monit/query/rows from the specs and API catalog; update CLI and Go SDK references accordingly - Enrichment mapping data: document the real CSV download stream and the multipart/form-data upload contract (schema_id query param, file field) - Unify request/response examples between the English and Chinese specs
ysyneu
force-pushed
the
docs/openapi-spec-sync-20260828
branch
from
August 28, 2026 07:13
cd24cfb to
cb2d15c
Compare
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
1 participant
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.
What
Field-level synchronization of all public OpenAPI specs (on-call, monitors, rum, platform, safari — 335 operations) with the current backend handlers, plus removal of the retired monitors endpoints.
Corrections across all modules
binding-derived constraints fixed:required, min/max, length limits,oneofenumsomitemptyresponse fields no longer marked required; omission conditions documentedRetired monitors endpoints
/monit/rule/status,/monit/preview/sync,/monit/query/rowsno longer have handlers in monit-webapi, so they are removed from the specs, the API catalog, and the CLI / Go SDK references. (The docs.json nav entries were already dropped in 7ff481b.)Contract corrections
/enrichment/mapping/data/download: 200 is a CSV attachment stream (application/octet-stream), not a JSON envelope/enrichment/mapping/data/upload: request ismultipart/form-data(filefield) withschema_id/do_not_truncate_firstquery params/status-page/subscriber/export: CSV response (from the same sync round)export_fieldskeysValidation
python3 scripts/lint_openapi.py— all 12 spec files pass