docs(datumctl): add Local API proxy guide and refine CLI nav#46
Open
scotwells wants to merge 3 commits into
Open
docs(datumctl): add Local API proxy guide and refine CLI nav#46scotwells wants to merge 3 commits into
scotwells wants to merge 3 commits into
Conversation
Document the `datumctl api proxy` command (shipped in datumctl v0.18.0): starting the proxy, path passthrough and --project/--organization scoping, streaming, token refresh and failure behavior, the security model, and request logging. Adds the page to the Core concepts nav group next to output-and-scripting. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Move the Local API proxy page out of Core concepts into a new Developer tooling nav group (before CI/CD). The proxy is an opt-in integration tool for wiring local dev servers and test harnesses to the API, not a core concept needed to use datumctl. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Plugins are a primary way users extend and interact with the CLI, so surface the group higher — right after Working with resources — instead of near the end of the datumctl nav. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
scotwells
changed the title
scotwells
marked this pull request as ready for review
July 17, 2026 01:17
scotwells
enabled auto-merge
July 17, 2026 01:17
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.
Adds a user guide for
datumctl api proxy(the local authenticated proxy shipped in datumctl v0.18.0, datumctl#247), plus two smalldatumctlnav refinements.What this adds
New page — Local API proxy under a new datumctl → Developer tooling nav group. It covers what a user needs to actually use the command:
--quiet) and the stdout readiness line for scripts--project/--organizationscoping to a single control plane502+X-Datum-Proxy-Errorbehavior when a session can't be refreshed vs. a real platform401/403Nav refinements (
docs.jsononly):Resulting datumctl nav order: Getting started · Authentication · Core concepts · Working with resources · Plugins · Activity & audit · Interactive console · AI & MCP · Developer tooling · CI/CD · Kubernetes interop.
Notes for reviewers
docs/api-proxy.mdin the datumctl repo and reshaped to Mintlify (frontmatter,<Info>/<Note>/<Tip>callouts, sentence-case headings) to match neighboring pages. Cross-links to service accounts and managing accounts.datum.net/docs/datumctl/api-proxy/.🤖 Generated with Claude Code