Describe the Feature / Enhancement
We need to document the API for user logins. Specifically, we will need these routes for the frontend to consume:
Sessions
- Creating a new user session (unauthenticated)
- Destroying an existing user session (authenticated)
User Details
- Getting public details for a user (unauthenticated)
- Getting private details for the logged-in user (authenticated)
- Setting/Modifying private user details (authenticated)
- Deleting all user data (authenticated)
The documentation should list the route, the request type, the expected HTTP status(es), and examples of expected results with example inputs.
Some of these routes will be RESTful, some of them should be available via GraphQL, and some may need to be both.
Additional Details and Resources
We currently don't have an API documentation system in place. The primary docs system that Django REST Framework recommends is Swagger, as described on their Documenting your API page.
Additionally, we'll need to amend the README.md file to document how to generate the API documentation.
Finally, we should consider publishing the API docs to a public site.
Correct Project Selected
Correct Label Selected
Correct Milestone Selected
Describe the Feature / Enhancement
We need to document the API for user logins. Specifically, we will need these routes for the frontend to consume:
Sessions
User Details
The documentation should list the route, the request type, the expected HTTP status(es), and examples of expected results with example inputs.
Some of these routes will be RESTful, some of them should be available via GraphQL, and some may need to be both.
Additional Details and Resources
We currently don't have an API documentation system in place. The primary docs system that Django REST Framework recommends is Swagger, as described on their Documenting your API page.
Additionally, we'll need to amend the
README.mdfile to document how to generate the API documentation.Finally, we should consider publishing the API docs to a public site.
Correct Project Selected
Correct Label Selected
Correct Milestone Selected