UCSBCurriculumController.java

package edu.ucsb.cs156.courses.controllers;

import edu.ucsb.cs156.courses.documents.Primary;

import edu.ucsb.cs156.courses.repositories.UserRepository;

import edu.ucsb.cs156.courses.services.UCSBCurriculumService;

import io.swagger.v3.oas.annotations.Operation;

import io.swagger.v3.oas.annotations.Parameter;

import io.swagger.v3.oas.annotations.tags.Tag;

import java.util.List;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.RestController;

@Tag(name = "UCSBCurriculumController")

@RestController

@RequestMapping("/api/public")

  @Autowired UserRepository userRepository;

  @Autowired UCSBCurriculumService ucsbCurriculumService;

  @Operation(

      summary =

          "Get course data (in original UCSB API format) for a given quarter, department, and level")

  @GetMapping(value = "/basicsearch", produces = "application/json")

  public ResponseEntity<String> basicsearch(

      @RequestParam String qtr, @RequestParam String dept, @RequestParam String level)

      throws Exception {

  }

  /**

   * Get primaries for a given quarter, department, and level. This endpoint returns a list of

   * Primary objects.

   *

   * @param qtr the quarter in YYYYQ format

   * @param dept the department code (e.g., "CS")

   * @param level the course level (e.g., "UG" for undergraduate)

   * @return a list of Primary objects

   */

  @Operation(summary = "Get primaries for a given quarter, department, and level")

  @GetMapping(value = "/primaries", produces = "application/json")

  public List<Primary> primaries(

      @RequestParam String qtr, @RequestParam String dept, @RequestParam String level)

      throws Exception {

  }

  // Backend for final exam info, similar to the above operation:

  @Operation(summary = "Get final exam information for a given quarter and course enrollment code")

  @GetMapping(value = "/finalsInfo", produces = "application/json")

  public ResponseEntity<String> finalsInfo(

      @RequestParam String quarterYYYYQ, @RequestParam String enrollCd)

      throws Exception { // Looks for quarter and code

  }

  @Operation(summary = "Get General Education areas, optionally filtered by collegeCode")

  @GetMapping(value = "/generalEducationInfo", produces = "application/json")

  public ResponseEntity<?> generalEducationInfo(

      @Parameter(description = "Enter either L&S, ENGR, or CRST")

          @RequestParam(value = "collegeCode", required = false)

          String collegeCode)

      throws Exception {

      // returns List<String> of requirementCode

    } else {

      // returns the full raw JSON array

    }

  }

}

Mutations