Skip to content

docs: document the DHT query 'Type' integer values (closes #1260) - #2339

Open
wrvnnull wants to merge 2 commits into
ipfs:mainfrom
wrvnnull:fix/dht-query-type-doc
Open

docs: document the DHT query 'Type' integer values (closes #1260)#2339
wrvnnull wants to merge 2 commits into
ipfs:mainfrom
wrvnnull:fix/dht-query-type-doc

Conversation

@wrvnnull

Copy link
Copy Markdown

Summary

Closes #1260.

The Type field in the /api/v0/dht/query response was never explained. This adds a table mapping the integer to its go-libp2p routing query event and links to the authoritative definition.

Changes

  • docs/reference/kubo/rpc.md: documented Type values 0–3 for /api/v0/dht/query.

Verification

The endpoint returns a JSONL body (one JSON object per line), not a
single JSON document. The Stats record only appears when stats=true.
Updates the documented response example to match actual behavior.
The `/api/v0/dht/query` response `Type` field was never explained.
Add a table mapping the integer to its go-libp2p routing query event
(SendingQuery / PeerResponse / FinalPeer / QueryError) and link to the
authoritative definition.
@welcome

welcome Bot commented Aug 27, 2026

Copy link
Copy Markdown

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

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.

"Type" is undefined in RPC documentation

1 participant