search

DevDogs-UGA / Optimal-Schedule-Builder

DevDogs' inaugural, 2024-2025 project: an optimal schedule-building website for UGA students.
11 stars 63 forks source link

CREATE: GET endpoint for Course-Information (Time Slot, CourseName -> Course Sections) #106

Open IgnasPanavas opened 2 weeks ago

IgnasPanavas commented 2 weeks ago

General Endpoint Requirements

  1. Must use Spring Web annotations and syntax
  2. Must have javadocs
  3. Should be made in controller file of the specified micro service
  4. Should return the return of an unimplemented function with an appropriate type, consider if the possible return parameter might be more than one
  5. Comment out the name of the function for now and return an arbitrary value to not break the code at compile time, exception if the return type has a custom type that's not implemented yet, like Course for example. If it returns course it's ok for the code to not compile for now.
  6. The function name should be logical given what you're retrieving

Specific Endpoint Requirements

  1. Should take a class time (required) and optionally class name
  2. Should return a list of course sections using Section.java which isn't implemented yet
IgnasPanavas commented 1 week ago

I updated the expected format for all endpoints. Take a look at the changes in the Bulletin controller for what I'm looking them all to look like in the future. I'm adding time to this issue and all others to implement those changes. Thanks.