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

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

Open
2 tasks
cimendes opened this issue Mar 15, 2022 · 1 comment
Open
2 tasks

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

cimendes opened this issue Mar 15, 2022 · 1 comment
Labels
Batch 6 capstone Improvement Works, but could be better priority:medium Teaching AOR Falls under the responsibility of the Teaching AOR.

Comments

@cimendes
Copy link
Member

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 cimendes added Improvement Works, but could be better Teaching AOR Falls under the responsibility of the Teaching AOR. priority:medium capstone Batch 6 labels Mar 15, 2022
@cimendes
Copy link
Member Author

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Batch 6 capstone Improvement Works, but could be better priority:medium Teaching AOR Falls under the responsibility of the Teaching AOR.
Projects
None yet
Development

No branches or pull requests

1 participant