Skip to content

Open-source status page, incident response and uptime monitoring

openApi spec routes (#1244)

Abhishek0a32aa13e6e7
diff --git a/apps/server/src/routes/v1/incidents/get.ts b/apps/server/src/routes/v1/incidents/get.ts
index 871c0489e..43c48e17d 100644
--- a/apps/server/src/routes/v1/incidents/get.ts
+++ b/apps/server/src/routes/v1/incidents/get.ts
@@ -11,7 +11,7 @@ const getRoute = createRoute({
method: "get",
tags: ["incident"],
summary: "Get an incident",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/incidents/put.ts b/apps/server/src/routes/v1/incidents/put.ts
index 3ef575305..eeafa70c1 100644
--- a/apps/server/src/routes/v1/incidents/put.ts
+++ b/apps/server/src/routes/v1/incidents/put.ts
@@ -14,7 +14,7 @@ const putRoute = createRoute({
tags: ["incident"],
summary: "Update an incident",
description: "Acknowledge or resolve an incident",
- path: "/:id",
+ path: "/{id}",
middleware: [trackMiddleware(Events.UpdateIncident)],
request: {
params: ParamsSchema,
diff --git a/apps/server/src/routes/v1/maintenances/get.ts b/apps/server/src/routes/v1/maintenances/get.ts
index 17f0846e3..31f0b9418 100644
--- a/apps/server/src/routes/v1/maintenances/get.ts
+++ b/apps/server/src/routes/v1/maintenances/get.ts
@@ -9,7 +9,7 @@ const getRoute = createRoute({
method: "get",
tags: ["maintenance"],
summary: "Get a maintenance",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/maintenances/put.ts b/apps/server/src/routes/v1/maintenances/put.ts
index 3352e9dc9..4018756e5 100644
--- a/apps/server/src/routes/v1/maintenances/put.ts
+++ b/apps/server/src/routes/v1/maintenances/put.ts
@@ -15,7 +15,7 @@ const putRoute = createRoute({
method: "put",
tags: ["maintenance"],
summary: "Update a maintenance",
- path: "/:id",
+ path: "/{id}",
middleware: [trackMiddleware(Events.UpdateMaintenance)],
request: {
params: ParamsSchema,
diff --git a/apps/server/src/routes/v1/monitors/delete.ts b/apps/server/src/routes/v1/monitors/delete.ts
index e31e6dc41..9a7e84d32 100644
--- a/apps/server/src/routes/v1/monitors/delete.ts
+++ b/apps/server/src/routes/v1/monitors/delete.ts
@@ -13,7 +13,7 @@ const deleteRoute = createRoute({
method: "delete",
tags: ["monitor"],
summary: "Delete a monitor",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/monitors/get.ts b/apps/server/src/routes/v1/monitors/get.ts
index d4af8ef43..2f3bfc03e 100644
--- a/apps/server/src/routes/v1/monitors/get.ts
+++ b/apps/server/src/routes/v1/monitors/get.ts
@@ -11,7 +11,7 @@ const getRoute = createRoute({
method: "get",
tags: ["monitor"],
summary: "Get a monitor",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/monitors/put.ts b/apps/server/src/routes/v1/monitors/put.ts
index 5ba8e6cb4..31c550734 100644
--- a/apps/server/src/routes/v1/monitors/put.ts
+++ b/apps/server/src/routes/v1/monitors/put.ts
@@ -15,7 +15,7 @@ const putRoute = createRoute({
method: "put",
tags: ["monitor"],
summary: "Update a monitor",
- path: "/:id",
+ path: "/{id}",
middleware: [trackMiddleware(Events.UpdateMonitor)],
request: {
params: ParamsSchema,
diff --git a/apps/server/src/routes/v1/monitors/results/get.ts b/apps/server/src/routes/v1/monitors/results/get.ts
index d442c6dad..230add001 100644
--- a/apps/server/src/routes/v1/monitors/results/get.ts
+++ b/apps/server/src/routes/v1/monitors/results/get.ts
@@ -18,7 +18,7 @@ const getRoute = createRoute({
// FIXME: Should work for all types of monitors
description:
"**WARNING:** This works only for HTTP monitors. We will add support for other types of monitors soon.",
- path: "/:id/result/:resultId",
+ path: "/{id}/result/{resultId}",
request: {
params: ParamsSchema.extend({
resultId: z.string().openapi({
diff --git a/apps/server/src/routes/v1/monitors/run/post.ts b/apps/server/src/routes/v1/monitors/run/post.ts
index 5f0ec03d2..a9eeaedb8 100644
--- a/apps/server/src/routes/v1/monitors/run/post.ts
+++ b/apps/server/src/routes/v1/monitors/run/post.ts
@@ -20,7 +20,7 @@ const postMonitor = createRoute({
summary: "Create a monitor run",
description:
"Run a synthetic check for a specific monitor. It will take all configs into account.",
- path: "/:id/run",
+ path: "/{id}/run",
request: {
params: ParamsSchema,
query: QuerySchema,
diff --git a/apps/server/src/routes/v1/monitors/summary/get.ts b/apps/server/src/routes/v1/monitors/summary/get.ts
index b2f82093f..48159b155 100644
--- a/apps/server/src/routes/v1/monitors/summary/get.ts
+++ b/apps/server/src/routes/v1/monitors/summary/get.ts
@@ -24,7 +24,7 @@ const getMonitorStats = createRoute({
summary: "Get a monitor summary",
description:
"Get a monitor summary of the last 45 days of data to be used within a status page",
- path: "/:id/summary",
+ path: "/{id}/summary",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/monitors/trigger/post.ts b/apps/server/src/routes/v1/monitors/trigger/post.ts
index 0e9a9cd5c..f7c289d3c 100644
--- a/apps/server/src/routes/v1/monitors/trigger/post.ts
+++ b/apps/server/src/routes/v1/monitors/trigger/post.ts
@@ -18,7 +18,7 @@ const postRoute = createRoute({
tags: ["monitor"],
summary: "Create a monitor trigger",
description: "Trigger a monitor check without waiting the result",
- path: "/:id/trigger",
+ path: "/{id}/trigger",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/notifications/get.ts b/apps/server/src/routes/v1/notifications/get.ts
index 6918af1b3..d4ee5135a 100644
--- a/apps/server/src/routes/v1/notifications/get.ts
+++ b/apps/server/src/routes/v1/notifications/get.ts
@@ -13,7 +13,7 @@ const getRoute = createRoute({
method: "get",
tags: ["notification"],
summary: "Get a notification",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/pageSubscribers/post.ts b/apps/server/src/routes/v1/pageSubscribers/post.ts
index 703bcdf5f..d89ff4ca9 100644
--- a/apps/server/src/routes/v1/pageSubscribers/post.ts
+++ b/apps/server/src/routes/v1/pageSubscribers/post.ts
@@ -14,7 +14,7 @@ const postRouteSubscriber = createRoute({
method: "post",
tags: ["page_subscriber"],
summary: "Subscribe to a status page",
- path: "/:id/update",
+ path: "/{id}/update",
middleware: [trackMiddleware(Events.SubscribePage)],
description: "Add a subscriber to a status page", // TODO: how to define legacy routes
request: {
diff --git a/apps/server/src/routes/v1/pages/get.ts b/apps/server/src/routes/v1/pages/get.ts
index cc3d5ff0c..c8225508e 100644
--- a/apps/server/src/routes/v1/pages/get.ts
+++ b/apps/server/src/routes/v1/pages/get.ts
@@ -11,7 +11,7 @@ const getRoute = createRoute({
method: "get",
tags: ["page"],
summary: "Get a status page",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/pages/put.ts b/apps/server/src/routes/v1/pages/put.ts
index 73756db90..f376dd7e0 100644
--- a/apps/server/src/routes/v1/pages/put.ts
+++ b/apps/server/src/routes/v1/pages/put.ts
@@ -19,7 +19,7 @@ const putRoute = createRoute({
method: "put",
tags: ["page"],
summary: "Update a status page",
- path: "/:id",
+ path: "/{id}",
middleware: [trackMiddleware(Events.UpdatePage)],
request: {
params: ParamsSchema,
diff --git a/apps/server/src/routes/v1/statusReportUpdates/get.ts b/apps/server/src/routes/v1/statusReportUpdates/get.ts
index 161101151..51b10ae61 100644
--- a/apps/server/src/routes/v1/statusReportUpdates/get.ts
+++ b/apps/server/src/routes/v1/statusReportUpdates/get.ts
@@ -11,7 +11,7 @@ const getRoute = createRoute({
method: "get",
tags: ["status_report_update"],
summary: "Get a status report update",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/statusReports/delete.ts b/apps/server/src/routes/v1/statusReports/delete.ts
index b9b0356e3..46eb0e06f 100644
--- a/apps/server/src/routes/v1/statusReports/delete.ts
+++ b/apps/server/src/routes/v1/statusReports/delete.ts
@@ -11,7 +11,7 @@ const deleteRoute = createRoute({
method: "delete",
tags: ["status_report"],
summary: "Delete a status report",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/statusReports/get.ts b/apps/server/src/routes/v1/statusReports/get.ts
index f3fca46d2..f8ecfab2f 100644
--- a/apps/server/src/routes/v1/statusReports/get.ts
+++ b/apps/server/src/routes/v1/statusReports/get.ts
@@ -11,7 +11,7 @@ const getRoute = createRoute({
method: "get",
tags: ["status_report"],
summary: "Get a status report",
- path: "/:id",
+ path: "/{id}",
request: {
params: ParamsSchema,
},
diff --git a/apps/server/src/routes/v1/statusReports/update/post.ts b/apps/server/src/routes/v1/statusReports/update/post.ts
index 5598b886c..80e8da123 100644
--- a/apps/server/src/routes/v1/statusReports/update/post.ts
+++ b/apps/server/src/routes/v1/statusReports/update/post.ts
@@ -20,7 +20,7 @@ const emailClient = new EmailClient({ apiKey: env.RESEND_API_KEY });
const postRouteUpdate = createRoute({
method: "post",
tags: ["status_report"],
- path: "/:id/update",
+ path: "/{id}/update",
summary: "Create a status report update",
deprecated: true,
description: