Skip to content

Add request and response object definitions for Appbase API  #391

@cyon1c

Description

@cyon1c

As a developer on the Steem blockchain, I want all api methods documented as well as condenser_api.get_market_history so that I can actually know what I need to do when pulling data or making calls.

Supporting
Condenser API is well documented and understood. However, knowledge about the new AppBase/Blockchain API's is very limited. These new API's have the method names documented in the devportal, however the bulk are missing request and response objects.

An excellent example of a well formed method doc is condenser_api.get_market_history. It provides a table of possible example inputs, with explanations, a sample request object, a sample response, and multiple example curl commands.

In addition, in cases where an empty response/request is expected, some kind of notation to differentiate that from WIP documentation. (or vice versa)

AC

  • ?
  • ?

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