Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
bun drizzle-orm monitoring monitoring-as-code nextjs observability on-call open-source shadcn-ui status-page statuspage synthetic-monitoring tinybird turso uptime uptime-checker uptime-monitor
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091import { expect } from "@std/expect";import { describe, test } from "@std/testing/bdd";import { Hono } from "hono";import { parse as parseYaml } from "jsr:@std/yaml@^1.0.9";
import openapiV1Json from "../../static/openapi-v1.json" with { type: "json" };import openapiYaml from "../../static/openapi-yaml";import openapiJson from "../../static/openapi.json" with { type: "json" };import { openapiRoute } from "./openapi";import { api, openapiV1Config } from "./v1/index";
const app = new Hono().route("/", openapiRoute);
/** `prefault(new Date())` bakes the module load time into the spec, so date defaults never match. */function withoutDateDefaults(value: unknown): unknown { if (Array.isArray(value)) return value.map(withoutDateDefaults); if (value && typeof value === "object") { const out: Record<string, unknown> = {}; for (const [key, v] of Object.entries(value)) { if ( key === "default" && (value as { format?: string }).format === "date-time" ) continue; out[key] = withoutDateDefaults(v); } return out; } return value;}
describe("OpenAPI documents", () => { test("openapi.json is a faithful rendering of openapi.yaml", async () => { const yaml = parseYaml( await Deno.readTextFile( new URL("../../static/openapi.yaml", import.meta.url), ), ); expect(JSON.parse(JSON.stringify(openapiJson))).toEqual(yaml); });
test("the embedded YAML module matches openapi.yaml on disk", async () => { expect(openapiYaml).toBe( await Deno.readTextFile( new URL("../../static/openapi.yaml", import.meta.url), ), ); });
test("declares the production server so agents can resolve paths", () => { expect(openapiJson.servers).toEqual([ { url: "https://api.openstatus.dev", description: "Production" }, ]); });
test("GET /openapi.json serves a CORS-readable spec", async () => { const res = await app.request("/openapi.json"); expect(res.status).toBe(200); expect(res.headers.get("content-type")).toContain("application/json"); expect(res.headers.get("access-control-allow-origin")).toBe("*"); const body = await res.json(); expect(body.openapi).toBe("3.1.0"); expect(Object.keys(body.paths).length).toBeGreaterThan(0); expect(body.servers[0].url).toBe("https://api.openstatus.dev"); });
test("GET /openapi.yaml still serves YAML", async () => { const res = await app.request("/openapi.yaml"); expect(res.status).toBe(200); expect(res.headers.get("content-type")).toContain("application/yaml"); expect(await res.text()).toContain("openapi: 3.1.0"); });
test("openapi-v1.json matches the v1 routes (run `pnpm openapi:v1` after changing them)", () => { expect( withoutDateDefaults(JSON.parse(JSON.stringify(openapiV1Json))), ).toEqual( withoutDateDefaults( JSON.parse(JSON.stringify(api.getOpenAPIDocument(openapiV1Config))), ), ); });
test("GET /openapi-v1.json still serves the deprecated v1 spec", async () => { const res = await app.request("/openapi-v1.json"); expect(res.status).toBe(200); const body = await res.json(); expect(body.info.version).toBe("1.0.0"); });});