Skip to content
This repository was archived by the owner on Aug 8, 2025. It is now read-only.
This repository was archived by the owner on Aug 8, 2025. It is now read-only.

Create Specs for Flask API #44

@yuppers396

Description

@yuppers396

To facilitate development of the Flask API, a consensus should be reached on how the frontend and backend will communicate through this API. Some design points to address:

  1. What are the API endpoints? (E.g. is the target polling session endpoint "join.click.in/xYz6" or "click.in/xYz6"?)
  2. What types of requests do these endpoints support? (e.g. HTTP requests: GET, PUT, POST, DELETE)
  3. What are the parameters to each endpoint? (e.g. three-character session hash)
  4. What functionality should each endpoint support? (e.g. "it should route user to target polling session page and authenticate if previously logged in.")
  5. What data should responses return, and in what format? (e.g. a JSON list of a student's/professor's courses)
  6. How should errors be handled? (e.g. 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Internal Server Error)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions