It has been noticed that the API documentation is not always easy to follow. This issue is to start the investigation/audit into the API docs and spawn off issues / tasks to ensure that all documentation is correct and up-to-date.
Users of the APIs must be able to reference the documentation and have clear information with good working examples (where applicable).
Tasks (subject to change post review):
[x] Review API docs and ensure that the docs matches the implementation (examples work etc..)
[x] Ensure we have docs about all subscriptions or WebSockets
[x] Break down the tasks into issues to be prioritised
Audit complete. Tickets identified have been created and labelled as api-cleanup. Websockets docs is almost complete and being handled under another ticket.
Issue
It has been noticed that the API documentation is not always easy to follow. This issue is to start the investigation/audit into the API docs and spawn off issues / tasks to ensure that all documentation is correct and up-to-date.
Users of the APIs must be able to reference the documentation and have clear information with good working examples (where applicable).
Tasks (subject to change post review):
Additional information:
Examples of WebSocket API docs:
When picking up this work we should ensure that we coordinate with the docs team.
Also related to: