fix: Consolidating Common Data Models

apps/api/src/rest/routes/ap-exams.ts

@@ -4,8 +4,9 @@ import {
   apExamsQuerySchema,
   apExamsResponseSchema,
   coursesGrantedTreeSchema,
-  errorSchema,
-  responseSchema,
+  response200,
+  response404,
+  response500,
 } from "$schema";
 import { APExamsService } from "$services";
 import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
@@ -25,18 +26,9 @@ const apExamsRoute = createRoute({
     "Get AP exam data: mappings from College Board exam names to UCI Catalogue names and course credit for each exam score.",
   request: { query: apExamsQuerySchema },
   responses: {
-    200: {
-      content: { "application/json": { schema: responseSchema(apExamsResponseSchema) } },
-      description: "Successful operation",
-    },
-    404: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "AP Exam mapping not found",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(apExamsResponseSchema),
+    404: response404("AP Exam mapping not found"),
+    500: response500(),
   },
 });
 

apps/api/src/rest/routes/calendar.ts

@@ -1,6 +1,13 @@
 import { defaultHook } from "$hooks";
 import { productionCache } from "$middleware";
-import { calendarQuerySchema, calendarTermSchema, errorSchema, responseSchema } from "$schema";
+import {
+  calendarQuerySchema,
+  calendarTermSchema,
+  response200,
+  response404,
+  response422,
+  response500,
+} from "$schema";
 import { CalendarService } from "$services";
 import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
 import { database } from "@packages/db";
@@ -16,24 +23,10 @@ const calendarTermRoute = createRoute({
   request: { query: calendarQuerySchema },
   description: "Retrieves key dates for the provided term.",
   responses: {
-    200: {
-      content: {
-        "application/json": { schema: responseSchema(calendarTermSchema) },
-      },
-      description: "Successful operation",
-    },
-    404: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Term not found",
-    },
-    422: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Parameters failed validation",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(calendarTermSchema),
+    404: response404("Term not found"),
+    422: response422(),
+    500: response500(),
   },
 });
 
@@ -45,18 +38,8 @@ const allCalendarTermsRoute = createRoute({
   path: "/all",
   description: "Retrieves all data for all terms that are currently available.",
   responses: {
-    200: {
-      content: {
-        "application/json": {
-          schema: responseSchema(calendarTermSchema.array()),
-        },
-      },
-      description: "Successful operation",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(calendarTermSchema.array()),
+    500: response500(),
   },
 });
 

apps/api/src/rest/routes/catalogue.ts

@@ -1,8 +1,9 @@
 import { defaultHook } from "$hooks";
 import { productionCache } from "$middleware";
 import {
-  errorSchema,
-  responseSchema,
+  response200,
+  response404,
+  response500,
   sampleProgramsQuerySchema,
   sampleProgramsResponseSchema,
 } from "$schema";
@@ -21,22 +22,9 @@ const sampleProgramsRoute = createRoute({
   description: "List sample programs in UCI's current catalogue.",
   request: { query: sampleProgramsQuerySchema },
   responses: {
-    200: {
-      content: {
-        "application/json": {
-          schema: responseSchema(sampleProgramsResponseSchema),
-        },
-      },
-      description: "Successful operation",
-    },
-    404: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Sample program data not found",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(sampleProgramsResponseSchema),
+    404: response404("Sample program data not found"),
+    500: response500(),
   },
 });
 

apps/api/src/rest/routes/courses.ts

@@ -6,11 +6,12 @@ import {
   coursesByCursorQuerySchema,
   coursesPathSchema,
   coursesQuerySchema,
-  cursorResponseSchema,
-  errorSchema,
   prerequisiteSchema,
   prerequisiteTreeSchema,
-  responseSchema,
+  response200,
+  response404,
+  response422,
+  response500,
 } from "$schema";
 import { CoursesService } from "$services";
 import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
@@ -31,20 +32,9 @@ const batchCoursesRoute = createRoute({
   request: { query: batchCoursesQuerySchema },
   description: "Retrieves courses with the IDs provided",
   responses: {
-    200: {
-      content: {
-        "application/json": { schema: responseSchema(courseSchema.array()) },
-      },
-      description: "Successful operation",
-    },
-    422: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Parameters failed validation",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(courseSchema.array()),
+    422: response422(),
+    500: response500(),
   },
 });
 
@@ -57,22 +47,10 @@ const courseByIdRoute = createRoute({
   request: { params: coursesPathSchema },
   description: "Retrieves a course by its ID.",
   responses: {
-    200: {
-      content: { "application/json": { schema: responseSchema(courseSchema) } },
-      description: "Successful operation",
-    },
-    404: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Course not found",
-    },
-    422: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Parameters failed validation",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(courseSchema),
+    404: response404("Course not found"),
+    422: response422(),
+    500: response500(),
   },
 });
 
@@ -85,20 +63,9 @@ const coursesByFiltersRoute = createRoute({
   request: { query: coursesQuerySchema },
   description: "Retrieves courses matching the given filters.",
   responses: {
-    200: {
-      content: {
-        "application/json": { schema: responseSchema(courseSchema.array()) },
-      },
-      description: "Successful operation",
-    },
-    422: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Parameters failed validation",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(courseSchema.array()),
+    422: response422(),
+    500: response500(),
   },
 });
 
@@ -111,20 +78,9 @@ const coursesByCursorRoute = createRoute({
   request: { query: coursesByCursorQuerySchema },
   description: "Retrieves courses matching the given filters with cursor-based pagination.",
   responses: {
-    200: {
-      content: {
-        "application/json": { schema: cursorResponseSchema(courseSchema.array()) },
-      },
-      description: "Successful operation",
-    },
-    422: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Parameters failed validation",
-    },
-    500: {
-      content: { "application/json": { schema: errorSchema } },
-      description: "Server error occurred",
-    },
+    200: response200(courseSchema.array(), { isCursor: true }),
+    422: response422(),
+    500: response500(),
   },
 });