Skip to content

feat: use HelpText.HTTP for Content-Type documentation #2248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lidel merged 4 commits into from
Feb 26, 2026
Merged

feat: use HelpText.HTTP for Content-Type documentation #2248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
408b739
feat: use HelpText.HTTP for Content-Type documentation
lidel Jan 30, 2026
9c66e07
chore: update kubo to v0.40.0 and go to 1.26
lidel Feb 25, 2026
2f713ed
docs: regenerate kubo rpc and cli reference for v0.40.0
lidel Feb 26, 2026
794e449
fix: update stale intro examples in rpc and cli docs
lidel Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/update-with-latest-versions/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM golang:1.25
FROM golang:1.26

ENV DEBIAN_FRONTEND=noninteractive
RUN apt update && apt install -y jq && rm -rf /var/lib/apt/lists/*
Expand Down
722 changes: 627 additions & 95 deletions docs/reference/kubo/cli.md
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 9 additions & 4 deletions docs/reference/kubo/generate-cli-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,18 @@ Every command usable from the CLI is also available through the [RPC API v0](rpc
/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx
/ip4/104.236.176.52/tcp/4001/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z
\`\`\`

CLI with \`--enc=json\` produces the same JSON as the HTTP RPC API:
\`\`\`
> curl -X POST http://127.0.0.1:5001/api/v0/swarm/peers
{
\"Strings\": [
\"/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ\",
\"/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx\",
\"/ip4/104.236.176.52/tcp/4001/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z\",
\"Peers\": [
{
\"Addr\": \"/ip4/104.131.131.82/tcp/4001\",
\"Peer\": \"QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ\",
...
}
]
}
\`\`\`
Expand Down
Loading
Loading