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

Update documentation to include all API endpoints

未關閉
#20 5 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation enhancement hacktoberfest stale
主要語言
Python
星號
8
分支
8
PR 合併指標
30 天內沒有已合併 PR

描述

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

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。