steemit / devportal

Steem Platform Developer Documentation.
https://developers.steem.io
MIT License
122 stars 74 forks source link

Create Appbase API page #37

Closed relativityboy closed 6 years ago

relativityboy commented 6 years ago

Document all Appbase API methods.

A quickref was created - though this should not be considered authoritative, all methods described should be validated for correctness: https://steemit.com/appbase/@holger80/api-methods-list-for-appbase

AC

TimCliff commented 6 years ago

I don’t have permission to assign issues, but I can work on this.

relativityboy commented 6 years ago

FYI, it's possible to transform an object from the yml files into a json string and then highlight it with the following codeblock in the jekyll-liquid templating engine. Honestly it looses impact without pretty-printing and the huge amount of padding around the codblocks makes me think we should stick with the | jsonify filter for now.

{% highlight json %}
{{method.expected_response_json | jsonify }}
{% endhighlight %}
TimCliff commented 6 years ago

@relativityboy I submitted PR https://github.com/steemit/devportal/pull/43. Please review and let me know what you think.

There are two areas that I think could still use some improvement - either in this PR or as a later enhancement:

relativityboy commented 6 years ago

The last required AC was not met, but due to dev capacity, and in appreciation for @TimCliff's work we'll add AAP: List of common properties of request & response with definitions at the top in a different issue.