Provide a API documentation about ticker HOT 6 CLOSED

Hi!

I think ticker software quite interesting and more important - I share the values behind your collective, so I would like to help with it. I could contribute API docs, it'll help me to understand the software and the codebase but first of all I want to make sure no one is working on it yet.

If not I can propose doing API docs using openapi (https://www.openapis.org) spec. What do you think?

from ticker.

Hey, nice to bring that up. I also had OpenAPI Specs in mind. Do you want to add annotations/comments on the handlers to be autogenerated or do you want to create a custom spec file?

from ticker.

Hey. I was thinking about a custom file, but I don't have any objections against annotations too. What's your opinion on it?

from ticker.

I think to start with something (extra file or annotations) is better than having no documentation at all. We can further iterate over it to improve it. So if you want, provide a first (Draft-)PR and we can discuss the direction. Would be really nice to have that!

from ticker.

Started in #76 for public APIs. 🎉

from ticker.

Further implementation will tracked in other issues.

from ticker.