Skip to content

docs: global Kubo RPC flags#2265

Open
lidel wants to merge 2 commits intomainfrom
fix/rpc-global-options
Open

docs: global Kubo RPC flags#2265
lidel wants to merge 2 commits intomainfrom
fix/rpc-global-options

Conversation

@lidel
Copy link
Member

@lidel lidel commented Mar 17, 2026

lidel added 2 commits March 17, 2026 17:57
- endpoints.go: add GlobalOptions() to extract root command flags,
  filtering out CLI-only ones (--repo-dir, --config, --debug, etc.)
- formatter.go: add GenerateGlobalOptionsBlock to Formatter interface,
  call it in GenerateDocs before per-endpoint sections
- markdown.go: render "Global options" section with query param flags
  (--offline, --cid-base, --encoding, --timeout, etc.) and a separate
  "Authentication" subsection for --api-auth (HTTP header)
- endpoints_test.go: add TestGlobalOptions covering inclusion,
  exclusion, and api-auth separation
- endpoints.go: add to ignoredGlobalOptions (now redundant with --cid-base)
- endpoints_test.go: update assertions
- markdown.go: use --cid-base in example text
- rpc.md: regenerated, updated --cid-base description to note CIDv0
  auto-upgrade behavior
@lidel lidel changed the title docs: docs: global Kubo RPC flags Mar 17, 2026
@github-actions
Copy link
Contributor

🚀 Build Preview on IPFS ready

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.

RPC API reference: document global flags

1 participant