Update documentation to include all API endpoints

[demilolu]

Background on the problem the feature will solve/improved user experience

The TakeTwo-WebAPI documentation seems to require users to first successfully run the API locally before being able to know what the full endpoints are for the API as listed here

Review the TakeTwo OpenAPI documentation

For an overview of the available endpoints navigate to http://localhost:8000/docs

The dataset is listed in the documentation, but the full API documentation should be in the read.me itself.

Describe the solution you'd like

Update documentation to provide full documentation on API withouth requiring user to get WebAPI running locally.

Tasks

Description of the development tasks needed to complete this issue, including tests,

Acceptance Criteria

Standards we believe this issue must reach to be considered complete and ready for a pull request. E.g precisely all the user should be able to do with this update, performance requirements, security requirements, etc as appropriate.

[github-actions]

👋 Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed in 14 days.

[github-actions]

👋 Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed in 14 days.

[github-actions]

👋 Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed in 14 days.

[upkarlidder]

Possible solution is to create a GitHub action that generates the swagger docs on every PR merge into main. The docs be hosted as github pages on this repo.

[github-actions]

👋 Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed in 14 days.