docs(api): add fields query param to GET /v2/check-results/{checkId}#392
Merged
Conversation
Documents the optional `fields` query parameter added in checkly/monorepo#2384, which lets clients request a sparse projection of check result fields. Three additions to api-reference/openapi.json, mirroring the live production spec (api.checklyhq.com/openapi.json) that the nightly update-api-spec workflow syncs from: - `fields` query parameter on GET /v2/check-results/{checkId} - response `entries` items become anyOf [CheckResult, CheckResultProjection] - new CheckResultProjection schema (all refs already present) Brings the docs current ahead of the next auto-sync run. Validated with mintlify openapi-check; the touched elements match production byte-for-byte. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Affected Components
Notes for the Reviewer
Documents the optional
fieldsquery parameter added toGET /v2/check-results/{checkId}in checkly/monorepo#2384, which lets clients request a sparse projection of check result fields.What changed — three additions to
api-reference/openapi.json:fieldsquery parameter onGET /v2/check-results/{checkId}(comma-separated list of allowed result fields)entriesitems becomeanyOf [CheckResult, CheckResultProjection]CheckResultProjectionschema (all of its$refs already exist in the spec)Why it's safe — the monorepo PR is merged and deployed, so the live spec at
api.checklyhq.com/openapi.json(the source the nightlyupdate-api-specworkflow syncs from) already contains these. I extracted the snippets directly from that live spec, so the edits are byte-identical to what the auto-sync would produce — this just brings the docs current ahead of the next scheduled run. The only intentionally-skipped difference vs. live is the endpointdescription, where the docs already carry the HTML→Markdown-cleaned version that the sync script generates.Validation —
mintlify openapi-checkpasses; the touched elements (fieldsparam,entries,CheckResultProjection) match production exactly and all schema refs resolve. No.mdxordocs.jsonchanges needed — the endpoint page already exists and is auto-rendered from the spec.🤖 Generated with Claude Code