Add native zod schemas and documntation for 3 modules

Author: devksingh4

src/api/components/index.ts

@@ -0,0 +1,19 @@
+import { FastifySchema } from "fastify";
+import { z } from "zod";
+
+export const ts = z.coerce
+  .number()
+  .min(0)
+  .optional()
+  .openapi({ description: "Staleness bound", example: 0 });
+export const groupId = z.string().min(1).openapi({
+  description: "Entra ID Group ID",
+  example: "d8cbb7c9-2f6d-4b7e-8ba6-b54f8892003b",
+});
+
+export function withTags<T>(tags: string[], schema: T) {
+  return {
+    tags,
+    ...schema,
+  };
+}

src/api/functions/auditLog.ts

@@ -2,14 +2,7 @@ import { DynamoDBClient, PutItemCommand } from "@aws-sdk/client-dynamodb";
 import { marshall } from "@aws-sdk/util-dynamodb";
 import { genericConfig } from "common/config.js";
 import { Modules } from "common/modules.js";
-
-export type AuditLogEntry = {
-  module: Modules;
-  actor: string;
-  target: string;
-  requestId?: string;
-  message: string;
-};
+import { AuditLogEntry } from "common/types/logs.js";
 
 type AuditLogParams = {
   dynamoClient?: DynamoDBClient;

src/api/index.ts

@@ -29,6 +29,18 @@ import membershipPlugin from "./routes/membership.js";
 import path from "path"; // eslint-disable-line import/no-nodejs-modules
 import roomRequestRoutes from "./routes/roomRequests.js";
 import logsPlugin from "./routes/logs.js";
+import fastifySwagger from "@fastify/swagger";
+import fastifySwaggerUI from "@fastify/swagger-ui";
+import {
+  type FastifyZodOpenApiSchema,
+  type FastifyZodOpenApiTypeProvider,
+  fastifyZodOpenApiPlugin,
+  fastifyZodOpenApiTransform,
+  fastifyZodOpenApiTransformObject,
+  serializerCompiler,
+  validatorCompiler,
+} from "fastify-zod-openapi";
+import { ZodOpenApiVersion } from "zod-openapi";
 
 dotenv.config();
 
@@ -85,6 +97,21 @@ async function init(prettyPrint: boolean = false) {
   await app.register(fastifyZodValidationPlugin);
   await app.register(FastifyAuthProvider);
   await app.register(errorHandlerPlugin);
+  await app.register(fastifyZodOpenApiPlugin);
+  await app.register(fastifySwagger, {
+    openapi: {
+      info: {
+        title: "ACM @ UIUC Core API",
+        version: "1.0.0",
+      },
+      openapi: "3.0.3" satisfies ZodOpenApiVersion, // If this is not specified, it will default to 3.1.0
+    },
+    transform: fastifyZodOpenApiTransform,
+    transformObject: fastifyZodOpenApiTransformObject,
+  });
+  await app.register(fastifySwaggerUI, {
+    routePrefix: "/api/documentation",
+  });
   await app.register(fastifyStatic, {
     root: path.join(__dirname, "public"),
     prefix: "/",

src/api/package.json

@@ -29,6 +29,8 @@
     "@fastify/caching": "^9.0.1",
     "@fastify/cors": "^10.0.1",
     "@fastify/static": "^8.1.1",
+    "@fastify/swagger": "^9.5.0",
+    "@fastify/swagger-ui": "^5.2.2",
     "@middy/core": "^6.0.0",
     "@middy/event-normalizer": "^6.0.0",
     "@middy/sqs-partial-batch-failure": "^6.0.0",
@@ -40,6 +42,7 @@
     "fastify": "^5.1.0",
     "fastify-plugin": "^4.5.1",
     "fastify-raw-body": "^5.0.0",
+    "fastify-zod-openapi": "^4.1.1",
     "ical-generator": "^7.2.0",
     "jsonwebtoken": "^9.0.2",
     "jwks-rsa": "^3.1.0",
@@ -53,6 +56,7 @@
     "stripe": "^17.6.0",
     "uuid": "^11.0.5",
     "zod": "^3.23.8",
+    "zod-openapi": "^4.2.4",
     "zod-to-json-schema": "^3.23.2",
     "zod-validation-error": "^3.3.1"
   },

src/api/routes/events.ts

@@ -1,3 +1,4 @@
+import "zod-openapi/extend";
 import { FastifyPluginAsync, FastifyRequest } from "fastify";
 import { AppRoles } from "../../common/roles.js";
 import { z } from "zod";
@@ -32,6 +33,14 @@ import {
 } from "api/functions/cache.js";
 import { createAuditLogEntry } from "api/functions/auditLog.js";
 import { Modules } from "common/modules.js";
+import {
+  FastifyPluginAsyncZodOpenApi,
+  FastifyZodOpenApiSchema,
+  FastifyZodOpenApiTypeProvider,
+  serializerCompiler,
+  validatorCompiler,
+} from "fastify-zod-openapi";
+import { ts, withTags } from "api/components/index.js";
 
 const repeatOptions = ["weekly", "biweekly"] as const;
 export const CLIENT_HTTP_CACHE_POLICY = `public, max-age=${EVENT_CACHED_DURATION}, stale-while-revalidate=420, stale-if-error=3600`;
@@ -54,77 +63,57 @@ const requestSchema = baseSchema.extend({
   repeatEnds: z.string().optional(),
 });
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 const postRequestSchema = requestSchema.refine(
   (data) => (data.repeatEnds ? data.repeats !== undefined : true),
   {
     message: "repeats is required when repeatEnds is defined",
   },
 );
-
 export type EventPostRequest = z.infer<typeof postRequestSchema>;
-type EventGetRequest = {
-  Params: { id: string };
-  Querystring: { ts?: number };
-  Body: undefined;
-};
-
-type EventDeleteRequest = {
-  Params: { id: string };
-  Querystring: undefined;
-  Body: undefined;
-};
-
-const responseJsonSchema = zodToJsonSchema(
-  z.object({
-    id: z.string(),
-    resource: z.string(),
-  }),
-);
 
-// GET
 const getEventSchema = requestSchema.extend({
   id: z.string(),
 });
-
 export type EventGetResponse = z.infer<typeof getEventSchema>;
-const getEventJsonSchema = zodToJsonSchema(getEventSchema);
 
 const getEventsSchema = z.array(getEventSchema);
 export type EventsGetResponse = z.infer<typeof getEventsSchema>;
-type EventsGetRequest = {
-  Body: undefined;
-  Querystring?: {
-    upcomingOnly?: boolean;
-    featuredOnly?: boolean;
-    host?: string;
-    ts?: number;
-  };
-};
 
-const eventsPlugin: FastifyPluginAsync = async (fastify, _options) => {
+const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
+  fastify,
+  _options,
+) => {
+  fastify.setValidatorCompiler(validatorCompiler);
+  fastify.setSerializerCompiler(serializerCompiler);
   const limitedRoutes: FastifyPluginAsync = async (fastify) => {
     fastify.register(rateLimiter, {
       limit: 30,
       duration: 60,
       rateLimitIdentifier: "events",
     });
-    fastify.get<EventsGetRequest>(
+    fastify.withTypeProvider<FastifyZodOpenApiTypeProvider>().get(
       "/",
       {
-        schema: {
-          querystring: {
-            type: "object",
-            properties: {
-              upcomingOnly: { type: "boolean" },
-              host: { type: "string" },
-              ts: { type: "number" },
-            },
-          },
+        schema: withTags(["Events"], {
+          querystring: z.object({
+            upcomingOnly: z.coerce.boolean().optional().openapi({
+              description:
+                "If true, only get events which end after the current time.",
+            }),
+            featuredOnly: z.coerce.boolean().optional().openapi({
+              description:
+                "If true, only get events which are marked as featured.",
+            }),
+            host: z
+              .enum(OrganizationList as [string, ...string[]])
+              .optional()
+              .openapi({ description: "Event host filter." }),
+            ts,
+          }),
           response: { 200: getEventsSchema },
-        },
+        }),
       },
-      async (request: FastifyRequest<EventsGetRequest>, reply) => {
+      async (request, reply) => {
         const upcomingOnly = request.query?.upcomingOnly || false;
         const featuredOnly = request.query?.featuredOnly || false;
         const host = request.query?.host;
@@ -230,15 +219,18 @@ const eventsPlugin: FastifyPluginAsync = async (fastify, _options) => {
     );
   };
 
-  fastify.post<{ Body: EventPostRequest }>(
+  fastify.withTypeProvider<FastifyZodOpenApiTypeProvider>().post(
     "/:id?",
     {
-      schema: {
-        response: { 201: responseJsonSchema },
-      },
-      preValidation: async (request, reply) => {
-        await fastify.zodValidateBody(request, reply, postRequestSchema);
-      },
+      schema: withTags(["Events"], {
+        response: {
+          201: z.object({
+            id: z.string(),
+            resource: z.string(),
+          }),
+        },
+        body: postRequestSchema,
+      }) satisfies FastifyZodOpenApiSchema,
       onRequest: async (request, reply) => {
         await fastify.authorize(request, reply, [AppRoles.EVENTS_MANAGER]);
       },
@@ -361,17 +353,28 @@ const eventsPlugin: FastifyPluginAsync = async (fastify, _options) => {
       }
     },
   );
-  fastify.delete<EventDeleteRequest>(
+  fastify.withTypeProvider<FastifyZodOpenApiTypeProvider>().delete(
     "/:id",
     {
-      schema: {
-        response: { 201: responseJsonSchema },
-      },
+      schema: withTags(["Events"], {
+        params: z.object({
+          id: z.string().min(1).openapi({
+            description: "Event ID to delete.",
+            example: "6667e095-8b04-4877-b361-f636f459ba42",
+          }),
+        }),
+        response: {
+          201: z.object({
+            id: z.string(),
+            resource: z.string(),
+          }),
+        },
+      }) satisfies FastifyZodOpenApiSchema,
       onRequest: async (request, reply) => {
         await fastify.authorize(request, reply, [AppRoles.EVENTS_MANAGER]);
       },
     },
-    async (request: FastifyRequest<EventDeleteRequest>, reply) => {
+    async (request, reply) => {
       const id = request.params.id;
       if (!request.username) {
         throw new UnauthenticatedError({ message: "Username not found." });
@@ -421,20 +424,23 @@ const eventsPlugin: FastifyPluginAsync = async (fastify, _options) => {
       );
     },
   );
-  fastify.get<EventGetRequest>(
+  fastify.withTypeProvider<FastifyZodOpenApiTypeProvider>().get(
     "/:id",
     {
-      schema: {
-        querystring: {
-          type: "object",
-          properties: {
-            ts: { type: "number" },
-          },
-        },
-        response: { 200: getEventJsonSchema },
-      },
+      schema: withTags(["Events"], {
+        params: z.object({
+          id: z.string().min(1).openapi({
+            description: "Event ID to delete.",
+            example: "6667e095-8b04-4877-b361-f636f459ba42",
+          }),
+        }),
+        querystring: z.object({
+          ts,
+        }),
+        response: { 200: getEventSchema },
+      }),
     },
-    async (request: FastifyRequest<EventGetRequest>, reply) => {
+    async (request, reply) => {
       const id = request.params.id;
       const ts = request.query?.ts;
 
@@ -485,7 +491,7 @@ const eventsPlugin: FastifyPluginAsync = async (fastify, _options) => {
           reply.header("etag", etag);
         }
 
-        return reply.send(item);
+        return reply.send(item as z.infer<typeof getEventSchema>);
       } catch (e) {
         if (e instanceof BaseError) {
           throw e;