move openapi out of src dir
Adapted from #3579 by @gorkem-bwl. The openapi/registry, helpers, and per-resource routes/* files are largely their work; this commit relocates the directory out of src/ so the build-time generator code is not emitted into dist/, and shifts spec generation from runtime to a build step. Co-authored-by: gorkem-bwl <gorkem.cetin@bluewavelabs.ca>
This commit is contained in:
1 parent
28baeaf218
commit
3f9019f34c
22 files changed
+11259
-3944
No files matched your search
@@ -0,0 +1,247 @@
|
||||
import { z } from "zod";
|
||||
import { registry } from "../registry.js";
|
||||
import { bearer, json, okJson, okJsonNoData, okUnknown, standardErrors } from "../helpers.js";
|
||||
import { GeoContinents } from "@/types/geoCheck.js";
|
||||
import { MonitorMatchMethods, MonitorTypes } from "@/types/monitor.js";
|
||||
import {
|
||||
getMonitorByIdParamValidation,
|
||||
getMonitorByIdQueryValidation,
|
||||
getMonitorsByTeamIdQueryValidation,
|
||||
getMonitorsWithChecksQueryValidation,
|
||||
getCertificateParamValidation,
|
||||
createMonitorBodyValidation,
|
||||
editMonitorBodyValidation,
|
||||
pauseMonitorParamValidation,
|
||||
getUptimeDetailsByIdParamValidation,
|
||||
getUptimeDetailsByIdQueryValidation,
|
||||
importMonitorsBodyValidation,
|
||||
getHardwareDetailsByIdParamValidation,
|
||||
getHardwareDetailsByIdQueryValidation,
|
||||
} from "@/validation/monitorValidation.js";
|
||||
import { updateNotificationsValidation } from "@/validation/notificationValidation.js";
|
||||
|
||||
const tags = ["monitors"];
|
||||
|
||||
const monitorObject = z
|
||||
.object({
|
||||
_id: z.string().openapi({ example: "65f1c2a4d8b9e0123456789a" }),
|
||||
name: z.string().openapi({ example: "Marketing site" }),
|
||||
description: z.string().optional().openapi({ example: "Production marketing site monitored from the EU region" }),
|
||||
type: z.enum(MonitorTypes).openapi({ example: "http" }),
|
||||
url: z.string().openapi({ example: "https://www.example.com" }),
|
||||
port: z.number().optional().openapi({ example: 443 }),
|
||||
isActive: z.boolean().openapi({ example: true }),
|
||||
interval: z.number().openapi({ example: 60000 }),
|
||||
status: z.enum(["up", "down", "paused", "initializing", "maintenance", "breached"]).openapi({ example: "up" }),
|
||||
statusWindowSize: z.number().openapi({ example: 5 }),
|
||||
statusWindowThreshold: z.number().openapi({ example: 3 }),
|
||||
ignoreTlsErrors: z.boolean().openapi({ example: false }),
|
||||
useAdvancedMatching: z.boolean().openapi({ example: false }),
|
||||
jsonPath: z.string().optional(),
|
||||
expectedValue: z.string().optional(),
|
||||
matchMethod: z.enum(MonitorMatchMethods).optional(),
|
||||
notifications: z.array(z.string()).openapi({ example: ["65f1c2a4d8b9e0123456789b"] }),
|
||||
secret: z.string().optional(),
|
||||
cpuAlertThreshold: z.number().openapi({ example: 90 }),
|
||||
memoryAlertThreshold: z.number().openapi({ example: 90 }),
|
||||
diskAlertThreshold: z.number().openapi({ example: 90 }),
|
||||
tempAlertThreshold: z.number().openapi({ example: 80 }),
|
||||
selectedDisks: z.array(z.string()).openapi({ example: [] }),
|
||||
gameId: z.string().optional(),
|
||||
grpcServiceName: z.string().optional(),
|
||||
group: z.string().nullable().optional(),
|
||||
geoCheckEnabled: z.boolean().openapi({ example: false }),
|
||||
geoCheckLocations: z.array(z.enum(GeoContinents)).openapi({ example: [] }),
|
||||
geoCheckInterval: z.number().openapi({ example: 300000 }),
|
||||
teamId: z.string().openapi({ example: "65f1c2a4d8b9e01234567890" }),
|
||||
userId: z.string().openapi({ example: "65f1c2a4d8b9e01234567891" }),
|
||||
createdAt: z.string().openapi({ example: "2026-04-01T10:00:00.000Z" }),
|
||||
updatedAt: z.string().openapi({ example: "2026-04-15T14:30:00.000Z" }),
|
||||
})
|
||||
.passthrough()
|
||||
.openapi("Monitor");
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/team",
|
||||
tags,
|
||||
summary: "List monitors for the caller's team",
|
||||
security: bearer,
|
||||
request: { query: getMonitorsByTeamIdQueryValidation },
|
||||
responses: { "200": okJson(z.array(monitorObject)), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/team/with-checks",
|
||||
tags,
|
||||
summary: "List team monitors with their most recent checks (paginated)",
|
||||
security: bearer,
|
||||
request: { query: getMonitorsWithChecksQueryValidation },
|
||||
responses: { "200": okUnknown, ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/team/groups",
|
||||
tags,
|
||||
summary: "List monitor groups for the caller's team",
|
||||
security: bearer,
|
||||
responses: { "200": okJson(z.array(z.string())), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/uptime/details/{monitorId}",
|
||||
tags,
|
||||
summary: "Get uptime details for a monitor",
|
||||
security: bearer,
|
||||
request: { params: getUptimeDetailsByIdParamValidation, query: getUptimeDetailsByIdQueryValidation },
|
||||
responses: { "200": okUnknown, ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/hardware/details/{monitorId}",
|
||||
tags,
|
||||
summary: "Get hardware metrics detail for a monitor",
|
||||
security: bearer,
|
||||
request: { params: getHardwareDetailsByIdParamValidation, query: getHardwareDetailsByIdQueryValidation },
|
||||
responses: { "200": okUnknown, ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/pagespeed/details/{monitorId}",
|
||||
tags,
|
||||
summary: "Get PageSpeed detail for a monitor",
|
||||
security: bearer,
|
||||
request: { params: getHardwareDetailsByIdParamValidation, query: getHardwareDetailsByIdQueryValidation },
|
||||
responses: { "200": okUnknown, ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/{monitorId}/geo-checks",
|
||||
tags,
|
||||
summary: "Get geo check results for a monitor",
|
||||
security: bearer,
|
||||
request: { params: getMonitorByIdParamValidation, query: getMonitorByIdQueryValidation },
|
||||
responses: { "200": okUnknown, ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "post",
|
||||
path: "/monitors/pause/{monitorId}",
|
||||
tags,
|
||||
summary: "Toggle pause state for a monitor",
|
||||
security: bearer,
|
||||
request: { params: pauseMonitorParamValidation },
|
||||
responses: { "200": okJson(monitorObject), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/certificate/{monitorId}",
|
||||
tags,
|
||||
summary: "Get SSL certificate info for a monitor",
|
||||
security: bearer,
|
||||
request: { params: getCertificateParamValidation },
|
||||
responses: { "200": okJson(z.object({ certificateDate: z.string() })), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "patch",
|
||||
path: "/monitors/notifications",
|
||||
tags,
|
||||
summary: "Bulk update notifications across monitors",
|
||||
security: bearer,
|
||||
request: { body: { content: json(updateNotificationsValidation) } },
|
||||
responses: { "200": okJson(z.object({ modifiedCount: z.number() })), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "post",
|
||||
path: "/monitors",
|
||||
tags,
|
||||
summary: "Create a new monitor",
|
||||
security: bearer,
|
||||
request: { body: { content: json(createMonitorBodyValidation) } },
|
||||
responses: { "200": okJson(monitorObject, "Monitor created"), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "delete",
|
||||
path: "/monitors",
|
||||
tags,
|
||||
summary: "Delete every monitor (superadmin only)",
|
||||
security: bearer,
|
||||
responses: { "200": okJsonNoData(), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "post",
|
||||
path: "/monitors/demo",
|
||||
tags,
|
||||
summary: "Insert preconfigured demo monitors",
|
||||
security: bearer,
|
||||
responses: { "200": okJson(z.number()), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/export/json",
|
||||
tags,
|
||||
summary: "Export all team monitors as JSON",
|
||||
security: bearer,
|
||||
responses: { "200": okUnknown, ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "post",
|
||||
path: "/monitors/import/json",
|
||||
tags,
|
||||
summary: "Import monitors from JSON",
|
||||
security: bearer,
|
||||
request: { body: { content: json(importMonitorsBodyValidation) } },
|
||||
responses: { "200": okJson(z.object({ imported: z.number() }).passthrough()), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/games",
|
||||
tags,
|
||||
summary: "List supported game-server types",
|
||||
security: bearer,
|
||||
responses: { "200": okJson(z.array(z.string())), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "get",
|
||||
path: "/monitors/{monitorId}",
|
||||
tags,
|
||||
summary: "Get a monitor by id",
|
||||
security: bearer,
|
||||
request: { params: getMonitorByIdParamValidation },
|
||||
responses: { "200": okJson(monitorObject), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "patch",
|
||||
path: "/monitors/{monitorId}",
|
||||
tags,
|
||||
summary: "Edit a monitor",
|
||||
security: bearer,
|
||||
request: { params: getMonitorByIdParamValidation, body: { content: json(editMonitorBodyValidation) } },
|
||||
responses: { "200": okJson(monitorObject), ...standardErrors },
|
||||
});
|
||||
|
||||
registry.registerPath({
|
||||
method: "delete",
|
||||
path: "/monitors/{monitorId}",
|
||||
tags,
|
||||
summary: "Delete a monitor",
|
||||
security: bearer,
|
||||
request: { params: getMonitorByIdParamValidation },
|
||||
responses: { "200": okJson(monitorObject), ...standardErrors },
|
||||
});
|
||||
Reference in new issue
Block a user