Are API Docs being updated? by inertia

View this thread on steempeak.com
· @inertia · (edited)
$20.06
Are API Docs being updated?
<center>
![](https://cl.ly/0F0o3M2y002V/Image%202017-09-18%20at%209.59.52%20PM.png)
</center>

---

It's not easy to write apps for the STEEM blockchain.  It depends on the language you're comfortable with and what level of development you're doing.  Sometimes, it's downright impossible to figure out without a fully defined set of API docs.

<center>
  [![](https://cl.ly/2F1w2j2q0y0p/Image%202017-09-18%20at%209.34.53%20PM.png)](https://steemit.com/steemit/@andrarchy/re-williambanks-re-steemitblog-crowdsourced-marketing-protocol-ideas-proposals-projects-20170418t184727463z)
</center>

---

I know this is not a trivial task.  In fact, it's not a new problem.  It's a problem as old as software development.

> "By documenting a design, the designer exposes himself to the criticisms of everyone, and he must be able to defend everything he writes. If the organizational structure is threatening in any way, nothing is going to be documented until it is completely defensible." - **The Mythical Man-Month by Frederick P. Brooks, Jr.**

While the above paragraph is absolutely true, we should keep in mind it's not an excuse for lack of documentation.  It's merely an observation as to *why* docs get the back seat in priority.  In other words, it's *descriptive*, not *prescriptive*.

I would like to help.  But I encountered a roadblock.

> Is this repo the correct place to expand on the developer api documentation? I only ask because it seems dead in here and I have gotten conflicting responses in rocket chat.

![](https://user-images.githubusercontent.com/494368/30315296-48cf4470-9758-11e7-89bb-057417f5f13b.png)

See: https://github.com/steemit/steemit-docs/issues/8

The roadblock is that I'm not sure if this is the correct repository to make pull requests from.  In addition to that, I'm not sure if my additions would be authoritative.

Anyway, @andrarchy.  What have you found during your 5 month hard look at the API docs?
👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 68 others
properties (23)
post_id13,197,338
authorinertia
permlinkare-api-docs-being-updated
categorysteemit
json_metadata"{"format": "markdown", "links": ["https://steemit.com/steemit/@andrarchy/re-williambanks-re-steemitblog-crowdsourced-marketing-protocol-ideas-proposals-projects-20170418t184727463z", "https://github.com/steemit/steemit-docs/issues/8"], "app": "steemit/0.1", "tags": ["steemit", "development", "documentation"], "users": ["andrarchy"], "image": ["https://cl.ly/0F0o3M2y002V/Image%202017-09-18%20at%209.59.52%20PM.png"]}"
created2017-09-19 04:59:06
last_update2017-09-19 05:00:21
depth0
children4
net_rshares7,830,395,724,872
last_payout2017-09-26 04:59:06
cashout_time1969-12-31 23:59:59
total_payout_value17.618 SBD
curator_payout_value2.437 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length1,942
author_reputation227,335,189,892,062
root_title"Are API Docs being updated?"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
author_curate_reward""
vote details (132)
@mahbubalam ·
steemit also helpful for us.
properties (22)
post_id13,197,420
authormahbubalam
permlinkre-inertia-are-api-docs-being-updated-20170919t050045532z
categorysteemit
json_metadata"{"app": "steemit/0.1", "tags": ["steemit"]}"
created2017-09-19 05:00:48
last_update2017-09-19 05:00:48
depth1
children0
net_rshares0
last_payout2017-09-26 05:00:48
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length28
author_reputation-21,765,957,547
root_title"Are API Docs being updated?"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@fyrstikken ·
$0.13
wow, 5 months and nothing.
@andrarchy, seriously? Why do you keep promises you do not keep?
👍  
properties (23)
post_id13,197,783
authorfyrstikken
permlinkre-inertia-are-api-docs-being-updated-20170919t050744295z
categorysteemit
json_metadata"{"app": "steemit/0.1", "users": ["andrarchy"], "tags": ["steemit"]}"
created2017-09-19 05:07:45
last_update2017-09-19 05:07:45
depth1
children0
net_rshares52,473,415,869
last_payout2017-09-26 05:07:45
cashout_time1969-12-31 23:59:59
total_payout_value0.099 SBD
curator_payout_value0.033 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length91
author_reputation377,282,504,744,699
root_title"Are API Docs being updated?"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
author_curate_reward""
vote details (1)
@abh12345 ·
The Mythical Man-Month is one of the best books in Software Development I've ever read.  20 years or so since my last look, hopefully the API documentation won't take quite so long :)
properties (22)
post_id13,198,476
authorabh12345
permlinkre-inertia-are-api-docs-being-updated-20170919t052109865z
categorysteemit
json_metadata"{"app": "steemit/0.1", "tags": ["steemit"]}"
created2017-09-19 05:21:09
last_update2017-09-19 05:21:09
depth1
children0
net_rshares0
last_payout2017-09-26 05:21:09
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length183
author_reputation590,352,098,179,351
root_title"Are API Docs being updated?"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@dez1337 ·
$0.15
Great post 😊👍

One thing that makes it really hard to document the api is that there are not enoug comments in the steem source code. At least for me documenting a field, an api call or an operation means a lot of trying out and a lot of stepping through the steem source code.
👍  
properties (23)
post_id13,198,954
authordez1337
permlinkre-inertia-are-api-docs-being-updated-20170919t053007755z
categorysteemit
json_metadata"{"app": "steemit/0.1", "tags": ["steemit"]}"
created2017-09-19 05:30:09
last_update2017-09-19 05:30:09
depth1
children0
net_rshares60,047,855,697
last_payout2017-09-26 05:30:09
cashout_time1969-12-31 23:59:59
total_payout_value0.115 SBD
curator_payout_value0.038 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length277
author_reputation20,522,119,974,925
root_title"Are API Docs being updated?"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
author_curate_reward""
vote details (1)