docs: fix /api/v0/dag/import response to JSONL (closes #1980) - #2338
Open
wrvnnull wants to merge 1 commit into
Open
docs: fix /api/v0/dag/import response to JSONL (closes #1980)#2338wrvnnull wants to merge 1 commit into
wrvnnull wants to merge 1 commit 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.
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.
Summary
Closes #1980.
The
/api/v0/dag/importdocs incorrectly described the response as a single JSON body. The endpoint actually returns JSONL (one JSON object per line), and theStatsrecord is only present whenstats=trueis passed.Changes
docs/reference/kubo/rpc.md: corrected the Response section for/api/v0/dag/importto show JSONL output and note the conditionalStatsrecord.Verification