Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Specs for Flask API #44

Open
tdog191 opened this issue Oct 27, 2019 · 0 comments
Open

Create Specs for Flask API #44

tdog191 opened this issue Oct 27, 2019 · 0 comments

Comments

@tdog191
Copy link
Contributor

tdog191 commented Oct 27, 2019

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants