Y24-182 - Ensure API v2 documentation is available and updateable

[sdjmchattie]

User story
As we aim to adopt the v2 API across the board, we need to ensure we have good documentation of the endpoints available and how they can be used. We should aim to find a way to auto-generate this documentation so we can ensure it will be kept up to date simply by parsing the implementation. There are bound to be tools that will do this for JSONAPI:Resources but the research hasn't yet been done. It's worth noting that the README for SS does mention generating this documentation, but the instructions apparently do not work.

Who are the primary contacts for this story
Stuart McHattie

Who is the nominated tester for UAT
PSD

Acceptance criteria
To be considered successful the solution must allow:

• The SS API v2 documentation is available in some form.
• The documentation is auto-generated so that it actually gets updated.
• The documentation can be updated easily.