RE: Dev Portal Update: Tutorials, Recipes, and Tweaks, Oh My! by inertia

Viewing a response to: @r351574nc3/re-steemitblog-dev-portal-update-tutorials-recipes-and-tweaks-oh-my-20180726t151004343z

devportal · @inertia · Jul 26 '18

$0.14

Like creating an ideal Steem client specification?

https://github.com/steemit/devportal/issues/256

👍 r351574nc3, ackza, salty-mcgriddles, tdre, valuproposition

`post_id`	57,780,362
`author`	inertia
`permlink`	re-r351574nc3-re-steemitblog-dev-portal-update-tutorials-recipes-and-tweaks-oh-my-20180726t151907015z
`category`	devportal
`json_metadata`	{"links":["https:\/\/github.com\/steemit\/devportal\/issues\/256"],"app":"steemit\/0.1","tags":["devportal"]}
`created`	2018-07-26 15:19:06
`last_update`	2018-07-26 15:19:06
`depth`	2
`children`	3
`net_rshares`	77,094,176,867
`last_payout`	2018-08-02 15:19:06
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.132 SBD
`curator_payout_value`	0.011 SBD
`pending_payout_value`	0.000 SBD
`promoted`	0.000 SBD
`body_length`	99
`author_reputation`	227,335,189,892,062
`root_title`	"Dev Portal Update: Tutorials, Recipes, and Tweaks, Oh My!"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 SBD
`percent_steem_dollars`	10,000
`author_curate_reward`	""

properties (23)vote details (5)

voter	rshares	pct
ackza	18,655,947,122	40%
r351574nc3	34,550,802,386	100%
tdre	7,798,689,909	100%
valuproposition	2,856,586,625	100%
salty-mcgriddles	13,232,150,825	100%

@r351574nc3 · Jul 26 '18 (edited)

$0.22

Yeah. I think that nails it. If we had something like an [openapi specification](https://www.openapis.org/) or [Swagger spec](https://swagger.io/specification/) 

1. the reference guide could be generated
1. We can verify/test code and check for breaking changes
1. Generate and verify clients from the api specification
1. Build/contribute additional tooling around the specification

👍 dhimmel, cutemachine, salty-mcgriddles, exifr0, exifr

`post_id`	57,781,258
`author`	r351574nc3
`permlink`	re-inertia-re-r351574nc3-re-steemitblog-dev-portal-update-tutorials-recipes-and-tweaks-oh-my-20180726t152922510z
`category`	devportal
`json_metadata`	{"app":"steemit\/0.1","tags":["devportal"],"links":["https:\/\/www.openapis.org\/","https:\/\/swagger.io\/specification\/"]}
`created`	2018-07-26 15:29:21
`last_update`	2018-07-26 22:41:24
`depth`	3
`children`	2
`net_rshares`	117,898,093,528
`last_payout`	2018-08-02 15:29:21
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.168 SBD
`curator_payout_value`	0.052 SBD
`pending_payout_value`	0.000 SBD
`promoted`	0.000 SBD
`body_length`	384
`author_reputation`	183,372,131,550,888
`root_title`	"Dev Portal Update: Tutorials, Recipes, and Tweaks, Oh My!"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 SBD
`percent_steem_dollars`	10,000
`author_curate_reward`	""

properties (23)vote details (5)

voter	rshares	pct
dhimmel	79,672,351,466	24%
cutemachine	24,983,425,084	100%
salty-mcgriddles	6,442,476,497	100%
exifr	1,079,926,168	100%
exifr0	5,719,914,313	100%

@inertia · Jul 26 '18 (edited)

Those would be great.

Incidentally, we actually have tests for verifying stuff like the `curl` examples in the API Definitions.  If you want to try the tests yourself, they're right over here:

https://github.com/steemit/devportal#tests

And we also generate/verify the API Spec here:

https://github.com/steemit/devportal#managing-api-definitions

properties (22)

`post_id`	57,781,980
`author`	inertia
`permlink`	re-r351574nc3-re-inertia-re-r351574nc3-re-steemitblog-dev-portal-update-tutorials-recipes-and-tweaks-oh-my-20180726t153749343z
`category`	devportal
`json_metadata`	{"app":"steemit\/0.1","tags":["devportal"],"links":["https:\/\/github.com\/steemit\/devportal#tests","https:\/\/github.com\/steemit\/devportal#managing-api-definitions"]}
`created`	2018-07-26 15:37:48
`last_update`	2018-07-26 15:38:51
`depth`	4
`children`	1
`net_rshares`	0
`last_payout`	2018-08-02 15:37: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`	348
`author_reputation`	227,335,189,892,062
`root_title`	"Dev Portal Update: Tutorials, Recipes, and Tweaks, Oh My!"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 SBD
`percent_steem_dollars`	10,000

@r351574nc3 · Jul 26 '18

$0.42

When I said generated, I meant from the actual source code. I'm basically suggesting a literate programming approach with specification as code.

Like if @inertia made changes to the json-rpc, then specification changes would be accepted in the same PR. In the next CI build, documentation could be generated, but that's not what's important. What's important is that now the specification itself is deployed with the software and can be used to generate/verify a client.

From a single change, you have now affected several facets.

👍 dhimmel, salty-mcgriddles, drsensor, exifr0, valuproposition, exifr

`post_id`	57,783,464
`author`	r351574nc3
`permlink`	re-inertia-re-r351574nc3-re-inertia-re-r351574nc3-re-steemitblog-dev-portal-update-tutorials-recipes-and-tweaks-oh-my-20180726t155356154z
`category`	devportal
`json_metadata`	{"users":["inertia"],"app":"steemit\/0.1","tags":["devportal"]}
`created`	2018-07-26 15:53:54
`last_update`	2018-07-26 15:53:54
`depth`	5
`children`	0
`net_rshares`	225,025,001,874
`last_payout`	2018-08-02 15:53:54
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.320 SBD
`curator_payout_value`	0.102 SBD
`pending_payout_value`	0.000 SBD
`promoted`	0.000 SBD
`body_length`	532
`author_reputation`	183,372,131,550,888
`root_title`	"Dev Portal Update: Tutorials, Recipes, and Tweaks, Oh My!"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 SBD
`percent_steem_dollars`	10,000
`author_curate_reward`	""

properties (23)vote details (6)

voter	rshares	pct
dhimmel	195,059,894,970	59%
valuproposition	2,813,737,826	100%
salty-mcgriddles	13,515,191,484	100%
exifr	1,115,256,965	100%
drsensor	6,566,592,586	100%
exifr0	5,954,328,043	100%