Skip to content

Open-source status page, incident response and uptime monitoring

🔥 improve api (#722)

Thibault Le Ouay7e713bc8a3eb
diff --git a/apps/docs/api-reference/notification/get-notification.mdx b/apps/docs/api-reference/notification/get-notification.mdx
new file mode 100644
index 000000000..6fad3b8c7
--- /dev/null
+++ b/apps/docs/api-reference/notification/get-notification.mdx
@@ -0,0 +1,4 @@
+---
+title: Get all notification
+openapi: get /notification/
+---
diff --git a/apps/docs/api-reference/page/get-page.mdx b/apps/docs/api-reference/page/get-page.mdx
new file mode 100644
index 000000000..598493324
--- /dev/null
+++ b/apps/docs/api-reference/page/get-page.mdx
@@ -0,0 +1,4 @@
+---
+title: Get all your Status Page
+openapi: get /page/
+---
diff --git a/apps/docs/api-reference/page/post-page:id/update.mdx b/apps/docs/api-reference/page/post-page:id/update.mdx
new file mode 100644
index 000000000..9dbba97ad
--- /dev/null
+++ b/apps/docs/api-reference/page/post-page:id/update.mdx
@@ -0,0 +1,4 @@
+---
+title: Add a subscriber
+openapi: post /page/:id/update
+---
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index 9cf8393d3..417ce4c92 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -142,6 +142,7 @@
{
"group": "Notification",
"pages": [
+ "api-reference/notification/get-notification",
"api-reference/notification/get-notification:id",
"api-reference/notification/post-notification"
]
@@ -149,9 +150,11 @@
{
"group": "Page",
"pages": [
+ "api-reference/page/get-page",
"api-reference/page/get-page:id",
"api-reference/page/post-page",
- "api-reference/page/put-page:id"
+ "api-reference/page/put-page:id",
+ "api-reference/page/post-page:id/update"
]
},
{
diff --git a/apps/server/package.json b/apps/server/package.json
index 91ef7d497..0ca9f1b4e 100644
--- a/apps/server/package.json
+++ b/apps/server/package.json
@@ -13,6 +13,7 @@
"dependencies": {
"@hono/sentry": "1.0.0",
"@hono/zod-openapi": "0.8.3",
+ "@openstatus/analytics": "workspace:^",
"@openstatus/db": "workspace:*",
"@openstatus/emails": "workspace:*",
"@openstatus/notification-discord": "workspace:*",
diff --git a/apps/server/src/env.ts b/apps/server/src/env.ts
index 15d5eec10..979aadb99 100644
--- a/apps/server/src/env.ts
+++ b/apps/server/src/env.ts
@@ -12,6 +12,8 @@ export const env = createEnv({
UPSTASH_REDIS_REST_TOKEN: z.string().min(1),
FLY_REGION: z.enum(flyRegions),
CRON_SECRET: z.string(),
+ JITSU_WRITE_KEY: z.string().optional(),
+ JITSU_HOST: z.string().optional(),
},
/**
diff --git a/apps/server/src/v1/monitor.ts b/apps/server/src/v1/monitor.ts
index eda543713..adf09ef7d 100644
--- a/apps/server/src/v1/monitor.ts
+++ b/apps/server/src/v1/monitor.ts
@@ -1,5 +1,6 @@
import { createRoute, OpenAPIHono, z } from "@hono/zod-openapi";
+import { trackAnalytics } from "@openstatus/analytics";
import { db, eq, sql } from "@openstatus/db";
import {
flyRegions,
@@ -63,7 +64,7 @@ const MonitorSchema = z
.default([])
.openapi({
example: ["ams"],
- description: "The regions to use",
+ description: "Where we should monitor it",
}),
name: z
.string()
@@ -127,7 +128,7 @@ const monitorInput = z
}),
regions: regionInput.openapi({
example: "ams",
- description: "The regions to use",
+ description: "The regions where we should monitor your endpoint",
}),
name: z.string().openapi({
example: "Documenso",
@@ -140,7 +141,7 @@ const monitorInput = z
method: z.enum(monitorMethods).default("GET").openapi({ example: "GET" }),
body: z.string().openapi({
example: "Hello World",
- description: "The body",
+ description: "The body of your request",
}),
active: z.boolean().default(false).openapi({
description: "If the monitor is active",
@@ -346,6 +347,15 @@ monitorApi.openapi(postRoute, async (c) => {
const data = MonitorSchema.parse(_newMonitor);
+ if (env.JITSU_WRITE_KEY) {
+ trackAnalytics({
+ event: "Monitor Created",
+ url: input.url,
+ periodicity: input.periodicity,
+ api: true,
+ workspaceId: String(workspaceId),
+ });
+ }
return c.json(data);
});
diff --git a/apps/server/src/v1/notification.ts b/apps/server/src/v1/notification.ts
index e26d95cd2..ba1520b16 100644
--- a/apps/server/src/v1/notification.ts
+++ b/apps/server/src/v1/notification.ts
@@ -76,6 +76,65 @@ const CreateNotificationSchema = z.object({
})
.nullish(),
});
+
+const getAllRoute = createRoute({
+ method: "get",
+ tags: ["notification"],
+ description: "Get a notification",
+ path: "/",
+
+ responses: {
+ 200: {
+ content: {
+ "application/json": {
+ schema: z.array(NotificationSchema),
+ },
+ },
+ description: "Get all your workspace notification",
+ },
+ 400: {
+ content: {
+ "application/json": {
+ schema: ErrorSchema,
+ },
+ },
+ description: "Returns an error",
+ },
+ },
+});
+
+notificationApi.openapi(getAllRoute, async (c) => {
+ const workspaceId = Number(c.get("workspaceId"));
+
+ const result = await db
+ .select()
+ .from(notification)
+ .where(and(eq(page.workspaceId, workspaceId)))
+ .all();
+
+ if (!result) return c.json({ code: 404, message: "Not Found" }, 404);
+ const data = [];
+
+ for (const r of result) {
+ const linkedMonitors = await db
+ .select()
+ .from(notificationsToMonitors)
+ .where(eq(notificationsToMonitors.notificationId, r.id))
+ .all();
+
+ const monitorsId = linkedMonitors.map((m) => m.monitorId);
+
+ const p = NotificationSchema.parse({
+ ...result,
+ payload: JSON.parse(r.data || "{}"),
+ monitors: monitorsId,
+ });
+ data.push(p);
+ }
+
+ return c.json(data);
+});
+
const getRoute = createRoute({
method: "get",
tags: ["notification"],
diff --git a/apps/server/src/v1/page.ts b/apps/server/src/v1/page.ts
index b4f39dfe7..3cf5043ed 100644
--- a/apps/server/src/v1/page.ts
+++ b/apps/server/src/v1/page.ts
@@ -307,6 +307,46 @@ pageApi.openapi(getRoute, async (c) => {
return c.json(data);
});
+const getAllRoute = createRoute({
+ method: "get",
+ tags: ["page"],
+ description: "Get all your status page",
+ path: "/",
+ responses: {
+ 200: {
+ content: {
+ "application/json": {
+ schema: z.array(PageSchema),
+ },
+ },
+ description: "Get an Status page",
+ },
+ 400: {
+ content: {
+ "application/json": {
+ schema: ErrorSchema,
+ },
+ },
+ description: "Returns an error",
+ },
+ },
+});
+
+pageApi.openapi(getAllRoute, async (c) => {
+ const workspaceId = Number(c.get("workspaceId"));
+
+ const result = await db
+ .select()
+ .from(page)
+ .where(and(eq(page.workspaceId, workspaceId)))
+ .get();
+
+ if (!result) return c.json({ code: 404, message: "Not Found" }, 404);
+ const data = z.array(PageSchema).parse(result);
+
+ return c.json(data);
+});
+
const postRoute = createRoute({
method: "post",
tags: ["page"],
diff --git a/packages/analytics/src/type.ts b/packages/analytics/src/type.ts
index 92bb2813f..90991aa4f 100644
--- a/packages/analytics/src/type.ts
+++ b/packages/analytics/src/type.ts
@@ -8,10 +8,13 @@ export type AnalyticsEvents =
event: "Monitor Created";
url: string;
periodicity: string;
+ api?: boolean;
+ workspaceId?: string;
}
| {
event: "Page Created";
slug: string;
+ api?: boolean;
}
| { event: "User Upgraded"; email: string }
| { event: "User Signed In" }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 55d8042e0..a2d8a4e91 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -43,6 +43,9 @@ importers:
'@hono/zod-openapi':
specifier: 0.8.3
+ '@openstatus/analytics':
+ specifier: workspace:^
+ version: link:../../packages/analytics
'@openstatus/db':
specifier: workspace:*
version: link:../../packages/db