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

Update documentation to include all API endpoints

Aperta
#20 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation enhancement hacktoberfest stale
Lingua principale
Python
Stelle
8
Fork
8
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.