Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/TakeTwo-WebAPI

Update documentation to include all API endpoints

Open
#20 5 comments 0 reactions 0 assignees View on GitHub
documentation enhancement hacktoberfest stale
Dominant language
Python
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

### 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](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.

Contributor guide

Open the contributing guide

Research direction

Review the README and the OpenAPI documentation available at http://localhost:8000/docs to identify the complete set of API endpoints. Update the README so users can find the full API documentation without running the WebAPI locally, and verify that every endpoint is represented accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.