Luke-Fanguna / FoodForLesser

0 stars 0 forks source link

Schema/API Design Comments (Wesley Tam) #32

Open wesleytam88 opened 10 months ago

wesleytam88 commented 10 months ago
  1. The store database should also store the address of each store in order for “Get Stores” to work as stated in the API spec
  2. Make important/required information such as price and store_id non-nullable
  3. Move your example flows into a separate file from the API spec file
  4. Use code blocks for your API spec instead of regular text to make it more readable
  5. For some of your endpoints, instead of outputting nothing you should output at least something (ex. “ok” or “success”) to indicate that the transaction has been completed
  6. Add option to add data to each table; currently missing ways to add a user and store
  7. Add option to delete data from each table; currently missing ways to delete a user, grocery_list, and store
  8. Is there a reason why users can only have up to 1 grocery list? Letting users have more than 1 grocery list does not seem too complex to implement and gives users much more freedom
  9. Remove the SQL insert statements in the schema.sql file
  10. Functions “distribute_list” and “find_best_item” should be GET requests instead of POST requests
  11. What happens if a user wants to create a crowdsourcing entry with an item that currently does not exist? Do they have to create the item manually, and then create the crowdsourcing entry, or will there be internal logic that will automatically create the item if it does not exist yet? Same with stores.
  12. It doesn’t look like the inventory_level attribute is being used