Skip to content

docs: lack of documentation on some response types #4739

@cmwaters

Description

@cmwaters

From an external team:

Docs often don’t document what responses are. For example, the only reason I can think of to use GetProof is to verify the proof - but it’s documented as a completely opaque structure. We had to reverse engineer this including figuring out all the details about serialization, and a quick link to the spec would save a ton of work. Similarly, the docs give zero information about the expected contents of a shares response

Image Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions