search

thibaultyou / tradingview-alerts-processor

Minimalist service designed to execute TradingView webhooks and process them to cryptocurrencies exchanges.
MIT License
79 stars 23 forks source link

📔 Api documentation #28

Closed leifjones closed 3 years ago

thibaultyou commented 3 years ago

Thank you for this, should make things clearer for most users.

I've updated the Postman collection with a few things, I need to update the Swagger to match modifications. Maybe we need to find a proper way to deploy the Swagger to Github pages or some kind of alternative.

Once this is done we can remove the previous Markdown api documentation.

Any thought or personal preference ?

leifjones commented 3 years ago

If Postman is good-to-go, we could remove the swagger stuff for now and move forward with it?

If it's worth pursuing Swagger, I'd probably next try to implement something using their guide.

I'm still torn between the two. Postman has lots of utility (e.g. scriptable, can save local edits that persist between sessions of the app). Swagger has low threshold for entry because it can be served and used to call a in a browser, and I'm just more familiar with it and have biased affinity because I contributed to it a bit ago. At the moment, I'd either defer to your preference if you have one, or be fine with both for the time being.

thibaultyou commented 3 years ago

Yes we can remove the Swagger part for now and keep the updated Postman.

Feel free to do what you want, we'll merge it once removed.

thibaultyou commented 3 years ago

@mrsegen are we ok to merge this one ?

leifjones commented 3 years ago

Oh, I missed your question. Yep!