<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?
post_id | 13,197,338 |
---|---|
author | inertia |
permlink | are-api-docs-being-updated |
category | steemit |
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"]}" |
created | 2017-09-19 04:59:06 |
last_update | 2017-09-19 05:00:21 |
depth | 0 |
children | 4 |
net_rshares | 7,830,395,724,872 |
last_payout | 2017-09-26 04:59:06 |
cashout_time | 1969-12-31 23:59:59 |
total_payout_value | 17.618 SBD |
curator_payout_value | 2.437 SBD |
pending_payout_value | 0.000 SBD |
promoted | 0.000 SBD |
body_length | 1,942 |
author_reputation | 227,335,189,892,062 |
root_title | "Are API Docs being updated?" |
beneficiaries | [] |
max_accepted_payout | 1,000,000.000 SBD |
percent_steem_dollars | 10,000 |
author_curate_reward | "" |
voter | weight | wgt% | rshares | pct | time |
---|---|---|---|---|---|
berkah | 0 | 36,565,500,356 | 15% | ||
sandra | 0 | 20,530,661,527 | 9% | ||
ihashfury | 0 | 3,113,359,817 | 2.34% | ||
jason | 0 | 17,844,028,790 | 6.21% | ||
pfunk | 0 | 771,141,098,164 | 15% | ||
proctologic | 0 | 5,113,847,475 | 5% | ||
pnc | 0 | 52,808,193,452 | 15% | ||
makishart | 0 | 24,119,845,600 | 36% | ||
teamsteem | 0 | 2,493,253,205,829 | 15% | ||
raphaelom | 0 | 2,151,971,308 | 100% | ||
fyrstikken | 0 | 1,272,229,914,825 | 100% | ||
lauralemons | 0 | 3,118,895,722 | 7.5% | ||
hitmeasap | 0 | 1,206,311,795 | 7.5% | ||
elyaque | 0 | 169,181,464,678 | 20% | ||
vi1son | 0 | 129,647,703,556 | 100% | ||
mrwang | 0 | 19,755,193,475 | 20% | ||
inertia | 0 | 864,622,780,867 | 100% | ||
raymonjohnstone | 0 | 36,962,235,439 | 100% | ||
sergey44 | 0 | 5,304,919,034 | 100% | ||
webdeals | 0 | 36,748,444,264 | 10% | ||
stef | 0 | 29,903,283,873 | 100% | ||
felixxx | 0 | 177,097,778,559 | 50% | ||
dez1337 | 0 | 66,482,208,050 | 100% | ||
letc | 0 | 674,213,319 | 10% | ||
kurtbeil | 0 | 330,902,939,845 | 100% | ||
lamech-m | 0 | 2,993,435,495 | 15% | ||
titusfrost | 0 | 34,766,052,598 | 10% | ||
lapingvino | 0 | 2,571,045,544 | 100% | ||
renzoarg | 0 | 109,970,500,584 | 100% | ||
abh12345 | 0 | 7,230,851,264 | 10% | ||
azgar | 0 | 124,538,364 | 100% | ||
anagramakinos | 0 | 122,939,379 | 100% | ||
pekelvyggfyn | 0 | 122,793,463 | 100% | ||
ceredarhukelv | 0 | 122,687,632 | 100% | ||
sunscape | 0 | 19,646,273,912 | 20% | ||
seablue | 0 | 34,695,038,029 | 20% | ||
estonia | 0 | 169,647,671,610 | 100% | ||
mathworksheets | 0 | 57,266,415,151 | 100% | ||
darth-azrael | 0 | 5,467,880,672 | 13% | ||
steemcenterwiki | 0 | 6,255,776,344 | 100% | ||
kotturinn | 0 | 18,429,631,622 | 15% | ||
darth-cryptic | 0 | 971,696,665 | 13% | ||
ackza | 0 | 0 | 1% | ||
alexis555 | 0 | 429,023,507,875 | 14% | ||
jondahl | 0 | 2,642,508,026 | 100% | ||
kabachok | 0 | 538,080,602 | 100% | ||
kiborg | 0 | 537,420,933 | 100% | ||
aismor | 0 | 765,864,699 | 100% | ||
magistrxxx | 0 | 535,395,129 | 100% | ||
griffinhearn | 0 | 537,454,384 | 100% | ||
josiahkessler | 0 | 534,027,282 | 100% | ||
hammadakhtar | 0 | 1,074,800,582 | 10% | ||
greenstar | 0 | 6,363,309,792 | 15% | ||
jdc | 0 | 1,381,220,957 | 22.45% | ||
nedkelly | 0 | 1,414,993,294 | 20% | ||
luckyjack | 0 | 1,415,775,158 | 20% | ||
manuel78 | 0 | 61,117,145 | 1% | ||
mandagoi | 0 | 7,026,937,915 | 10% | ||
jamesallen | 0 | 12,352,585,428 | 20% | ||
btcvenom | 0 | 65,405,649,891 | 100% | ||
nrg | 0 | 1,513,196,022 | 100% | ||
scandinavianlife | 0 | 33,190,067,036 | 25% | ||
babayka | 0 | 624,071,159 | 100% | ||
musiclover | 0 | 3,770,536,085 | 20% | ||
brensker | 0 | 3,811,276,766 | 100% | ||
wwfetznh1bqi | 0 | 617,041,772 | 100% | ||
rogermcdanie | 0 | 621,314,998 | 100% | ||
iamnotageek | 0 | 7,623,398,018 | 100% | ||
cryptoholic | 0 | 119,600,024 | 100% | ||
steemit-gamble | 0 | 124,480,128 | 100% | ||
gamerpool | 0 | 912,320,521 | 100% | ||
renyve496 | 0 | 612,873,006 | 100% | ||
lugina | 0 | 154,179,996,581 | 30% | ||
thegoldenphoenix | 0 | 2,884,481,546 | 100% | ||
steemit-hangouts | 0 | 226,991,562 | 100% | ||
gaming-hangouts | 0 | 228,109,952 | 100% | ||
crypto-hangouts | 0 | 206,364,794 | 100% | ||
steemholder | 0 | 229,624,977 | 100% | ||
curationrus | 0 | 152,760,667 | 100% | ||
makindatsteem | 0 | 147,351,803 | 100% | ||
steemmaker | 0 | 1,199,426,854 | 100% | ||
givemedatsteem | 0 | 177,982,112 | 100% | ||
bscompaner | 0 | 621,088,962 | 100% | ||
garudi | 0 | 8,463,579,920 | 100% | ||
molgan | 0 | 489,876,985 | 100% | ||
filipkov | 0 | 517,816,043 | 100% | ||
mireddda | 0 | 486,679,411 | 100% | ||
veto | 0 | 646,561,048 | 100% | ||
lypeb | 0 | 368,614,400 | 100% | ||
rimmafse | 0 | 634,051,727 | 100% | ||
leyroft | 0 | 1,162,299,544 | 100% | ||
neynash | 0 | 1,162,381,849 | 100% | ||
spotlight | 0 | 314,611,224 | 10% | ||
turymenecier | 0 | 75,956,706 | 30% | ||
kranik | 0 | 1,162,666,157 | 100% | ||
laylunev | 0 | 1,161,961,782 | 100% | ||
givemesteem1 | 0 | 1,154,162,648 | 100% | ||
trail2 | 0 | 1,341,997,635 | 100% | ||
trail1 | 0 | 1,073,820,111 | 100% | ||
trail3 | 0 | 1,056,290,476 | 100% | ||
trail4 | 0 | 1,050,486,681 | 100% | ||
trail5 | 0 | 1,050,486,680 | 100% | ||
trail6 | 0 | 1,050,486,680 | 100% | ||
trail7 | 0 | 1,050,486,679 | 100% | ||
airwavez | 0 | 75,612,808 | 25% | ||
rubyz | 0 | 911,097,449 | 100% | ||
galinnazirik | 0 | 1,143,223,512 | 100% | ||
moyeses | 0 | 1,106,063,157 | 100% | ||
drabinova | 0 | 1,131,613,344 | 100% | ||
xoxois | 0 | 704,976,946 | 100% | ||
ninjawhale | 0 | 231,398,839 | 100% | ||
ninja-whale | 0 | 228,923,952 | 100% | ||
steemmemes | 0 | 1,050,400,739 | 100% | ||
sipko | 0 | 1,160,620,611 | 100% | ||
zdemonz | 0 | 1,061,966,603 | 100% | ||
parusnik | 0 | 1,160,619,155 | 100% | ||
steemminers | 0 | 228,872,084 | 100% | ||
wannabeme | 0 | 1,056,888,537 | 100% | ||
kotstancija | 0 | 1,119,993,254 | 100% | ||
iamfrog | 0 | 1,175,809,120 | 100% | ||
fredikotov | 0 | 1,075,645,910 | 100% | ||
jepik | 0 | 1,080,380,978 | 100% | ||
dreamm | 0 | 940,092,723 | 100% | ||
steemode | 0 | 228,726,989 | 100% | ||
cryptoowl | 0 | 228,726,966 | 100% | ||
helpfulcrypto | 0 | 228,726,959 | 100% | ||
idioticbot | 0 | 234,908,728 | 100% | ||
counterbot | 0 | 228,726,914 | 100% | ||
bowlofbitcoin | 0 | 228,726,899 | 100% | ||
eoscrusher | 0 | 228,726,889 | 100% | ||
pumpingbitcoin | 0 | 233,672,325 | 100% | ||
mahbubalam | 0 | 145,075,712 | 100% |
steemit also helpful for us.
post_id | 13,197,420 |
---|---|
author | mahbubalam |
permlink | re-inertia-are-api-docs-being-updated-20170919t050045532z |
category | steemit |
json_metadata | "{"app": "steemit/0.1", "tags": ["steemit"]}" |
created | 2017-09-19 05:00:48 |
last_update | 2017-09-19 05:00:48 |
depth | 1 |
children | 0 |
net_rshares | 0 |
last_payout | 2017-09-26 05:00:48 |
cashout_time | 1969-12-31 23:59:59 |
total_payout_value | 0.000 SBD |
curator_payout_value | 0.000 SBD |
pending_payout_value | 0.000 SBD |
promoted | 0.000 SBD |
body_length | 28 |
author_reputation | -21,765,957,547 |
root_title | "Are API Docs being updated?" |
beneficiaries | [] |
max_accepted_payout | 1,000,000.000 SBD |
percent_steem_dollars | 10,000 |
wow, 5 months and nothing. @andrarchy, seriously? Why do you keep promises you do not keep?
post_id | 13,197,783 |
---|---|
author | fyrstikken |
permlink | re-inertia-are-api-docs-being-updated-20170919t050744295z |
category | steemit |
json_metadata | "{"app": "steemit/0.1", "users": ["andrarchy"], "tags": ["steemit"]}" |
created | 2017-09-19 05:07:45 |
last_update | 2017-09-19 05:07:45 |
depth | 1 |
children | 0 |
net_rshares | 52,473,415,869 |
last_payout | 2017-09-26 05:07:45 |
cashout_time | 1969-12-31 23:59:59 |
total_payout_value | 0.099 SBD |
curator_payout_value | 0.033 SBD |
pending_payout_value | 0.000 SBD |
promoted | 0.000 SBD |
body_length | 91 |
author_reputation | 377,282,504,744,699 |
root_title | "Are API Docs being updated?" |
beneficiaries | [] |
max_accepted_payout | 1,000,000.000 SBD |
percent_steem_dollars | 10,000 |
author_curate_reward | "" |
voter | weight | wgt% | rshares | pct | time |
---|---|---|---|---|---|
felixxx | 0 | 52,473,415,869 | 15% |
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 :)
post_id | 13,198,476 |
---|---|
author | abh12345 |
permlink | re-inertia-are-api-docs-being-updated-20170919t052109865z |
category | steemit |
json_metadata | "{"app": "steemit/0.1", "tags": ["steemit"]}" |
created | 2017-09-19 05:21:09 |
last_update | 2017-09-19 05:21:09 |
depth | 1 |
children | 0 |
net_rshares | 0 |
last_payout | 2017-09-26 05:21:09 |
cashout_time | 1969-12-31 23:59:59 |
total_payout_value | 0.000 SBD |
curator_payout_value | 0.000 SBD |
pending_payout_value | 0.000 SBD |
promoted | 0.000 SBD |
body_length | 183 |
author_reputation | 590,352,098,179,351 |
root_title | "Are API Docs being updated?" |
beneficiaries | [] |
max_accepted_payout | 1,000,000.000 SBD |
percent_steem_dollars | 10,000 |
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.
post_id | 13,198,954 |
---|---|
author | dez1337 |
permlink | re-inertia-are-api-docs-being-updated-20170919t053007755z |
category | steemit |
json_metadata | "{"app": "steemit/0.1", "tags": ["steemit"]}" |
created | 2017-09-19 05:30:09 |
last_update | 2017-09-19 05:30:09 |
depth | 1 |
children | 0 |
net_rshares | 60,047,855,697 |
last_payout | 2017-09-26 05:30:09 |
cashout_time | 1969-12-31 23:59:59 |
total_payout_value | 0.115 SBD |
curator_payout_value | 0.038 SBD |
pending_payout_value | 0.000 SBD |
promoted | 0.000 SBD |
body_length | 277 |
author_reputation | 20,522,119,974,925 |
root_title | "Are API Docs being updated?" |
beneficiaries | [] |
max_accepted_payout | 1,000,000.000 SBD |
percent_steem_dollars | 10,000 |
author_curate_reward | "" |
voter | weight | wgt% | rshares | pct | time |
---|---|---|---|---|---|
dez1337 | 0 | 60,047,855,697 | 100% |