Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add request and response object definitions for Appbase API #391

Open
2 tasks
cyon1c opened this issue Nov 16, 2018 · 1 comment
Open
2 tasks

Add request and response object definitions for Appbase API #391

cyon1c opened this issue Nov 16, 2018 · 1 comment
Labels

Comments

@cyon1c
Copy link

cyon1c commented Nov 16, 2018

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

  • ?
  • ?
@relativityboy
Copy link
Contributor

@cyon1c will be adding AC in requested priority. Other Steemworks members should ping for that and remove BLOCKED when appropriate.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants