docs: add checkly api command reference#383
Merged
Merged
Conversation
Documents the checkly api pass-through command with verified examples covering GET/PUT, jq filtering, pagination, stdin input, and response header inspection.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new CLI reference page documenting the checkly api pass-through command and wires it into the CLI Reference navigation so it appears in the sidebar alongside other checkly * commands.
Changes:
- Add
cli/checkly-api.mdxdocumenting usage, arguments, flags, and common examples forcheckly api. - Register the new page in
docs.jsonunder CLI Reference → CLI Commands.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs.json |
Adds cli/checkly-api to the CLI Commands navigation list. |
cli/checkly-api.mdx |
New command reference page for checkly api with options and examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
cli/checkly-api.mdxdocumenting thecheckly apipass-through commanddocs.jsonnavigation (alphabetically betweencheckly-accountandcheckly-checks)What's documented
-i), and verbose debug mode (--verbose)-F/-Xgotcha:-Fadds request body fields and the command defaults toPOSTwhen fields are present, so query-param examples (pagination) pass-X GETexplicitlyTest plan