bitshares-ui icon indicating copy to clipboard operation
bitshares-ui copied to clipboard

[10] Gateway/Bridge Documentation

Open startailcoon opened this issue 6 years ago • 6 comments

This issue is to track work for the documentation part of the Gateway and Bridge update.

This task will include, but not limited to

  • [ ] Create a swagger documentation
  • [ ] Update wiki section

Rough estimate: 10 hours

Parent Task: https://github.com/bitshares/bitshares-ui/issues/1771

startailcoon avatar Oct 14 '18 20:10 startailcoon

moved info from wiki to swagger https://app.swaggerhub.com/apis-docs/home415/BitsharesGatewayRequirements/1.0.0

work in progress. need to collect some explanations of response fields

dot5enko avatar Jul 23 '19 00:07 dot5enko

Why move away from github? Github seems more "official".

abitmore avatar Jul 23 '19 10:07 abitmore

At the end we want Wiki and Swagger. Swagger makes integration for newcomers very easy.

sschiessl-bcp avatar Jul 23 '19 10:07 sschiessl-bcp

moved info from wiki to swagger https://app.swaggerhub.com/apis-docs/home415/BitsharesGatewayRequirements/1.0.0

work in progress. need to collect some explanations of response fields

Can you check please? This link is not working atm

sschiessl-bcp avatar Aug 15 '19 08:08 sschiessl-bcp

@sschiessl-bcp sorry, changed owner name. https://app.swaggerhub.com/apis/bitshares-docs/BitsharesGatewayRequirements/1.0.0 Also. this is my swagger account, probably we need another one for bitshares itself. Can we achieve this ?

dot5enko avatar Aug 15 '19 19:08 dot5enko

@dot5enko your swagger seems to be missing:

DEPOSIT_LIMIT: "/deposit-limits",
ESTIMATE_OUTPUT: "/estimate-output-amount",
ESTIMATE_INPUT: "/estimate-input-amount"

..and as a general note I think a python/flask sample code would be very useful.

RuneStone0 avatar Jan 17 '20 16:01 RuneStone0