trying generate openapi spec

.gitignore

@@ -73,3 +73,6 @@ apps/alerting-engine/tmp/
 # UI Registry build output
 apps/web/public/r
 packages/ui/public/r
+# For vibing
+research.md
+plan.md

apps/docs/astro.config.mjs

@@ -156,13 +156,21 @@ export default defineConfig({
               slug: "reference/cli-reference",
             },
             {
-              label: "API Reference",
+              label: "API Reference V1 - Deprecated",
               link: "https://api.openstatus.dev/v1",
               // badge: { text: 'External' },
               attrs: {
                 target: "_blank",
               },
             },
+            {
+              label: "API Reference V2",
+              link: "https://api.openstatus.dev/openapi",
+              // badge: { text: 'External' },
+              attrs: {
+                target: "_blank",
+              },
+            },
             {
               label: "DNS Monitor",
               slug: "reference/dns-monitor",

apps/server/src/index.ts

@@ -15,8 +15,11 @@ import { showRoutes } from "hono/dev";
 
 import { resourceFromAttributes } from "@opentelemetry/resources";
 import { ATTR_DEPLOYMENT_ENVIRONMENT_NAME } from "@opentelemetry/semantic-conventions/incubating";
+import { Scalar } from "@scalar/hono-api-reference";
 import { prettyJSON } from "hono/pretty-json";
 import { requestId } from "hono/request-id";
+import openapiV1Json from "../static/openapi-v1.json" with { type: "json" };
+import openapiYaml from "../static/openapi.yaml" with { type: "text" };
 import { env } from "./env";
 import { handleError } from "./libs/errors";
 import { publicRoute } from "./routes/public";
@@ -173,6 +176,7 @@ app.onError(handleError);
 /**
  * ConnectRPC Routes API v2 ftw
  */
+
 mountRpcRoutes(app);
 
 /**
@@ -190,6 +194,41 @@ app.get("/ping", (c) => {
   );
 });
 
+app.get("/openapi.yaml", (c) => {
+  return c.text(openapiYaml, 200, { "Content-Type": "application/yaml" });
+});
+app.get("/openapi-v1.json", (c) => {
+  return c.text(JSON.stringify(openapiV1Json), 200, {
+    "Content-Type": "application/json",
+  });
+});
+
+app.get(
+  "/openapi",
+  Scalar({
+    url: "/openapi.yaml",
+    servers: [
+      {
+        url: "https://api.openstatus.dev/",
+        description: "Production server",
+      },
+      {
+        url: "http://localhost:3000/",
+        description: "Dev server",
+      },
+    ],
+    metaData: {
+      title: "OpenStatus API",
+      description: "Start building with OpenStatus API",
+      ogDescription: "API Reference",
+      ogTitle: "OpenStatus API",
+      ogImage:
+        "https://openstatus.dev/api/og?title=OpenStatus%20API&description=API%20Reference",
+      twitterCard: "summary_large_image",
+    },
+  }),
+);
+
 /**
  * API Routes v1
  */

apps/server/src/routes/v1/index.ts

@@ -43,8 +43,7 @@ api.doc("/openapi", {
       email: "[email protected]",
       url: "https://www.openstatus.dev",
     },
-    description:
-      "OpenStatus is a open-source synthetic monitoring tool that allows you to monitor your website and API's uptime, latency, and more. \n\n The OpenStatus API allows you to interact with the OpenStatus platform programmatically. \n\n To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings.",
+    description: "This version is deprecated please use v2",
   },
   tags: [
     {
@@ -108,7 +107,7 @@ api.doc("/openapi", {
 api.get(
   "/",
   Scalar({
-    url: "/v1/openapi",
+    url: "/openapi-v1.json",
     servers: [
       {
         url: "https://api.openstatus.dev/v1",