wiki icon indicating copy to clipboard operation
wiki copied to clipboard

[Capstone] Define what it means to have a working API

Open cimendes opened this issue 3 years ago • 1 comments

Context: During the course of Batch 5, several students had issues with the Database connection, not being able to store any data, and having a very compromised report #2. According to our wiki, one of the criterium to pass the capstone is having a "working API". We need to better define this, and if the impossibility of saving any of the sent data is considered to be failing this criterium.

Goal(s):

  • Define what is a "Working API" in terms of capstone evaluation

Acceptance criteria:

  • [ ] Consensus has been reached regarding this issue
  • [ ] Documentation in wiki has been updated to reflect the decision reached

cimendes avatar Mar 15 '22 21:03 cimendes

Most common API problems:

  • endpoints are ill-defined (predict instead of predict/, or vice versa)
  • Response is ill-structured (does not follow JSON structure guidelines)
  • Database is unsuccessfully set up (records are not being stored, update endpoint always returns 404)

cimendes avatar May 24 '22 16:05 cimendes