Skip to content

Document response formats for commands at /api/v0/  #888

@teknomunk

Description

@teknomunk

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:

  • Add text following each response JSON that detail what the responses are, expected values and similar information that would be useful to a developer using the API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    dif/mediumPrior experience is likely helpfuleffort/daysEstimated to take multiple days, but less than a weekkind/enhancementA net-new feature or an improvement to an existing featureneed/analysisNeeds further analysis before proceedingtopic/docsDocumentationtopic/kubo/rpcIssues related to https://docs.ipfs.tech/reference/kubo/rpc/ (generated)

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions