I’m trying to understand the
Response types given by the HTTP API.
While the Response type is defined, what the fields actually contain is not. In some cases its obvious what the values will be, but in others I have no idea.
Can the API documentation be augmented with comments explaining the fields?
I see there’s an older similar thread, Are these seriously the docs?
which ended with the OP creating an issue for this, but it has received zero attention.
As an example, HTTP API | IPFS Docs. There are multiple
peer-id fields, a field called “Extra” (?), and a Responses nested inside of Response.
What are these fields supposed to contain? Some fields are also nested in angled brackets – does this indicate they’re arrays?