docs: document the DHT query 'Type' integer values (closes #1260) - #2339
Open
wrvnnull wants to merge 2 commits into
Open
docs: document the DHT query 'Type' integer values (closes #1260)#2339wrvnnull wants to merge 2 commits into
wrvnnull wants to merge 2 commits into
Conversation
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.
|
Thank you for submitting this PR!
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.
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. |
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
Closes #1260.
The
Typefield in the/api/v0/dht/queryresponse 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: documentedTypevalues 0–3 for/api/v0/dht/query.Verification