API documentation example

[TisRyno]

Also as per discussed on discord.

Can we get an example or simple API endpoint added so contributions can begin without having to invent/create the structure and expected format.

[danirukun]

I think also this page should link to the API docs: https://docs.streamelements.com/api

[TisRyno]

Any movement on this?

The fact the old API Docs are so neglected and don't even outline all responses properly is a pain.

Not sure how developers can be expected to build tooling around the products if the API documentation isn't kept consistent or even maintained.

[danirukun]

@TisRyno I added a link to https://dev.streamelements.com/ in the API section, since that is the new home of the API docs.

[TisRyno]

@danirukun I don't understand, the old documentation for API docs won't be migrated into this new documentation?

That seems very short sighted considering the old documentation contains references to Widgets and WebSockets, both of which are potentially out of date due the documentation being moved.
Also the old documentation is incredibly slow and sometimes doesn't even load properly, leaving a blank sidebar.

What's the point in maintaining 2 documentation projects?

[c4ldas]

@DaniruKun
Also the old documentation is incredibly slow and sometimes doesn't even load properly, leaving a blank sidebar.

Hey! Just wanted to share that I have made an improved version of the API docs with:

• More endpoints (including some missing ones)
• Fixed operations (moved broken ones to a wonky - not working section)
• Better details like:
  • Meaningful descriptions for each operation
  • Auth types per endpoint
  • Required/optional params
  • Request/response examples
  • Expected status codes
  • Faster loading + better search

I sent the updated OpenAPI YAML to SE devs a while back (some months ago), but since the official docs haven't changed, you can check my version here: https://github.com/c4ldas/streamelements-api (there's a link to the webpage in there)

[awingfield916-tech]

I'm having an issue with linking it.