-
Notifications
You must be signed in to change notification settings - Fork 481
Document response formats for commands at /api/v0/ #888
Copy link
Copy link
Closed
Labels
dif/mediumPrior experience is likely helpfulPrior experience is likely helpfuleffort/daysEstimated to take multiple days, but less than a weekEstimated to take multiple days, but less than a weekkind/enhancementA net-new feature or an improvement to an existing featureA net-new feature or an improvement to an existing featureneed/analysisNeeds further analysis before proceedingNeeds further analysis before proceedingtopic/docsDocumentationDocumentationtopic/kubo/rpcIssues related to https://docs.ipfs.tech/reference/kubo/rpc/ (generated)Issues related to https://docs.ipfs.tech/reference/kubo/rpc/ (generated)
Description
Metadata
Metadata
Assignees
Labels
dif/mediumPrior experience is likely helpfulPrior experience is likely helpfuleffort/daysEstimated to take multiple days, but less than a weekEstimated to take multiple days, but less than a weekkind/enhancementA net-new feature or an improvement to an existing featureA net-new feature or an improvement to an existing featureneed/analysisNeeds further analysis before proceedingNeeds further analysis before proceedingtopic/docsDocumentationDocumentationtopic/kubo/rpcIssues related to https://docs.ipfs.tech/reference/kubo/rpc/ (generated)Issues related to https://docs.ipfs.tech/reference/kubo/rpc/ (generated)
As seen on this page, the response sections of every API call have no explanation of the returned fields. In one instance in particular, /api/v0/add, there is enough confusion about the Name and Hash fields to spawn a forum thread trying to determine what the Name field actually returns.
Proposed change: