Skip to content

docs: fix /api/v0/dag/import response to JSONL (closes #1980) #2338

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

Open
wrvnnull wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −15
Open

docs: fix /api/v0/dag/import response to JSONL (closes #1980) #2338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 6 additions & 15 deletions docs/reference/kubo/rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1131,24 +1131,15 @@ Argument `path` is of file type. This endpoint expects one or several files (dep

### Response

On success, the call to this endpoint will return with 200 and the following body:

```json
{
"Root": {
"Cid": {
"/": "<cid-string>"
},
"PinErrorMsg": "<string>"
},
"Stats": {
"BlockBytesCount": "<uint64>",
"BlockCount": "<uint64>"
}
}
On success, the call to this endpoint will return with 200 and a
**JSONL** body (one JSON object per line, not a single JSON document):

```jsonl
{"Root":{"Cid":{"/":"<cid-string>"},"PinErrorMsg":"string"}}
{"Stats":{"BlockCount":<uint64>,"BlockBytesCount":<uint64>}}
```

The `Stats` record is only present when the `stats=true` argument is provided.
### cURL Example

`curl -X POST -F file=@myfile "http://127.0.0.1:5001/api/v0/dag/import?pin-roots=<value>&local-only=<value>&silent=<value>&stats=<value>&fast-provide-root=<value>&fast-provide-dag=<value>&fast-provide-wait=<value>&allow-big-block=false"`
Expand Down