Cleanup

Author: aklinker1

src/apis/extension-store-apis.ts

@@ -3,15 +3,16 @@ import { z } from "zod";
 import { contextPlugin } from "../plugins/context-plugin";
 import { NotFoundHttpError } from "@aklinker1/zeta";
 import { HttpStatus } from "@aklinker1/zeta";
-import { ExtensionStoreName } from "../enums";
+import { ExtensionStoreName, OpenApiTag } from "../enums";
 
-export const extensionStoreApis = createApp()
+export const extensionStoreApis = createApp({
+  tags: [OpenApiTag.ExtensionStores],
+})
   .use(contextPlugin)
   .get(
     "/api/rest/:storeName/:id/screenshots/:index",
     {
       operationId: "redirectToScreenshot",
-      tags: ["Chrome Extensions"],
       description:
         "Redirect to a screenshot's URL from the Chrome Web Store listing",
       params: z.object({

src/apis/graphql-apis.ts

@@ -4,6 +4,7 @@ import { version } from "../../package.json";
 import { createGraphql } from "../graphql";
 import { z } from "zod";
 import dedent from "dedent";
+import { OpenApiTag } from "../enums";
 
 const PLAYGROUND_HTML = (PLAYGROUND_HTML_TEMPLATE as any as string).replace(
   "{{VERSION}}",
@@ -12,12 +13,13 @@ const PLAYGROUND_HTML = (PLAYGROUND_HTML_TEMPLATE as any as string).replace(
 
 const graphql = createGraphql();
 
-export const graphqlApis = createApp()
+export const graphqlApis = createApp({
+  tags: [OpenApiTag.Graphql],
+})
   .post(
     "/api",
     {
       summary: "Send Query",
-      tags: ["GraphQL"],
       description:
         "Send a query to the GraphQL API. You can play around with queries on the [GraphiQL playground](/playground).",
       body: z
@@ -73,7 +75,6 @@ export const graphqlApis = createApp()
     "/playground",
     {
       operationId: "playground",
-      tags: ["GraphQL"],
       description: dedent`
         Open the GraphiQL playground. This is where you can interact and test out
         the GraphQL API. It also contains the GraphQL documentation explorer.

src/apis/system-apis.ts

@@ -2,12 +2,14 @@ import { createApp } from "@aklinker1/zeta";
 import z from "zod";
 import { version } from "../version";
 
-export const systemApis = createApp()
+export const systemApis = createApp({
+  tags: ["System"],
+})
   .get(
     "/",
     {
+      operationId: "apiDocsRedirect",
       summary: "API Docs Redirect",
-      tags: ["System"],
       description: "Redirect to the API reference when visiting the root URL.",
     },
     ({ set }) => {
@@ -18,8 +20,7 @@ export const systemApis = createApp()
   .get(
     "/api/health",
     {
-      summary: "Health Check",
-      tags: ["System"],
+      operationId: "healthCheck",
       description: "Used to make sure the API is up and running.",
       responses: z.object({
         status: z.literal("ok"),

src/enums.ts

@@ -1,11 +1,18 @@
 export enum ExtensionStoreName {
+  ChromeWebStore = "chrome-web-store",
+  FirefoxAddonStore = "firefox-addon-store",
+  EdgeAddonStore = "edge-addon-store",
+
   /** @deprecated Use {@link ChromeWebStore} instead. */
   ChromeExtensions = "chrome-extensions",
-  ChromeWebStore = "chrome-web-store",
   /** @deprecated Use {@link FirefoxAddonStore} instead. */
   FirefoxExtensions = "firefox-extensions",
-  FirefoxAddonStore = "firefox-addon-store",
   /** @deprecated Use {@link EdgeAddonStore} instead. */
   EdgeExtensions = "edge-extensions",
-  EdgeAddonStore = "edge-addon-store",
+}
+
+export enum OpenApiTag {
+  System = "System",
+  ExtensionStores = "Extension Stores",
+  Graphql = "GraphQL",
 }

src/models.ts

@@ -0,0 +1,6 @@
+import z from "zod";
+import { ExtensionStoreName } from "./enums";
+
+export const ExtensionStoreNameSchema = z
+  .enum(ExtensionStoreName)
+  .meta({ ref: "ExtensionStoreName" });

src/server.ts

@@ -7,6 +7,7 @@ import { zodSchemaAdapter } from "@aklinker1/zeta/adapters/zod-schema-adapter";
 import { version } from "./version";
 import dedent from "dedent";
 import { systemApis } from "./apis/system-apis";
+import { OpenApiTag } from "./enums";
 
 const app = createApp({
   schemaAdapter: zodSchemaAdapter,
@@ -35,15 +36,14 @@ const app = createApp({
     },
     tags: [
       {
-        name: "GraphQL",
+        name: OpenApiTag.Graphql,
         description: dedent`
           To play around with the GraphQL API, checkout the
           [GraphiQL Playground](/playground).
         `,
       },
-      { name: "Chrome Extensions" },
-      { name: "Firefox Addons" },
-      { name: "System" },
+      { name: OpenApiTag.ExtensionStores },
+      { name: OpenApiTag.System },
     ],
   },
 })