update docs

Author: devksingh4

src/api/index.ts

@@ -100,6 +100,12 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
       return event.requestContext.requestId;
     },
   });
+  if (!process.env.RunEnvironment) {
+    process.env.RunEnvironment = "dev";
+  }
+  app.runEnvironment = process.env.RunEnvironment as RunEnvironment;
+  app.environmentConfig =
+    environmentConfig[app.runEnvironment as RunEnvironment];
   app.setValidatorCompiler(validatorCompiler);
   app.setSerializerCompiler(serializerCompiler);
 
@@ -111,8 +117,9 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
         openapi: {
           info: {
             title: "ACM @ UIUC Core API",
-            description: "ACM @ UIUC Core Management Platform",
-            version: "1.0.0",
+            description:
+              "The ACM @ UIUC Core API provides services for managing chapter operations.",
+            version: "1.1.0",
             contact: {
               name: "ACM @ UIUC Infrastructure Team",
               email: "[email protected]",
@@ -127,12 +134,8 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
           },
           servers: [
             {
-              url: "https://core.acm.illinois.edu",
-              description: "Production API server",
-            },
-            {
-              url: "https://core.aws.qa.acmuiuc.org",
-              description: "QA API server",
+              url: app.environmentConfig.UserFacingUrl,
+              description: "Main API server",
             },
           ],
 
@@ -215,6 +218,7 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
       });
       isSwaggerServer = true;
     } catch (e) {
+      app.log.error(e);
       app.log.warn("Fastify Swagger not created!");
     }
   }
@@ -229,9 +233,6 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
     root: path.join(__dirname, "public"),
     prefix: "/",
   });
-  if (!process.env.RunEnvironment) {
-    process.env.RunEnvironment = "dev";
-  }
   if (isRunningInLambda && !isSwaggerServer) {
     // Serve docs from S3
     app.get("/api/documentation", (_request, response) => {
@@ -264,9 +265,6 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
       "Audit logging to Dynamo is disabled! Audit log statements will be logged to the console.",
     );
   }
-  app.runEnvironment = process.env.RunEnvironment as RunEnvironment;
-  app.environmentConfig =
-    environmentConfig[app.runEnvironment as RunEnvironment];
   app.nodeCache = new NodeCache({ checkperiod: 30 });
   if (initClients) {
     app.dynamoClient = new DynamoDBClient({

src/api/routes/events.ts

@@ -473,6 +473,11 @@ const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
         withTags(["Events"], {
           body: postRequestSchema,
           summary: "Create a calendar event.",
+          response: {
+            201: {
+              description: "New event created.",
+            },
+          },
         }),
       ) satisfies FastifyZodOpenApiSchema,
       onRequest: fastify.authorizeFromSchema,
@@ -583,12 +588,11 @@ const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
               example: "6667e095-8b04-4877-b361-f636f459ba42",
             }),
           }),
-          // response: {
-          //   201: z.object({
-          //     id: z.string(),
-          //     resource: z.string(),
-          //   }),
-          // },
+          response: {
+            204: {
+              description: "Event deleted.",
+            },
+          },
           summary: "Delete a calendar event.",
         }),
       ) satisfies FastifyZodOpenApiSchema,
@@ -690,7 +694,14 @@ const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
           includeMetadata: zodIncludeMetadata,
         }),
         summary: "Retrieve a calendar event.",
-        // response: { 200: getEventSchema },
+        response: {
+          200: {
+            description: "Data from a calendar event.",
+            content: {
+              "application/json": { schema: postRequestSchema },
+            },
+          },
+        },
       }),
     },
     async (request, reply) => {

src/api/routes/linkry.ts

@@ -82,7 +82,9 @@ const linkryRoutes: FastifyPluginAsync = async (fastify, _options) => {
       {
         schema: withRoles(
           [AppRoles.LINKS_MANAGER, AppRoles.LINKS_ADMIN],
-          withTags(["Linkry"], {}),
+          withTags(["Linkry"], {
+            summary: "Get all short links that a user can manage.",
+          }),
         ),
         onRequest: fastify.authorizeFromSchema,
       },
@@ -178,6 +180,7 @@ const linkryRoutes: FastifyPluginAsync = async (fastify, _options) => {
           [AppRoles.LINKS_MANAGER, AppRoles.LINKS_ADMIN],
           withTags(["Linkry"], {
             body: createRequest,
+            summary: "Create a short link for a long URL.",
           }),
         ),
         preValidation: async (request, reply) => {
@@ -463,6 +466,7 @@ const linkryRoutes: FastifyPluginAsync = async (fastify, _options) => {
             params: z.object({
               slug: linkrySlug,
             }),
+            summary: "Get short link information.",
           }),
         ),
         onRequest: fastify.authorizeFromSchema,
@@ -515,6 +519,7 @@ const linkryRoutes: FastifyPluginAsync = async (fastify, _options) => {
             params: z.object({
               slug: linkrySlug,
             }),
+            summary: "Delete a short link.",
           }),
         ),
         onRequest: async (request, reply) => {

src/api/routes/organizations.ts

@@ -3,6 +3,7 @@ import { AllOrganizationList } from "@acm-uiuc/js-shared";
 import fastifyCaching from "@fastify/caching";
 import rateLimiter from "api/plugins/rateLimiter.js";
 import { withTags } from "api/components/index.js";
+import * as z from "zod/v4";
 
 const organizationsPlugin: FastifyPluginAsync = async (fastify, _options) => {
   fastify.register(fastifyCaching, {
@@ -20,6 +21,11 @@ const organizationsPlugin: FastifyPluginAsync = async (fastify, _options) => {
     {
       schema: withTags(["Generic"], {
         summary: "Get a list of ACM @ UIUC sub-organizations.",
+        response: {
+          200: z.array(z.enum(AllOrganizationList)).meta({
+            example: JSON.stringify(AllOrganizationList),
+          }),
+        },
       }),
     },
     async (_request, reply) => {