bitshares-ui
bitshares-ui copied to clipboard
[10] Gateway/Bridge Documentation
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
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
Why move away from github? Github seems more "official".
At the end we want Wiki and Swagger. Swagger makes integration for newcomers very easy.
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 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 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.