Skip to content

Open-source status page, incident response and uptime monitoring

feat: add maintenance updates for status page communications (#2561)

Bryan FRIMINc33687cbffb0
diff --git a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/(list)/page.tsx b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/(list)/page.tsx
index 88dd8ab03..f9983a7f2 100644
--- a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/(list)/page.tsx
+++ b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/(list)/page.tsx
@@ -1,8 +1,9 @@
"use client";
import { Button } from "@openstatus/ui/components/ui/button";
-import { useMutation, useQuery } from "@tanstack/react-query";
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { useParams } from "next/navigation";
+import { toast } from "sonner";
import { Link } from "@/components/common/link";
import {
@@ -18,10 +19,12 @@ import { FormSheetMaintenance } from "@/components/forms/maintenance/sheet";
import { toCheckboxTreeItems } from "@/components/ui/checkbox-tree";
import { DataTable } from "@/components/ui/data-table/data-table";
import { useTRPC } from "@/lib/trpc/client";
+import { errorMessage } from "@/lib/trpc/error";
export default function Page() {
const { id } = useParams<{ id: string }>();
const trpc = useTRPC();
+ const queryClient = useQueryClient();
const { data: statusPage } = useQuery(
trpc.page.get.queryOptions({ id: Number.parseInt(id) }),
);
@@ -31,15 +34,22 @@ export default function Page() {
}),
);
const sendMaintenanceUpdateMutation = useMutation(
- trpc.subscriberNotification.maintenance.mutationOptions(),
+ trpc.subscriberNotification.maintenance.mutationOptions({
+ onError: (error) => {
+ toast.error(errorMessage(error, "Failed to notify subscribers"));
+ },
+ }),
);
const createMaintenanceMutation = useMutation(
trpc.maintenance.new.mutationOptions({
onSuccess: (maintenance) => {
refetch();
+ queryClient.invalidateQueries({
+ queryKey: trpc.page.list.queryKey(),
+ });
if (maintenance.notifySubscribers) {
sendMaintenanceUpdateMutation.mutate({
- id: maintenance.id,
+ id: maintenance.initialUpdateId,
});
}
},
@@ -72,7 +82,7 @@ export default function Page() {
await createMaintenanceMutation.mutateAsync({
pageId: Number.parseInt(id),
title: values.title,
- message: values.message,
+ message: values.message ?? "",
startDate: values.startDate,
endDate: values.endDate,
pageComponents: values.pageComponents,
diff --git a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/[maintenanceId]/client.tsx b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/[maintenanceId]/client.tsx
index 126e75141..7a2e3243e 100644
--- a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/[maintenanceId]/client.tsx
+++ b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/maintenances/[maintenanceId]/client.tsx
@@ -19,10 +19,12 @@ import {
DetailTitleRow,
} from "@/components/content/detail";
import { SectionGroup } from "@/components/content/section";
+import { Timeline } from "@/components/content/timeline";
import { MaintenanceActions } from "@/components/maintenances/maintenance-actions";
import { MaintenanceComponents } from "@/components/maintenances/maintenance-components";
-import { MaintenanceComposer } from "@/components/maintenances/maintenance-composer";
import { MaintenanceProperties } from "@/components/maintenances/maintenance-properties";
+import { MaintenanceUpdateComposer } from "@/components/maintenances/maintenance-update-composer";
+import { MaintenanceUpdateTimelineItem } from "@/components/maintenances/maintenance-update-timeline";
import { useMaintenanceStatus } from "@/components/maintenances/use-maintenance-status";
import { useUpdateMaintenance } from "@/components/maintenances/use-update-maintenance";
import { Notifications } from "@/components/status-pages/notifications";
@@ -35,6 +37,7 @@ export function Client({ id, pageId }: { id: number; pageId: number }) {
trpc.maintenance.get.queryOptions({ id }),
);
const { data: page } = useQuery(trpc.page.get.queryOptions({ id: pageId }));
+ const { data: workspace } = useQuery(trpc.workspace.get.queryOptions());
const rename = useUpdateMaintenance(id);
const status = useMaintenanceStatus(
maintenance ?? { from: new Date(0), to: new Date(0) },
@@ -43,6 +46,10 @@ export function Client({ id, pageId }: { id: number; pageId: number }) {
if (!maintenance || !page) return null;
const publicUrl = `${getPageUrl(page)}/events/maintenance/${maintenance.id}`;
+ const canNotify = workspace?.limits["status-subscribers"] === true;
+ // service returns updates newest first
+ const updates = maintenance.updates;
+ const latest = updates[0];
return (
<SectionGroup>
@@ -76,14 +83,34 @@ export function Client({ id, pageId }: { id: number; pageId: number }) {
{formatDistanceStrict(maintenance.from, maintenance.to)}
</span>
</DetailMetaItem>
+ {updates.length ? (
+ <DetailMetaItem>
+ {updates.length} {updates.length === 1 ? "update" : "updates"}
+ </DetailMetaItem>
+ ) : null}
+ {latest ? (
+ <DetailMetaItem>
+ Last update <DetailMetaTime date={latest.date} />
+ </DetailMetaItem>
+ ) : null}
</DetailMeta>
</DetailHeader>
<DetailContent>
<DetailMain>
- <DetailSection>
- <DetailSectionTitle variant="heading">Message</DetailSectionTitle>
- <MaintenanceComposer maintenance={maintenance} />
- </DetailSection>
+ <Timeline>
+ <MaintenanceUpdateComposer
+ maintenance={maintenance}
+ canNotify={canNotify}
+ />
+ {updates.map((update, i) => (
+ <MaintenanceUpdateTimelineItem
+ key={update.id}
+ maintenance={maintenance}
+ update={update}
+ index={updates.length - i}
+ />
+ ))}
+ </Timeline>
</DetailMain>
<DetailAside>
<DetailSection>
diff --git a/apps/dashboard/src/components/chat/tool-renderers/index.tsx b/apps/dashboard/src/components/chat/tool-renderers/index.tsx
index 193f3872b..9989b2da5 100644
--- a/apps/dashboard/src/components/chat/tool-renderers/index.tsx
+++ b/apps/dashboard/src/components/chat/tool-renderers/index.tsx
@@ -35,6 +35,11 @@ import { listPrivateLocationsTable } from "./list-private-locations";
import { listResponseLogsTable } from "./list-response-logs";
import { listStatusPagesTable } from "./list-status-pages";
import { listStatusReportsTable } from "./list-status-reports";
+import {
+ addMaintenanceUpdateChanges,
+ deleteMaintenanceUpdateChanges,
+ updateMaintenanceUpdateChanges,
+} from "./maintenance-update";
import { resolveStatusReportChanges } from "./resolve-status-report";
import { ResultTable } from "./result-table";
import { searchContentTable } from "./search-content";
@@ -148,6 +153,32 @@ export const toolRenderers: ToolRendererRegistry = {
),
summary: (o) => `ID ${o.id}`,
},
+ add_maintenance_update: {
+ renderDraft: (input) => addMaintenanceUpdateChanges(input),
+ renderResult: ({ input, output }) => (
+ <ChangesTable
+ changes={addMaintenanceUpdateChanges(input, {
+ id: output.id,
+ notified: output.notified ?? false,
+ })}
+ />
+ ),
+ summary: (o) => `update #${o.id}`,
+ },
+ update_maintenance_update: {
+ renderDraft: (input) => updateMaintenanceUpdateChanges(input),
+ renderResult: ({ input }) => (
+ <ChangesTable changes={updateMaintenanceUpdateChanges(input)} />
+ ),
+ summary: (o) => `update #${o.id}`,
+ },
+ delete_maintenance_update: {
+ renderDraft: (input) => deleteMaintenanceUpdateChanges(input),
+ renderResult: ({ input }) => (
+ <ChangesTable changes={deleteMaintenanceUpdateChanges(input)} />
+ ),
+ summary: (o) => `deleted #${o.id}`,
+ },
list_incidents: {
renderResult: ({ output }) => (
<ResultTable {...listIncidentsTable(output)} />
diff --git a/apps/dashboard/src/components/chat/tool-renderers/maintenance-update.tsx b/apps/dashboard/src/components/chat/tool-renderers/maintenance-update.tsx
new file mode 100644
index 000000000..c31fdbff0
--- /dev/null
+++ b/apps/dashboard/src/components/chat/tool-renderers/maintenance-update.tsx
@@ -0,0 +1,32 @@
+import type { AgentToolInput } from "@openstatus/services/agent-tools";
+
+import type { ChangeRow } from "@/components/common/changes-table";
+
+export function addMaintenanceUpdateChanges(
+ input: AgentToolInput<"add_maintenance_update">,
+ applied?: { id: number; notified: boolean },
+): ChangeRow[] {
+ return [
+ ...(applied ? [{ field: "id", after: applied.id }] : []),
+ { field: "maintenanceId", after: input.maintenanceId },
+ { field: "message", after: input.message },
+ ...(input.date ? [{ field: "date", after: input.date }] : []),
+ { field: "notify", after: applied?.notified ?? input.notify },
+ ];
+}
+
+export function updateMaintenanceUpdateChanges(
+ input: AgentToolInput<"update_maintenance_update">,
+): ChangeRow[] {
+ return [
+ { field: "id", after: input.id },
+ ...(input.message ? [{ field: "message", after: input.message }] : []),
+ ...(input.date ? [{ field: "date", after: input.date }] : []),
+ ];
+}
+
+export function deleteMaintenanceUpdateChanges(
+ input: AgentToolInput<"delete_maintenance_update">,
+): ChangeRow[] {
+ return [{ field: "id", before: input.id }];
+}
diff --git a/apps/dashboard/src/components/data-table/maintenances/data-table-row-actions.tsx b/apps/dashboard/src/components/data-table/maintenances/data-table-row-actions.tsx
index 051c54bf2..1637b344f 100644
--- a/apps/dashboard/src/components/data-table/maintenances/data-table-row-actions.tsx
+++ b/apps/dashboard/src/components/data-table/maintenances/data-table-row-actions.tsx
@@ -69,7 +69,6 @@ export function MaintenanceRowActions({
)}
defaultValues={{
title: maintenance.title,
- message: maintenance.message,
startDate: maintenance.from,
endDate: maintenance.to,
pageComponents: maintenance.pageComponents?.map((c) => c.id) ?? [],
@@ -78,7 +77,6 @@ export function MaintenanceRowActions({
await updateMaintenanceMutation.mutateAsync({
id: maintenance.id,
title: values.title,
- message: values.message,
startDate: values.startDate,
endDate: values.endDate,
pageComponents: values.pageComponents,
diff --git a/apps/dashboard/src/components/forms/form-alert-dialog.tsx b/apps/dashboard/src/components/forms/form-alert-dialog.tsx
index 1138b47b1..8d92a5b0e 100644
--- a/apps/dashboard/src/components/forms/form-alert-dialog.tsx
+++ b/apps/dashboard/src/components/forms/form-alert-dialog.tsx
@@ -35,9 +35,14 @@ export function FormAlertDialog({
const { copy, isCopied } = useCopyToClipboard();
const [open, setOpen] = useState(false);
- const handleDelete = async () => {
- try {
- startTransition(async () => {
+ const handleOpenChange = (next: boolean) => {
+ setOpen(next);
+ if (!next) setValue("");
+ };
+
+ const handleDelete = () => {
+ startTransition(async () => {
+ try {
const promise = submitAction();
toast.promise(promise, {
loading: "Deleting...",
@@ -50,15 +55,15 @@ export function FormAlertDialog({
},
});
await promise;
- setOpen(false);
- });
- } catch (error) {
- console.error("Failed to revoke:", error);
- }
+ handleOpenChange(false);
+ } catch (error) {
+ console.error("Failed to delete:", error);
+ }
+ });
};
return (
- <AlertDialog open={open} onOpenChange={setOpen}>
+ <AlertDialog open={open} onOpenChange={handleOpenChange}>
<AlertDialogTrigger asChild>
{children ?? (
<Button variant="destructive" size="sm">
diff --git a/apps/dashboard/src/components/forms/maintenance-update/form.tsx b/apps/dashboard/src/components/forms/maintenance-update/form.tsx
new file mode 100644
index 000000000..96eddbd58
--- /dev/null
+++ b/apps/dashboard/src/components/forms/maintenance-update/form.tsx
@@ -0,0 +1,194 @@
+"use client";
+
+import { Checkbox } from "@openstatus/ui/components/ui/checkbox";
+import {
+ Form,
+ FormControl,
+ FormDescription,
+ FormField,
+ FormItem,
+ FormLabel,
+ FormMessage,
+} from "@openstatus/ui/components/ui/form";
+import { Label } from "@openstatus/ui/components/ui/label";
+import {
+ Tabs,
+ TabsContent,
+ TabsList,
+ TabsTrigger,
+} from "@openstatus/ui/components/ui/tabs";
+import { Textarea } from "@openstatus/ui/components/ui/textarea";
+import { cn } from "@openstatus/ui/lib/utils";
+import { useQuery } from "@tanstack/react-query";
+import { isTRPCClientError } from "@trpc/client";
+import React, { useTransition } from "react";
+import { useForm } from "react-hook-form";
+import { toast } from "sonner";
+
+import { DateTimePicker } from "@/components/common/date-time-picker";
+import { ProcessMessage } from "@/components/content/process-message";
+import {
+ FormCardContent,
+ FormCardSeparator,
+} from "@/components/forms/form-card";
+import { useFormSheetDirty } from "@/components/forms/form-sheet";
+import { useTRPC } from "@/lib/trpc/client";
+
+export type FormValues = {
+ message: string;
+ date: Date;
+ notifySubscribers?: boolean;
+};
+
+export function FormMaintenanceUpdate({
+ defaultValues,
+ onSubmit,
+ showNotifySubscribers = false,
+ className,
+ id,
+ ...props
+}: Omit<React.ComponentProps<"form">, "onSubmit"> & {
+ defaultValues?: Partial<FormValues>;
+ onSubmit: (values: FormValues) => Promise<void>;
+ showNotifySubscribers?: boolean;
+}) {
+ const trpc = useTRPC();
+ const { data: workspace } = useQuery(trpc.workspace.get.queryOptions());
+ const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+ const form = useForm<FormValues>({
+ defaultValues: {
+ message: defaultValues?.message ?? "",
+ date: defaultValues?.date ?? new Date(),
+ notifySubscribers:
+ defaultValues?.notifySubscribers ??
+ !!workspace?.limits["status-subscribers"],
+ },
+ });
+ const message = form.watch("message");
+ const [isPending, startTransition] = useTransition();
+ const { setIsDirty } = useFormSheetDirty();
+
+ React.useEffect(() => {
+ setIsDirty(form.formState.isDirty);
+ }, [form.formState.isDirty, setIsDirty]);
+
+ function submitAction(values: FormValues) {
+ if (isPending) return;
+ startTransition(async () => {
+ const promise = onSubmit(values);
+ toast.promise(promise, {
+ loading: "Saving...",
+ success: "Saved",
+ error: (error) =>
+ isTRPCClientError(error) ? error.message : "Failed to save",
+ });
+ try {
+ await promise;
+ } catch (error) {
+ console.error(error);
+ }
+ });
+ }
+
+ return (
+ <Form {...form}>
+ <form
+ id={id}
+ className={cn("grid gap-4", className)}
+ onSubmit={form.handleSubmit(submitAction)}
+ {...props}
+ >
+ <FormCardContent>
+ <FormField
+ control={form.control}
+ name="date"
+ render={({ field }) => (
+ <FormItem className="flex flex-col">
+ <FormLabel>Date</FormLabel>
+ <FormControl>
+ <DateTimePicker
+ value={field.value}
+ onChange={field.onChange}
+ min={new Date("1900-01-01")}
+ max={new Date()}
+ className="w-full sm:w-[240px]"
+ />
+ </FormControl>
+ <FormDescription>
+ Shown in your timezone (
+ <code className="font-commit-mono text-foreground/70">
+ {timezone}
+ </code>
+ ) and saved as UTC.
+ </FormDescription>
+ <FormMessage />
+ </FormItem>
+ )}
+ />
+ </FormCardContent>
+ <FormCardSeparator />
+ <FormCardContent>
+ <Tabs defaultValue="write">
+ <TabsList>
+ <TabsTrigger value="write">Writing</TabsTrigger>
+ <TabsTrigger value="preview">Preview</TabsTrigger>
+ </TabsList>
+ <TabsContent value="write">
+ <FormField
+ control={form.control}
+ name="message"
+ render={({ field }) => (
+ <FormItem>
+ <FormLabel>Message</FormLabel>
+ <FormControl>
+ <Textarea rows={6} required {...field} />
+ </FormControl>
+ <FormMessage />
+ <FormDescription>Markdown support</FormDescription>
+ </FormItem>
+ )}
+ />
+ </TabsContent>
+ <TabsContent value="preview">
+ <div className="grid gap-2">
+ <Label>Preview</Label>
+ <div className="prose prose-sm dark:prose-invert text-foreground rounded-md border px-3 py-2 text-sm">
+ <ProcessMessage value={message} />
+ </div>
+ </div>
+ </TabsContent>
+ </Tabs>
+ </FormCardContent>
+ {showNotifySubscribers && workspace?.limits["status-subscribers"] ? (
+ <>
+ <FormCardSeparator />
+ <FormCardContent>
+ <FormField
+ control={form.control}
+ name="notifySubscribers"
+ render={({ field }) => (
+ <FormItem>
+ <FormLabel>Notify Subscribers</FormLabel>
+ <FormControl>
+ <div className="flex items-center gap-2">
+ <Checkbox
+ id={`${id}-notify-subscribers`}
+ checked={field.value}
+ onCheckedChange={field.onChange}
+ />
+ <Label htmlFor={`${id}-notify-subscribers`}>
+ Send notification to subscribers
+ </Label>
+ </div>
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ )}
+ />
+ </FormCardContent>
+ </>
+ ) : null}
+ </form>
+ </Form>
+ );
+}
diff --git a/apps/dashboard/src/components/forms/maintenance-update/sheet.tsx b/apps/dashboard/src/components/forms/maintenance-update/sheet.tsx
new file mode 100644
index 000000000..bdc5f348e
--- /dev/null
+++ b/apps/dashboard/src/components/forms/maintenance-update/sheet.tsx
@@ -0,0 +1,80 @@
+"use client";
+
+import { Button } from "@openstatus/ui/components/ui/button";
+import { useState } from "react";
+
+import { FormCard, FormCardGroup } from "@/components/forms/form-card";
+import {
+ FormSheetContent,
+ FormSheetDescription,
+ FormSheetFooter,
+ FormSheetHeader,
+ FormSheetTitle,
+ FormSheetTrigger,
+ FormSheetWithDirtyProtection,
+} from "@/components/forms/form-sheet";
+import {
+ FormMaintenanceUpdate,
+ type FormValues,
+} from "@/components/forms/maintenance-update/form";
+
+export function FormSheetMaintenanceUpdate({
+ children,
+ defaultValues,
+ onSubmit,
+ open: controlledOpen,
+ onOpenChange,
+ ...props
+}: Omit<React.ComponentProps<typeof FormSheetTrigger>, "onSubmit"> & {
+ defaultValues?: Partial<FormValues>;
+ onSubmit: (values: FormValues) => Promise<void>;
+ open?: boolean;
+ onOpenChange?: (open: boolean) => void;
+}) {
+ const [internalOpen, setInternalOpen] = useState(false);
+ const isControlled = controlledOpen !== undefined;
+ const open = isControlled ? controlledOpen : internalOpen;
+ const setOpen = (next: boolean) => {
+ if (isControlled) {
+ onOpenChange?.(next);
+ } else {
+ setInternalOpen(next);
+ }
+ };
+
+ return (
+ <FormSheetWithDirtyProtection open={open} onOpenChange={setOpen}>
+ {children ? (
+ <FormSheetTrigger {...props} asChild>
+ {children}
+ </FormSheetTrigger>
+ ) : null}
+ <FormSheetContent className="sm:max-w-lg">
+ <FormSheetHeader>
+ <FormSheetTitle>Maintenance Update</FormSheetTitle>
+ <FormSheetDescription>
+ Edit the message or date of this update.
+ </FormSheetDescription>
+ </FormSheetHeader>
+ <FormCardGroup className="overflow-y-auto">
+ <FormCard className="overflow-auto rounded-none border-none">
+ <FormMaintenanceUpdate
+ id="maintenance-update-form"
+ className="my-4"
+ defaultValues={defaultValues}
+ onSubmit={async (values) => {
+ await onSubmit(values);
+ setOpen(false);
+ }}
+ />
+ </FormCard>
+ </FormCardGroup>
+ <FormSheetFooter>
+ <Button type="submit" form="maintenance-update-form">
+ Submit
+ </Button>
+ </FormSheetFooter>
+ </FormSheetContent>
+ </FormSheetWithDirtyProtection>
+ );
+}
diff --git a/apps/dashboard/src/components/forms/maintenance/form.tsx b/apps/dashboard/src/components/forms/maintenance/form.tsx
index b61acbf7e..34bbefd49 100644
--- a/apps/dashboard/src/components/forms/maintenance/form.tsx
+++ b/apps/dashboard/src/components/forms/maintenance/form.tsx
@@ -46,7 +46,8 @@ import { useTRPC } from "@/lib/trpc/client";
const schema = z
.object({
title: z.string().trim().min(1, "Title is required"),
- message: z.string(),
+ /** Create only: becomes the first timeline update. */
+ message: z.string().trim().min(1, "Message is required").optional(),
startDate: z.date(),
endDate: z.date(),
pageComponents: z.array(z.number()),
@@ -215,39 +216,46 @@ export function FormMaintenance({
)}
/>
</FormCardContent>
- <FormCardSeparator />
- <FormCardContent>
- <Tabs defaultValue="tab-1">
- <TabsList>
- <TabsTrigger value="tab-1">Writing</TabsTrigger>
- <TabsTrigger value="tab-2">Preview</TabsTrigger>
- </TabsList>
- <TabsContent value="tab-1">
- <FormField
- control={form.control}
- name="message"
- render={({ field }) => (
- <FormItem>
- <FormLabel>Message</FormLabel>
- <FormControl>
- <Textarea rows={6} {...field} />
- </FormControl>
- <FormMessage />
- <FormDescription>Markdown support</FormDescription>
- </FormItem>
- )}
- />
- </TabsContent>
- <TabsContent value="tab-2">
- <div className="grid gap-2">
- <Label>Preview</Label>
- <div className="prose dark:prose-invert prose-sm text-foreground rounded-md border px-3 py-2 text-sm">
- <ProcessMessage value={watchMessage} />
- </div>
- </div>
- </TabsContent>
- </Tabs>
- </FormCardContent>
+ {!defaultValues ? (
+ <>
+ <FormCardSeparator />
+ <FormCardContent>
+ <Tabs defaultValue="tab-1">
+ <TabsList>
+ <TabsTrigger value="tab-1">Writing</TabsTrigger>
+ <TabsTrigger value="tab-2">Preview</TabsTrigger>
+ </TabsList>
+ <TabsContent value="tab-1">
+ <FormField
+ control={form.control}
+ name="message"
+ render={({ field }) => (
+ <FormItem>
+ <FormLabel>Message</FormLabel>
+ <FormControl>
+ <Textarea rows={6} {...field} />
+ </FormControl>
+ <FormMessage />
+ <FormDescription>
+ Markdown support. Posted as the first update; later
+ updates are added on the maintenance page.
+ </FormDescription>
+ </FormItem>
+ )}
+ />
+ </TabsContent>
+ <TabsContent value="tab-2">
+ <div className="grid gap-2">
+ <Label>Preview</Label>
+ <div className="prose dark:prose-invert prose-sm text-foreground rounded-md border px-3 py-2 text-sm">
+ <ProcessMessage value={watchMessage ?? ""} />
+ </div>
+ </div>
+ </TabsContent>
+ </Tabs>
+ </FormCardContent>
+ </>
+ ) : null}
<FormCardSeparator />
<FormCardContent>
<FormField
diff --git a/apps/dashboard/src/components/forms/maintenance/sheet-create.tsx b/apps/dashboard/src/components/forms/maintenance/sheet-create.tsx
index e425f1567..e88b5a3c3 100644
--- a/apps/dashboard/src/components/forms/maintenance/sheet-create.tsx
+++ b/apps/dashboard/src/components/forms/maintenance/sheet-create.tsx
@@ -12,6 +12,7 @@ import {
import { Separator } from "@openstatus/ui/components/ui/separator";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { useState } from "react";
+import { toast } from "sonner";
import {
EmptyStateContainer,
@@ -30,6 +31,7 @@ import {
import { FormMaintenance } from "@/components/forms/maintenance/form";
import { toCheckboxTreeItems } from "@/components/ui/checkbox-tree";
import { useTRPC } from "@/lib/trpc/client";
+import { errorMessage } from "@/lib/trpc/error";
/**
* Create-maintenance sheet with a status page selector — for surfaces that
@@ -67,13 +69,19 @@ export function FormSheetMaintenanceCreate({
);
const sendMaintenanceUpdateMutation = useMutation(
- trpc.subscriberNotification.maintenance.mutationOptions(),
+ trpc.subscriberNotification.maintenance.mutationOptions({
+ onError: (error) => {
+ toast.error(errorMessage(error, "Failed to notify subscribers"));
+ },
+ }),
);
const createMaintenanceMutation = useMutation(
trpc.maintenance.new.mutationOptions({
onSuccess: (maintenance) => {
if (maintenance.notifySubscribers) {
- sendMaintenanceUpdateMutation.mutate({ id: maintenance.id });
+ sendMaintenanceUpdateMutation.mutate({
+ id: maintenance.initialUpdateId,
+ });
}
// no-input prefix key — matches every maintenance.list query
queryClient.invalidateQueries({
@@ -133,7 +141,7 @@ export function FormSheetMaintenanceCreate({
await createMaintenanceMutation.mutateAsync({
pageId,
title: values.title,
- message: values.message,
+ message: values.message ?? "",
startDate: values.startDate,
endDate: values.endDate,
pageComponents: values.pageComponents,
diff --git a/apps/dashboard/src/components/maintenances/maintenance-composer.tsx b/apps/dashboard/src/components/maintenances/maintenance-composer.tsx
deleted file mode 100644
index 39d1baf60..000000000
--- a/apps/dashboard/src/components/maintenances/maintenance-composer.tsx
+++ /dev/null
@@ -1,79 +0,0 @@
-"use client";
-
-import type { RouterOutputs } from "@openstatus/api";
-import { Button } from "@openstatus/ui/components/ui/button";
-import { useState } from "react";
-import { toast } from "sonner";
-
-import {
- Composer,
- ComposerFooter,
- ComposerHeader,
- ComposerPreview,
- ComposerTextarea,
-} from "@/components/content/composer";
-
-import { useUpdateMaintenance } from "./use-update-maintenance";
-
-type Maintenance = NonNullable<RouterOutputs["maintenance"]["get"]>;
-
-/** The single maintenance message: edit in place, save explicitly, no matter the status. */
-export function MaintenanceComposer({
- maintenance,
-}: {
- maintenance: Maintenance;
-}) {
- // null = pristine: the editor follows the server copy, so a background
- // refetch never clobbers unsaved edits.
- const [draft, setDraft] = useState<string | null>(null);
- const server = maintenance.message;
- const content = draft ?? server;
- const { update, isPending } = useUpdateMaintenance(maintenance.id, {
- onSuccess: () => {
- toast.success("Message saved");
- setDraft(null);
- },
- });
-
- const dirty = draft !== null && draft !== server;
- // the service rejects an empty message
- const canSave = dirty && content.trim().length > 0 && !isPending;
- const submit = () => update({ message: content });
-
- return (
- <Composer size="lg">
- <ComposerHeader />
- <ComposerTextarea
- aria-label="Message"
- placeholder="What is being maintained and what customers can expect."
- disabled={isPending}
- value={content}
- onChange={(e) => setDraft(e.target.value)}
- onSubmit={canSave ? submit : undefined}
- />
- <ComposerPreview value={content} />
- <ComposerFooter>
- <span className="text-xs">
- {dirty
- ? "Unsaved changes"
- : "Visible to everyone on your status page"}
- </span>
- <div className="ml-auto flex items-center gap-2">
- {dirty ? (
- <Button
- size="sm"
- variant="ghost"
- disabled={isPending}
- onClick={() => setDraft(null)}
- >
- Reset
- </Button>
- ) : null}
- <Button size="sm" disabled={!canSave} onClick={submit}>
- Save
- </Button>
- </div>
- </ComposerFooter>
- </Composer>
- );
-}
diff --git a/apps/dashboard/src/components/maintenances/maintenance-update-composer.tsx b/apps/dashboard/src/components/maintenances/maintenance-update-composer.tsx
new file mode 100644
index 000000000..4dd20dda7
--- /dev/null
+++ b/apps/dashboard/src/components/maintenances/maintenance-update-composer.tsx
@@ -0,0 +1,133 @@
+"use client";
+
+import type { RouterOutputs } from "@openstatus/api";
+import { Button } from "@openstatus/ui/components/ui/button";
+import { Checkbox } from "@openstatus/ui/components/ui/checkbox";
+import { Label } from "@openstatus/ui/components/ui/label";
+import { personName } from "@openstatus/utils";
+import { useQuery } from "@tanstack/react-query";
+import { useState } from "react";
+import { toast } from "sonner";
+
+import { DateTimePicker } from "@/components/common/date-time-picker";
+import {
+ Composer,
+ ComposerFooter,
+ ComposerHeader,
+ ComposerPreview,
+ ComposerTextarea,
+} from "@/components/content/composer";
+import { TimelineAvatar, TimelineItem } from "@/components/content/timeline";
+import { useTRPC } from "@/lib/trpc/client";
+import { errorMessage } from "@/lib/trpc/error";
+
+import { usePublishMaintenanceUpdate } from "./use-publish-maintenance-update";
+
+type Maintenance = NonNullable<RouterOutputs["maintenance"]["get"]>;
+
+/** Posts a dated note on the maintenance timeline; the newest is the public message. */
+export function MaintenanceUpdateComposer({
+ maintenance,
+ canNotify,
+}: {
+ maintenance: Maintenance;
+ /** Whether the plan includes subscriber notifications. */
+ canNotify: boolean;
+}) {
+ const trpc = useTRPC();
+ const { data: user } = useQuery(trpc.user.get.queryOptions());
+ const [message, setMessage] = useState("");
+ const [notifyChecked, setNotifyChecked] = useState(true);
+ // null = now, resolved at publish time so an open composer never backdates.
+ const [date, setDate] = useState<Date | null>(null);
+ // shown while `date` is null; refreshed on reset
+ const [now, setNow] = useState(() => new Date());
+
+ const publish = usePublishMaintenanceUpdate(maintenance.id);
+ const notify = canNotify && notifyChecked;
+ const disabled = publish.isPending || !message.trim();
+
+ function reset() {
+ setMessage("");
+ setDate(null);
+ setNow(new Date());
+ }
+
+ async function submit() {
+ if (disabled) return;
+ const promise = publish.publish({
+ message: message.trim(),
+ date: date ?? new Date(),
+ notifySubscribers: notify,
+ });
+ toast.promise(promise, {
+ loading: "Publishing...",
+ success: "Update published",
+ error: (error) => errorMessage(error, "Failed to publish"),
+ });
+ await promise;
+ reset();
+ }
+
+ return (
+ <TimelineItem>
+ <TimelineAvatar
+ name={user ? personName(user) : null}
+ src={user?.photoUrl}
+ />
+ <Composer>
+ <ComposerHeader />
+ <ComposerTextarea
+ placeholder="What changed? Customers will read this on the status page."
+ disabled={publish.isPending}
+ value={message}
+ onChange={(e) => setMessage(e.target.value)}
+ onSubmit={() => submit().catch(console.error)}
+ />
+ <ComposerPreview value={message} />
+ <ComposerFooter>
+ <div className="flex flex-wrap items-center gap-2">
+ <span>Posted</span>
+ <DateTimePicker
+ key={now.getTime()}
+ aria-label="Date"
+ value={date ?? now}
+ onChange={setDate}
+ max={new Date()}
+ className="bg-background text-foreground h-8 w-fit font-mono"
+ />
+ </div>
+ <div className="ml-auto flex w-full flex-wrap items-center justify-between gap-3 sm:w-auto sm:justify-start">
+ <div className="flex items-center gap-2">
+ <Checkbox
+ id="notify-subscribers"
+ checked={notify}
+ disabled={!canNotify}
+ onCheckedChange={(value) => setNotifyChecked(value === true)}
+ />
+ <Label
+ htmlFor="notify-subscribers"
+ className="text-xs font-normal whitespace-nowrap"
+ title={
+ canNotify
+ ? undefined
+ : "Subscriber notifications are not included in your plan."
+ }
+ >
+ Notify subscribers
+ </Label>
+ </div>
+ <Button
+ size="sm"
+ className="ml-auto"
+ disabled={disabled}
+ onClick={() => submit().catch(console.error)}
+ >
+ Publish update
+ </Button>
+ </div>
+ </ComposerFooter>
+ </Composer>
+ </TimelineItem>
+ );
+}
diff --git a/apps/dashboard/src/components/maintenances/maintenance-update-timeline.tsx b/apps/dashboard/src/components/maintenances/maintenance-update-timeline.tsx
new file mode 100644
index 000000000..f6fae2163
--- /dev/null
+++ b/apps/dashboard/src/components/maintenances/maintenance-update-timeline.tsx
@@ -0,0 +1,101 @@
+"use client";
+
+import type { RouterOutputs } from "@openstatus/api";
+import { Maintenance as MaintenanceIcon } from "@openstatus/icons";
+import { useMutation } from "@tanstack/react-query";
+import { useState } from "react";
+
+import { ProcessMessage } from "@/components/content/process-message";
+import {
+ TimelineActor,
+ TimelineBody,
+ TimelineContent,
+ TimelineHeader,
+ TimelineIndicator,
+ TimelineItem,
+ TimelineMeta,
+ TimelineTime,
+ TimelineTitle,
+} from "@/components/content/timeline";
+import { QuickActions } from "@/components/dropdowns/quick-actions";
+import { FormSheetMaintenanceUpdate } from "@/components/forms/maintenance-update/sheet";
+import { distinctEditor } from "@/data/attribution.client";
+import { getActions } from "@/data/maintenances.client";
+import { useTRPC } from "@/lib/trpc/client";
+
+import { useInvalidateMaintenance } from "./use-invalidate-maintenance";
+
+type Maintenance = NonNullable<RouterOutputs["maintenance"]["get"]>;
+type MaintenanceUpdate = Maintenance["updates"][number];
+
+export function MaintenanceUpdateTimelineItem({
+ maintenance,
+ update,
+ index,
+}: {
+ maintenance: Maintenance;
+ update: MaintenanceUpdate;
+ /** 1-based, counted from the oldest update. */
+ index: number;
+}) {
+ const trpc = useTRPC();
+ const [editing, setEditing] = useState(false);
+ const invalidate = useInvalidateMaintenance(maintenance.id);
+ const edit = useMutation(
+ trpc.maintenance.updateUpdate.mutationOptions({ onSuccess: invalidate }),
+ );
+ const remove = useMutation(
+ trpc.maintenance.deleteUpdate.mutationOptions({ onSuccess: invalidate }),
+ );
+ const author = update.createdByUser;
+ const editor = distinctEditor(update);
+
+ return (
+ <TimelineItem>
+ <TimelineIndicator variant="info">
+ <MaintenanceIcon />
+ </TimelineIndicator>
+ <TimelineContent>
+ <TimelineHeader>
+ <TimelineTitle>
+ <span>Update</span>
+ {author ? <TimelineActor actor={author} /> : null}
+ {editor ? (
+ <TimelineMeta className="inline-flex items-center gap-1.5">
+ edited by <TimelineActor actor={editor} />
+ </TimelineMeta>
+ ) : null}
+ </TimelineTitle>
+ <TimelineTime date={update.date} />
+ </TimelineHeader>
+ <TimelineBody className="prose prose-sm dark:prose-invert max-w-none">
+ <ProcessMessage value={update.message} />
+ </TimelineBody>
+ <div className="text-muted-foreground flex items-center justify-between gap-2 font-mono text-xs">
+ <span>#{index}</span>
+ <QuickActions
+ actions={getActions({ edit: () => setEditing(true) })}
+ deleteAction={{
+ description: `Permanently remove update #${index} from the status page.`,
+ submitAction: async () => {
+ await remove.mutateAsync({ id: update.id });
+ },
+ }}
+ />
+ </div>
+ </TimelineContent>
+ <FormSheetMaintenanceUpdate
+ open={editing}
+ onOpenChange={setEditing}
+ defaultValues={{ message: update.message, date: update.date }}
+ onSubmit={async (values) => {
+ await edit.mutateAsync({
+ id: update.id,
+ message: values.message,
+ date: values.date,
+ });
+ }}
+ />
+ </TimelineItem>
+ );
+}
diff --git a/apps/dashboard/src/components/maintenances/use-publish-maintenance-update.ts b/apps/dashboard/src/components/maintenances/use-publish-maintenance-update.ts
new file mode 100644
index 000000000..77e45ad06
--- /dev/null
+++ b/apps/dashboard/src/components/maintenances/use-publish-maintenance-update.ts
@@ -0,0 +1,54 @@
+"use client";
+
+import { useMutation } from "@tanstack/react-query";
+import { useState } from "react";
+import { toast } from "sonner";
+
+import { useTRPC } from "@/lib/trpc/client";
+import { errorMessage } from "@/lib/trpc/error";
+
+import { useInvalidateMaintenance } from "./use-invalidate-maintenance";
+
+/**
+ * Posts a maintenance update, notifies subscribers when asked, then refetches.
+ * The update is persisted before notifying, so a notification failure is
+ * reported on its own and never rejects the publish. `isPending` stays true
+ * through the refetch so the same message cannot be submitted twice.
+ */
+export function usePublishMaintenanceUpdate(maintenanceId: number) {
+ const trpc = useTRPC();
+ const invalidate = useInvalidateMaintenance(maintenanceId);
+ const create = useMutation(trpc.maintenance.createUpdate.mutationOptions());
+ const notify = useMutation(
+ trpc.subscriberNotification.maintenance.mutationOptions(),
+ );
+ const [isPending, setIsPending] = useState(false);
+
+ return {
+ isPending,
+ async publish(input: {
+ message: string;
+ date: Date;
+ notifySubscribers: boolean;
+ }) {
+ setIsPending(true);
+ try {
+ const update = await create.mutateAsync({ maintenanceId, ...input });
+ if (update && input.notifySubscribers) {
+ const fallback =
+ "Update published, but subscribers were not notified";
+ try {
+ // resolves with success=false when the plan lacks subscribers
+ const result = await notify.mutateAsync({ id: update.id });
+ if (!result.success) toast.error(fallback);
+ } catch (error) {
+ toast.error(errorMessage(error, fallback));
+ }
+ }
+ await invalidate();
+ } finally {
+ setIsPending(false);
+ }
+ },
+ };
+}
diff --git a/apps/dashboard/src/components/maintenances/use-update-maintenance.ts b/apps/dashboard/src/components/maintenances/use-update-maintenance.ts
index 93baf4772..5375c900c 100644
--- a/apps/dashboard/src/components/maintenances/use-update-maintenance.ts
+++ b/apps/dashboard/src/components/maintenances/use-update-maintenance.ts
@@ -47,7 +47,6 @@ export function useUpdateMaintenance(
queryClient.setQueryData(queryKey, {
...maintenance,
title: input.title,
- message: input.message,
from: input.startDate,
to: input.endDate,
pageComponentIds: input.pageComponents ?? maintenance.pageComponentIds,
diff --git a/apps/dashboard/src/components/ui/data-table/data-table.tsx b/apps/dashboard/src/components/ui/data-table/data-table.tsx
index 332056ddd..06d616275 100644
--- a/apps/dashboard/src/components/ui/data-table/data-table.tsx
+++ b/apps/dashboard/src/components/ui/data-table/data-table.tsx
@@ -168,7 +168,11 @@ export function DataTable<TData, TValue>({
data-state={
(row.getIsSelected() || row.getIsExpanded()) && "selected"
}
- onClick={() => onRowClick?.(row)}
+ onClick={(e) => {
+ // nested links/buttons own their click
+ if ((e.target as HTMLElement).closest("a,button")) return;
+ onRowClick?.(row);
+ }}
className="data-[state=selected]:bg-muted/50"
>
{row.getVisibleCells().map((cell) => (
diff --git a/apps/dashboard/src/data/maintenances.client.ts b/apps/dashboard/src/data/maintenances.client.ts
index 82ee52518..04d3ad714 100644
--- a/apps/dashboard/src/data/maintenances.client.ts
+++ b/apps/dashboard/src/data/maintenances.client.ts
@@ -34,7 +34,6 @@ export function toUpdateInput(maintenance: Maintenance) {
return {
id: maintenance.id,
title: maintenance.title,
- message: maintenance.message,
startDate: maintenance.from,
endDate: maintenance.to,
pageComponents: maintenance.pageComponentIds,
diff --git a/apps/server/src/routes/mcp/handler.test.ts b/apps/server/src/routes/mcp/handler.test.ts
index c47cc5e45..d843a3576 100644
--- a/apps/server/src/routes/mcp/handler.test.ts
+++ b/apps/server/src/routes/mcp/handler.test.ts
@@ -120,11 +120,13 @@ describe("MCP transport", () => {
const names = tools.map((t) => t.name).sort();
expect(names).toEqual([
"add_incident_note",
+ "add_maintenance_update",
"add_status_report_update",
"approve_postmortem",
"create_maintenance",
"create_status_report",
"declare_incident",
+ "delete_maintenance_update",
"draft_postmortem",
"get_audit_log",
"get_content_page",
@@ -151,6 +153,7 @@ describe("MCP transport", () => {
"search_docs",
"set_incident_status",
"update_incident",
+ "update_maintenance_update",
"update_status_report",
]);
});
diff --git a/apps/server/src/routes/mcp/tools/maintenance.ts b/apps/server/src/routes/mcp/tools/maintenance.ts
index f038a0392..b877fa6ec 100644
--- a/apps/server/src/routes/mcp/tools/maintenance.ts
+++ b/apps/server/src/routes/mcp/tools/maintenance.ts
@@ -4,8 +4,11 @@ import type {
} from "@modelcontextprotocol/sdk/server/mcp.js";
import type { ServiceContext } from "@openstatus/services";
import {
+ addMaintenanceUpdateTool,
createMaintenanceTool,
+ deleteMaintenanceUpdateTool,
listMaintenancesTool,
+ updateMaintenanceUpdateTool,
} from "@openstatus/services/agent-tools";
import { registerRegistryTools } from "./registry-adapter";
@@ -17,5 +20,8 @@ export function registerMaintenanceTools(
return registerRegistryTools(server, ctx, [
listMaintenancesTool,
createMaintenanceTool,
+ addMaintenanceUpdateTool,
+ updateMaintenanceUpdateTool,
+ deleteMaintenanceUpdateTool,
]);
}
diff --git a/apps/server/src/routes/mcp/tools/tools.test.ts b/apps/server/src/routes/mcp/tools/tools.test.ts
index c3b38ac9b..6755d1874 100644
--- a/apps/server/src/routes/mcp/tools/tools.test.ts
+++ b/apps/server/src/routes/mcp/tools/tools.test.ts
@@ -653,6 +653,9 @@ describe("scope filter", () => {
expect(reportTools.has("update_status_report")).toBe(false);
expect(reportTools.has("resolve_status_report")).toBe(false);
expect(maintenanceTools.has("create_maintenance")).toBe(false);
+ expect(maintenanceTools.has("add_maintenance_update")).toBe(false);
+ expect(maintenanceTools.has("update_maintenance_update")).toBe(false);
+ expect(maintenanceTools.has("delete_maintenance_update")).toBe(false);
});
test("write key sees both read and write tools", () => {
diff --git a/apps/server/src/routes/rpc/handlers/maintenance/__tests__/maintenance.test.ts b/apps/server/src/routes/rpc/handlers/maintenance/__tests__/maintenance.test.ts
index 67d7b6dde..ad72c9a60 100644
--- a/apps/server/src/routes/rpc/handlers/maintenance/__tests__/maintenance.test.ts
+++ b/apps/server/src/routes/rpc/handlers/maintenance/__tests__/maintenance.test.ts
@@ -1,6 +1,7 @@
import { db, eq } from "@openstatus/db";
import {
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
page,
pageComponent,
@@ -154,6 +155,14 @@ beforeAll(async () => {
.returning()
.get();
testMaintenanceId = maintenanceRecord.id;
+ await db
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: maintenanceRecord.id,
+ message: "Test maintenance message",
+ date: new Date(),
+ })
+ .run();
// Create page component association
await db.insert(maintenancesToPageComponents).values({
@@ -175,6 +184,14 @@ beforeAll(async () => {
.returning()
.get();
testMaintenanceToDeleteId = deleteRecord.id;
+ await db
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: deleteRecord.id,
+ message: "Maintenance to delete",
+ date: new Date(),
+ })
+ .run();
// Create maintenance to update
const updateRecord = await db
@@ -190,6 +207,14 @@ beforeAll(async () => {
.returning()
.get();
testMaintenanceToUpdateId = updateRecord.id;
+ await db
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: updateRecord.id,
+ message: "Maintenance to update",
+ date: new Date(),
+ })
+ .run();
await db.insert(maintenancesToPageComponents).values({
maintenanceId: updateRecord.id,
@@ -370,6 +395,28 @@ describe("MaintenanceService.CreateMaintenance", () => {
expect(res.status).toBe(404);
});
+ test("rejects page component ids that are not plain decimal digits", async () => {
+ const fromDate = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000);
+ const toDate = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000 + 3600000);
+
+ for (const id of ["1e3", "0x10", "1.5", ""]) {
+ const res = await connectRequest(
+ "CreateMaintenance",
+ {
+ title: "Malformed component id",
+ message: "Test message",
+ from: fromDate.toISOString(),
+ to: toDate.toISOString(),
+ pageId: String(testPageId),
+ pageComponentIds: [id],
+ },
+ { "x-openstatus-key": authKey },
+ );
+ expect(res.status).toBe(400);
+ expect((await res.json()).code).toBe("invalid_argument");
+ }
+ });
+
test("returns error when page components are from different pages", async () => {
const fromDate = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000);
const toDate = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000 + 3600000);
@@ -528,9 +575,13 @@ describe("MaintenanceService.CreateMaintenance", () => {
expect(data.maintenance.title).toBe(`${TEST_PREFIX}-with-notify`);
// Verify dispatcher was called (dispatchers are mocked in preload.ts)
+ // the announcement is the first update, not the maintenance row
expect(subscriptionSpies.dispatchMaintenanceUpdate).toHaveBeenCalledTimes(
1,
);
+ expect(subscriptionSpies.dispatchMaintenanceUpdate).toHaveBeenCalledWith(
+ Number(data.maintenance.updates[0].id),
+ );
// Clean up
await db
@@ -672,6 +723,7 @@ describe("MaintenanceService.GetMaintenance", () => {
expect(data.maintenance).toHaveProperty("updatedAt");
expect(data.maintenance).toHaveProperty("from");
expect(data.maintenance).toHaveProperty("to");
+ expect(Array.isArray(data.maintenance.updates)).toBe(true);
});
test("returns 401 when no auth key provided", async () => {
@@ -682,6 +734,35 @@ describe("MaintenanceService.GetMaintenance", () => {
expect(res.status).toBe(401);
});
+ test("rejects ids that are not plain decimal digits", async () => {
+ const calls: Array<[string, Record<string, unknown>]> = [
+ ["GetMaintenance", { id: "1e3" }],
+ [
+ "CreateMaintenance",
+ {
+ title: "x",
+ message: "x",
+ from: "2026-10-09T00:00:00Z",
+ to: "2026-10-10T00:00:00Z",
+ pageId: "1e3",
+ pageComponentIds: [],
+ },
+ ],
+ ["ListMaintenances", { pageId: "0x10" }],
+ ["DeleteMaintenance", { id: "0x10" }],
+ ["AddMaintenanceUpdate", { maintenanceId: "1.5", message: "x" }],
+ ["UpdateMaintenanceUpdate", { id: "1e3", message: "x" }],
+ ["DeleteMaintenanceUpdate", { id: "0x10" }],
+ ];
+ for (const [method, body] of calls) {
+ const res = await connectRequest(method, body, {
+ "x-openstatus-key": authKey,
+ });
+ expect(res.status).toBe(400);
+ expect((await res.json()).code).toBe("invalid_argument");
+ }
+ });
+
test("returns 404 for non-existent maintenance", async () => {
const res = await connectRequest(
"GetMaintenance",
@@ -740,6 +821,108 @@ describe("MaintenanceService.GetMaintenance", () => {
});
});
+describe("MaintenanceService maintenance update CRUD", () => {
+ test("adds, updates, and deletes timeline entries", async () => {
+ const first = await connectRequest(
+ "AddMaintenanceUpdate",
+ {
+ maintenanceId: String(testMaintenanceId),
+ message: "First timeline entry",
+ notify: false,
+ },
+ { "x-openstatus-key": authKey },
+ );
+ expect(first.status).toBe(200);
+
+ const second = await connectRequest(
+ "AddMaintenanceUpdate",
+ {
+ maintenanceId: String(testMaintenanceId),
+ message: "Second timeline entry",
+ notify: false,
+ },
+ { "x-openstatus-key": authKey },
+ );
+ expect(second.status).toBe(200);
+ const created = await second.json();
+
+ const updated = await connectRequest(
+ "UpdateMaintenanceUpdate",
+ {
+ id: created.maintenanceUpdate.id,
+ message: "Corrected timeline entry",
+ },
+ { "x-openstatus-key": authKey },
+ );
+ expect(updated.status).toBe(200);
+ expect((await updated.json()).maintenanceUpdate.message).toBe(
+ "Corrected timeline entry",
+ );
+
+ const deleted = await connectRequest(
+ "DeleteMaintenanceUpdate",
+ { id: created.maintenanceUpdate.id },
+ { "x-openstatus-key": authKey },
+ );
+ expect(deleted.status).toBe(200);
+ expect(await deleted.json()).toEqual({ success: true });
+
+ const firstDeleted = await connectRequest(
+ "DeleteMaintenanceUpdate",
+ { id: (await first.json()).maintenanceUpdate.id },
+ { "x-openstatus-key": authKey },
+ );
+ expect(firstDeleted.status).toBe(200);
+ });
+
+ test("refuses to delete the last update", async () => {
+ const full = await connectRequest(
+ "GetMaintenance",
+ { id: String(testMaintenanceId) },
+ { "x-openstatus-key": authKey },
+ );
+ const { updates } = (await full.json()).maintenance;
+ expect(updates).toHaveLength(1);
+
+ const res = await connectRequest(
+ "DeleteMaintenanceUpdate",
+ { id: updates[0].id },
+ { "x-openstatus-key": authKey },
+ );
+ expect(res.status).toBe(400);
+ expect((await res.json()).message).toContain("at least one update");
+ });
+
+ test("scopes update mutations to the authenticated workspace", async () => {
+ const otherMaintenance = await db
+ .insert(maintenance)
+ .values({
+ workspaceId: OTHER_WORKSPACE_ID,
+ title: `${TEST_PREFIX}-other-update`,
+ message: "Other",
+ from: new Date(Date.now() + 1000),
+ to: new Date(Date.now() + 2000),
+ })
+ .returning()
+ .get();
+ try {
+ const res = await connectRequest(
+ "AddMaintenanceUpdate",
+ {
+ maintenanceId: String(otherMaintenance.id),
+ message: "Not allowed",
+ },
+ { "x-openstatus-key": authKey },
+ );
+ expect(res.status).toBe(404);
+ } finally {
+ await db
+ .delete(maintenance)
+ .where(eq(maintenance.id, otherMaintenance.id));
+ }
+ });
+});
+
describe("MaintenanceService.ListMaintenances", () => {
test("returns maintenances for authenticated workspace", async () => {
const res = await connectRequest(
@@ -921,12 +1104,16 @@ describe("MaintenanceService.UpdateMaintenance", () => {
const data = await res.json();
expect(data.maintenance.message).toBe("Updated maintenance message");
+ // rewrites the newest update instead of appending one
+ expect(
+ data.maintenance.updates.map((u: { message: string }) => u.message),
+ ).toEqual(["Updated maintenance message"]);
// Restore original message
await db
- .update(maintenance)
+ .update(maintenanceUpdate)
.set({ message: "Maintenance to update" })
- .where(eq(maintenance.id, testMaintenanceToUpdateId));
+ .where(eq(maintenanceUpdate.maintenanceId, testMaintenanceToUpdateId));
});
test("updates page component associations", async () => {
diff --git a/apps/server/src/routes/rpc/handlers/maintenance/converters.ts b/apps/server/src/routes/rpc/handlers/maintenance/converters.ts
index 956342655..9f811dc7c 100644
--- a/apps/server/src/routes/rpc/handlers/maintenance/converters.ts
+++ b/apps/server/src/routes/rpc/handlers/maintenance/converters.ts
@@ -1,6 +1,7 @@
import type {
Maintenance,
MaintenanceSummary,
+ MaintenanceUpdate,
} from "@openstatus/proto/maintenance/v1";
type DBMaintenance = {
@@ -42,6 +43,7 @@ export function dbMaintenanceToProtoSummary(
export function dbMaintenanceToProto(
maintenance: DBMaintenance,
pageComponentIds: string[],
+ updates: DBMaintenanceUpdate[],
): Maintenance {
return {
$typeName: "openstatus.maintenance.v1.Maintenance" as const,
@@ -54,5 +56,29 @@ export function dbMaintenanceToProto(
pageComponentIds,
createdAt: maintenance.createdAt?.toISOString() ?? "",
updatedAt: maintenance.updatedAt?.toISOString() ?? "",
+ updates: updates.map(dbMaintenanceUpdateToProto),
+ };
+}
+
+type DBMaintenanceUpdate = {
+ id: number;
+ message: string;
+ date: Date;
+ maintenanceId: number;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+};
+
+export function dbMaintenanceUpdateToProto(
+ update: DBMaintenanceUpdate,
+): MaintenanceUpdate {
+ return {
+ $typeName: "openstatus.maintenance.v1.MaintenanceUpdate" as const,
+ id: String(update.id),
+ message: update.message,
+ date: update.date.toISOString(),
+ maintenanceId: String(update.maintenanceId),
+ createdAt: update.createdAt?.toISOString() ?? "",
+ updatedAt: update.updatedAt?.toISOString() ?? "",
};
}
diff --git a/apps/server/src/routes/rpc/handlers/maintenance/errors.ts b/apps/server/src/routes/rpc/handlers/maintenance/errors.ts
index ab1a6d184..15b37181a 100644
--- a/apps/server/src/routes/rpc/handlers/maintenance/errors.ts
+++ b/apps/server/src/routes/rpc/handlers/maintenance/errors.ts
@@ -6,6 +6,7 @@ import { Code, ConnectError } from "@connectrpc/connect";
export const ErrorReason = {
MAINTENANCE_NOT_FOUND: "MAINTENANCE_NOT_FOUND",
MAINTENANCE_ID_REQUIRED: "MAINTENANCE_ID_REQUIRED",
+ MAINTENANCE_UPDATE_ID_REQUIRED: "MAINTENANCE_UPDATE_ID_REQUIRED",
MAINTENANCE_CREATE_FAILED: "MAINTENANCE_CREATE_FAILED",
MAINTENANCE_UPDATE_FAILED: "MAINTENANCE_UPDATE_FAILED",
INVALID_DATE_FORMAT: "INVALID_DATE_FORMAT",
@@ -62,6 +63,17 @@ export function maintenanceIdRequiredError(): ConnectError {
);
}
+/**
+ * Creates a "maintenance update ID required" error.
+ */
+export function maintenanceUpdateIdRequiredError(): ConnectError {
+ return createError(
+ "Maintenance update ID is required",
+ Code.InvalidArgument,
+ ErrorReason.MAINTENANCE_UPDATE_ID_REQUIRED,
+ );
+}
+
/**
* Creates a "failed to create maintenance" error.
*/
diff --git a/apps/server/src/routes/rpc/handlers/maintenance/index.ts b/apps/server/src/routes/rpc/handlers/maintenance/index.ts
index ac2721897..10ce4a2ba 100644
--- a/apps/server/src/routes/rpc/handlers/maintenance/index.ts
+++ b/apps/server/src/routes/rpc/handlers/maintenance/index.ts
@@ -1,12 +1,15 @@
import { Code, ConnectError, type ServiceImpl } from "@connectrpc/connect";
import type { MaintenanceService } from "@openstatus/proto/maintenance/v1";
import {
+ addMaintenanceUpdate,
createMaintenance,
deleteMaintenance,
+ deleteMaintenanceUpdate,
getMaintenance,
listMaintenances,
notifyMaintenance,
updateMaintenance,
+ updateMaintenanceUpdate,
} from "@openstatus/services/maintenance";
import { toConnectError, toServiceCtx } from "../../adapter";
@@ -14,8 +17,13 @@ import { getRpcContext } from "../../interceptors";
import {
dbMaintenanceToProto,
dbMaintenanceToProtoSummary,
+ dbMaintenanceUpdateToProto,
} from "./converters";
-import { invalidDateFormatError, maintenanceIdRequiredError } from "./errors";
+import {
+ invalidDateFormatError,
+ maintenanceIdRequiredError,
+ maintenanceUpdateIdRequiredError,
+} from "./errors";
function parseDate(dateString: string): Date {
const date = new Date(dateString);
@@ -25,23 +33,23 @@ function parseDate(dateString: string): Date {
return date;
}
+// `Number("1e3")` is 1000 and `Number("0x10")` is 16 — both would silently
+// target another row, so only plain decimal digits are accepted.
+const DECIMAL_ID = /^\d+$/;
+
+function parseId(value: string, label: string): number {
+ const trimmed = value.trim();
+ if (!DECIMAL_ID.test(trimmed)) {
+ throw new ConnectError(
+ `Invalid ${label}: "${value}"`,
+ Code.InvalidArgument,
+ );
+ }
+ return Number(trimmed);
+}
+
function parsePageComponentIds(ids: ReadonlyArray<string>): number[] {
- return ids.map((id) => {
- // `Number.parseInt(id, 10)` rather than `Number(id)` — `Number("")`
- // is `0` (finite!), so the previous guard silently coerced an
- // empty-string id into component 0 and the service's
- // `NotFoundError` ended up as a misleading 404 on the wire.
- // `parseInt` returns NaN for `""`, which fails the finite check
- // and surfaces the correct `InvalidArgument` here.
- const n = Number.parseInt(id, 10);
- if (!Number.isFinite(n)) {
- throw new ConnectError(
- `Invalid page component id: "${id}"`,
- Code.InvalidArgument,
- );
- }
- return n;
- });
+ return ids.map((id) => parseId(id, "page component id"));
}
export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
@@ -50,14 +58,14 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
const rpcCtx = getRpcContext(ctx);
const sCtx = toServiceCtx(rpcCtx);
- const record = await createMaintenance({
+ const { maintenance: record, initialUpdate } = await createMaintenance({
ctx: sCtx,
input: {
title: req.title,
message: req.message,
from: parseDate(req.from),
to: parseDate(req.to),
- pageId: Number(req.pageId),
+ pageId: parseId(req.pageId, "page id"),
pageComponentIds: parsePageComponentIds(req.pageComponentIds),
},
});
@@ -76,7 +84,7 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
// that affordance.
await notifyMaintenance({
ctx: sCtx,
- input: { maintenanceId: record.id },
+ input: { maintenanceUpdateId: initialUpdate.id },
});
}
@@ -91,6 +99,7 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
maintenance: dbMaintenanceToProto(
full,
full.pageComponentIds.map(String),
+ full.updates,
),
};
} catch (err) {
@@ -106,12 +115,13 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
}
const full = await getMaintenance({
ctx: toServiceCtx(rpcCtx),
- input: { id: Number(req.id) },
+ input: { id: parseId(req.id, "maintenance id") },
});
return {
maintenance: dbMaintenanceToProto(
full,
full.pageComponentIds.map(String),
+ full.updates,
),
};
} catch (err) {
@@ -123,8 +133,9 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
try {
const rpcCtx = getRpcContext(ctx);
- const pageId =
- req.pageId && req.pageId.trim() !== "" ? Number(req.pageId) : undefined;
+ const pageId = req.pageId?.trim()
+ ? parseId(req.pageId, "page id")
+ : undefined;
const { items, totalSize } = await listMaintenances({
ctx: toServiceCtx(rpcCtx),
@@ -155,7 +166,7 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
throw maintenanceIdRequiredError();
}
- const id = Number(req.id);
+ const id = parseId(req.id, "maintenance id");
await updateMaintenance({
ctx: sCtx,
input: {
@@ -179,6 +190,7 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
maintenance: dbMaintenanceToProto(
full,
full.pageComponentIds.map(String),
+ full.updates,
),
};
} catch (err) {
@@ -194,7 +206,70 @@ export const maintenanceServiceImpl: ServiceImpl<typeof MaintenanceService> = {
}
await deleteMaintenance({
ctx: toServiceCtx(rpcCtx),
- input: { id: Number(req.id) },
+ input: { id: parseId(req.id, "maintenance id") },
+ });
+ return { success: true };
+ } catch (err) {
+ toConnectError(err);
+ }
+ },
+
+ async addMaintenanceUpdate(req, ctx) {
+ try {
+ const rpcCtx = getRpcContext(ctx);
+ const sCtx = toServiceCtx(rpcCtx);
+ if (!req.maintenanceId?.trim()) {
+ throw maintenanceIdRequiredError();
+ }
+ const update = await addMaintenanceUpdate({
+ ctx: sCtx,
+ input: {
+ maintenanceId: parseId(req.maintenanceId, "maintenance id"),
+ message: req.message,
+ date: req.date ? parseDate(req.date) : undefined,
+ },
+ });
+ if (req.notify) {
+ await notifyMaintenance({
+ ctx: sCtx,
+ input: { maintenanceUpdateId: update.id },
+ });
+ }
+ return { maintenanceUpdate: dbMaintenanceUpdateToProto(update) };
+ } catch (err) {
+ toConnectError(err);
+ }
+ },
+
+ async updateMaintenanceUpdate(req, ctx) {
+ try {
+ const rpcCtx = getRpcContext(ctx);
+ if (!req.id?.trim()) {
+ throw maintenanceUpdateIdRequiredError();
+ }
+ const update = await updateMaintenanceUpdate({
+ ctx: toServiceCtx(rpcCtx),
+ input: {
+ id: parseId(req.id, "maintenance update id"),
+ message: req.message,
+ date: req.date ? parseDate(req.date) : undefined,
+ },
+ });
+ return { maintenanceUpdate: dbMaintenanceUpdateToProto(update) };
+ } catch (err) {
+ toConnectError(err);
+ }
+ },
+
+ async deleteMaintenanceUpdate(req, ctx) {
+ try {
+ const rpcCtx = getRpcContext(ctx);
+ if (!req.id?.trim()) {
+ throw maintenanceUpdateIdRequiredError();
+ }
+ await deleteMaintenanceUpdate({
+ ctx: toServiceCtx(rpcCtx),
+ input: { id: parseId(req.id, "maintenance update id") },
});
return { success: true };
} catch (err) {
diff --git a/apps/server/src/routes/rpc/interceptors/tracking.ts b/apps/server/src/routes/rpc/interceptors/tracking.ts
index 4db826c18..82438545e 100644
--- a/apps/server/src/routes/rpc/interceptors/tracking.ts
+++ b/apps/server/src/routes/rpc/interceptors/tracking.ts
@@ -123,6 +123,15 @@ export const RPC_EVENT_MAP: Record<string, RpcEventMapping> = {
"openstatus.maintenance.v1.MaintenanceService/DeleteMaintenance": {
event: Events.DeleteMaintenance,
},
+ "openstatus.maintenance.v1.MaintenanceService/AddMaintenanceUpdate": {
+ event: Events.CreateMaintenanceUpdate,
+ },
+ "openstatus.maintenance.v1.MaintenanceService/UpdateMaintenanceUpdate": {
+ event: Events.UpdateMaintenanceUpdate,
+ },
+ "openstatus.maintenance.v1.MaintenanceService/DeleteMaintenanceUpdate": {
+ event: Events.DeleteMaintenanceUpdate,
+ },
// NotificationService
"openstatus.notification.v1.NotificationService/CreateNotification": {
diff --git a/apps/server/src/routes/slack/system-prompt.ts b/apps/server/src/routes/slack/system-prompt.ts
index 3b3cf9dbb..170c81ead 100644
--- a/apps/server/src/routes/slack/system-prompt.ts
+++ b/apps/server/src/routes/slack/system-prompt.ts
@@ -39,7 +39,7 @@ REPLY STYLE — this is Slack, not a document. Be brief and direct.
- Include only the details that answer the question. Skip caveats and background nobody asked for.
HOW APPROVAL WORKS HERE — read this before any write tool:
-Calling a write tool (create_status_report, add_status_report_update, update_status_report, resolve_status_report, create_maintenance) does NOT execute it. It renders an approval card in Slack with Approve/Cancel buttons, and nothing is created, published, or notified until the user clicks Approve. The card IS how you ask.
+Calling a write tool (create_status_report, add_status_report_update, update_status_report, resolve_status_report, create_maintenance, add_maintenance_update, update_maintenance_update, delete_maintenance_update) does NOT execute it. It renders an approval card in Slack with Approve/Cancel buttons, and nothing is created, published, or notified until the user clicks Approve. The card IS how you ask.
- Call the tool as soon as you have the ids it needs. That is the ONLY way the user gets a card.
- NEVER write the draft out as message text (a "**Title:** … **Message:** …" block) instead of calling the tool.
- NEVER end your turn with "shall I go ahead?", "want me to publish this?", or any other request for permission to call a write tool. The buttons already ask that question; a prose question leaves the user with nothing to click.
@@ -69,6 +69,7 @@ Status pages and incidents (write tools render an approval card):
- Edit report metadata like title or components (update_status_report)
- Resolve active reports (resolve_status_report)
- Schedule maintenance windows (create_maintenance)
+- Post, edit or remove dated updates on a maintenance window (add_maintenance_update, update_maintenance_update, delete_maintenance_update)
- List status pages, page components, status reports, and maintenance windows (list_status_pages, list_page_components, list_status_reports, list_maintenances)
Monitoring (read-only):
- List monitors and read one monitor's config (list_monitors, get_monitor)
diff --git a/apps/server/src/routes/v1/maintenances/get.ts b/apps/server/src/routes/v1/maintenances/get.ts
index 5e57e7f23..1964dc6f4 100644
--- a/apps/server/src/routes/v1/maintenances/get.ts
+++ b/apps/server/src/routes/v1/maintenances/get.ts
@@ -7,6 +7,7 @@ import { notEmpty } from "@/utils/not-empty";
import type { maintenancesApi } from "./index";
import { MaintenanceSchema, ParamsSchema } from "./schema";
+import { withLatestMessage } from "./updates";
const getRoute = createRoute({
method: "get",
@@ -37,6 +38,7 @@ export function registerGetMaintenance(api: typeof maintenancesApi) {
const _maintenance = await db.query.maintenance.findFirst({
with: {
maintenancesToPageComponents: { with: { pageComponent: true } },
+ maintenanceUpdates: true,
},
where: and(
eq(maintenance.id, Number(id)),
@@ -52,7 +54,7 @@ export function registerGetMaintenance(api: typeof maintenancesApi) {
}
const data = MaintenanceSchema.parse({
- ..._maintenance,
+ ...withLatestMessage(_maintenance),
monitorIds: _maintenance.maintenancesToPageComponents
.map((m) => m.pageComponent.monitorId)
.filter(notEmpty),
diff --git a/apps/server/src/routes/v1/maintenances/get_all.ts b/apps/server/src/routes/v1/maintenances/get_all.ts
index cc0e166c5..5ad76c0cd 100644
--- a/apps/server/src/routes/v1/maintenances/get_all.ts
+++ b/apps/server/src/routes/v1/maintenances/get_all.ts
@@ -7,6 +7,7 @@ import { notEmpty } from "@/utils/not-empty";
import type { maintenancesApi } from "./index";
import { MaintenanceSchema } from "./schema";
+import { withLatestMessage } from "./updates";
const getAllRoute = createRoute({
method: "get",
@@ -34,6 +35,7 @@ export function registerGetAllMaintenances(api: typeof maintenancesApi) {
const _maintenances = await db.query.maintenance.findMany({
with: {
maintenancesToPageComponents: { with: { pageComponent: true } },
+ maintenanceUpdates: true,
},
where: eq(maintenance.workspaceId, workspaceId),
orderBy: desc(maintenance.createdAt),
@@ -41,7 +43,7 @@ export function registerGetAllMaintenances(api: typeof maintenancesApi) {
const data = MaintenanceSchema.array().parse(
_maintenances.map((m) => ({
- ...m,
+ ...withLatestMessage(m),
monitorIds: m.maintenancesToPageComponents
.map((mtm) => mtm.pageComponent.monitorId)
.filter(notEmpty),
diff --git a/apps/server/src/routes/v1/maintenances/post.test.ts b/apps/server/src/routes/v1/maintenances/post.test.ts
index d4fd15fe8..e6312a1d7 100644
--- a/apps/server/src/routes/v1/maintenances/post.test.ts
+++ b/apps/server/src/routes/v1/maintenances/post.test.ts
@@ -221,7 +221,7 @@ test("no auth key should return 401", async () => {
expect(res.status).toBe(401);
});
-test("create a maintenance calls dispatchMaintenanceUpdate", async () => {
+test("create a maintenance dispatches its first update", async () => {
const from = new Date();
const to = new Date(from.getTime() + 3600000);
@@ -253,3 +253,26 @@ test("create a maintenance calls dispatchMaintenanceUpdate", async () => {
await db.delete(maintenance).where(eq(maintenance.id, result.data.id));
}
});
+
+test("create a maintenance with an empty message should return 400", async () => {
+ const from = new Date();
+ const to = new Date(from.getTime() + 3600000);
+
+ const res = await app.request("/v1/maintenance", {
+ method: "POST",
+ headers: {
+ "x-openstatus-key": "1",
+ "content-type": "application/json",
+ },
+ body: JSON.stringify({
+ title: "Empty Message",
+ message: "",
+ from: from.toISOString(),
+ to: to.toISOString(),
+ monitorIds: [1],
+ pageId: 1,
+ }),
+ });
+
+ expect(res.status).toBe(400);
+});
diff --git a/apps/server/src/routes/v1/maintenances/post.ts b/apps/server/src/routes/v1/maintenances/post.ts
index 79abf3f98..93c2da82e 100644
--- a/apps/server/src/routes/v1/maintenances/post.ts
+++ b/apps/server/src/routes/v1/maintenances/post.ts
@@ -2,7 +2,10 @@ import { createRoute } from "@hono/zod-openapi";
import { Events } from "@openstatus/analytics";
import { and, db, eq, inArray, isNull } from "@openstatus/db";
import { monitor, page } from "@openstatus/db/src/schema";
-import { maintenance } from "@openstatus/db/src/schema/maintenances";
+import {
+ maintenance,
+ maintenanceUpdate,
+} from "@openstatus/db/src/schema/maintenances";
import {
maintenancesToPageComponents,
pageComponent,
@@ -111,6 +114,19 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
.returning()
.get();
+ // the message is the first timeline update; the column is a mirror
+ const initialUpdate = await tx
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: newMaintenance.id,
+ message: input.message,
+ date: new Date(),
+ createdBy: actorUserId,
+ updatedBy: actorUserId,
+ })
+ .returning({ id: maintenanceUpdate.id })
+ .get();
+
if (monitorIds?.length && newMaintenance.pageId) {
// Get page components for the given monitors and page
const pageComponents = await tx
@@ -138,11 +154,11 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
}
}
- return newMaintenance;
+ return { ...newMaintenance, initialUpdateId: initialUpdate.id };
});
if (limits["status-subscribers"] && _newMaintenance.pageId) {
- await dispatchMaintenanceUpdate(_newMaintenance.id);
+ await dispatchMaintenanceUpdate(_newMaintenance.initialUpdateId);
}
const data = MaintenanceSchema.parse({
diff --git a/apps/server/src/routes/v1/maintenances/put.ts b/apps/server/src/routes/v1/maintenances/put.ts
index c36e303e7..87698b3ca 100644
--- a/apps/server/src/routes/v1/maintenances/put.ts
+++ b/apps/server/src/routes/v1/maintenances/put.ts
@@ -19,6 +19,7 @@ import {
dateRangeError,
refineDateRange,
} from "./schema";
+import { rewriteLatestUpdate, withLatestMessage } from "./updates";
const putRoute = createRoute({
method: "put",
@@ -58,7 +59,8 @@ export function registerPutMaintenance(api: typeof maintenancesApi) {
const { id } = c.req.valid("param");
const input = c.req.valid("json");
- const { monitorIds, pageId } = input;
+ const { monitorIds, message, ...columns } = input;
+ const { pageId } = input;
const _maintenance = await db.query.maintenance.findFirst({
with: {
@@ -67,6 +69,7 @@ export function registerPutMaintenance(api: typeof maintenancesApi) {
pageComponent: true,
},
},
+ maintenanceUpdates: true,
},
where: and(
eq(maintenance.id, Number(id)),
@@ -131,7 +134,7 @@ export function registerPutMaintenance(api: typeof maintenancesApi) {
const updated = await tx
.update(maintenance)
.set({
- ...input,
+ ...columns,
updatedAt: new Date(),
updatedBy: actorUserId,
})
@@ -139,6 +142,10 @@ export function registerPutMaintenance(api: typeof maintenancesApi) {
.returning()
.get();
+ if (message !== undefined) {
+ await rewriteLatestUpdate(tx, Number(id), message, actorUserId);
+ }
+
if (monitorIds) {
// Delete from maintenancesToPageComponents
await tx
@@ -180,6 +187,7 @@ export function registerPutMaintenance(api: typeof maintenancesApi) {
const data = MaintenanceSchema.parse({
...updatedMaintenance,
+ message: message ?? withLatestMessage(_maintenance).message,
monitorIds:
monitorIds ??
_maintenance.maintenancesToPageComponents
diff --git a/apps/server/src/routes/v1/maintenances/schema.ts b/apps/server/src/routes/v1/maintenances/schema.ts
index 6ff6415cf..c56407f65 100644
--- a/apps/server/src/routes/v1/maintenances/schema.ts
+++ b/apps/server/src/routes/v1/maintenances/schema.ts
@@ -24,8 +24,9 @@ export const MaintenanceObjectSchema = z.object({
description: "The title of the maintenance",
example: "Database Upgrade",
}),
- message: z.string().openapi({
- description: "The message describing the maintenance",
+ message: z.string().min(1).openapi({
+ description:
+ "The newest timeline update. On create it becomes the first update; on update it rewrites the newest one.",
example: "Upgrading database to improve performance",
}),
from: z.coerce.date().openapi({
diff --git a/apps/server/src/routes/v1/maintenances/updates.ts b/apps/server/src/routes/v1/maintenances/updates.ts
new file mode 100644
index 000000000..17e226a64
--- /dev/null
+++ b/apps/server/src/routes/v1/maintenances/updates.ts
@@ -0,0 +1,54 @@
+import { type db, desc, eq } from "@openstatus/db";
+import { maintenanceUpdate } from "@openstatus/db/src/schema/maintenances";
+import { latestMaintenanceUpdate } from "@openstatus/services/maintenance";
+
+type Tx = Parameters<Parameters<typeof db.transaction>[0]>[0];
+
+/** The public `message`: newest update, or the deprecated column. */
+export function withLatestMessage<
+ T extends {
+ message: string;
+ maintenanceUpdates: Array<{ id: number; date: Date; message: string }>;
+ },
+>(record: T): T {
+ return {
+ ...record,
+ message:
+ latestMaintenanceUpdate(record.maintenanceUpdates)?.message ??
+ record.message,
+ };
+}
+
+/** `message` on PUT edits the newest update; a bare row gets one dated now. */
+export async function rewriteLatestUpdate(
+ tx: Tx,
+ maintenanceId: number,
+ message: string,
+ actorUserId: number | null,
+): Promise<void> {
+ const latest = await tx
+ .select({ id: maintenanceUpdate.id })
+ .from(maintenanceUpdate)
+ .where(eq(maintenanceUpdate.maintenanceId, maintenanceId))
+ .orderBy(desc(maintenanceUpdate.date), desc(maintenanceUpdate.id))
+ .limit(1)
+ .get();
+ if (latest) {
+ await tx
+ .update(maintenanceUpdate)
+ .set({ message, updatedAt: new Date(), updatedBy: actorUserId })
+ .where(eq(maintenanceUpdate.id, latest.id))
+ .run();
+ return;
+ }
+ await tx
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId,
+ message,
+ date: new Date(),
+ createdBy: actorUserId,
+ updatedBy: actorUserId,
+ })
+ .run();
+}
diff --git a/apps/server/static/openapi-v1.json b/apps/server/static/openapi-v1.json
index 702fc70e7..835a12b7b 100644
--- a/apps/server/static/openapi-v1.json
+++ b/apps/server/static/openapi-v1.json
@@ -928,7 +928,7 @@
"type": "string",
"nullable": true,
"format": "date-time",
- "default": "2026-09-10T07:58:20.617Z",
+ "default": "2026-10-08T18:46:39.061Z",
"description": "The date of the update in ISO8601 format"
},
"message": {
@@ -1009,7 +1009,8 @@
},
"message": {
"type": "string",
- "description": "The message describing the maintenance",
+ "minLength": 1,
+ "description": "The newest timeline update. On create it becomes the first update; on update it rewrites the newest one.",
"example": "Upgrading database to improve performance"
},
"from": {
@@ -6584,7 +6585,7 @@
"type": "string",
"nullable": true,
"format": "date-time",
- "default": "2026-09-10T07:58:20.617Z",
+ "default": "2026-10-08T18:46:39.061Z",
"description": "The date of the report in ISO8601 format, defaults to now"
},
"message": {
@@ -7039,7 +7040,7 @@
"type": "string",
"nullable": true,
"format": "date-time",
- "default": "2026-09-10T07:58:20.617Z",
+ "default": "2026-10-08T18:46:39.061Z",
"description": "The date of the update in ISO8601 format"
},
"message": {
@@ -7340,7 +7341,7 @@
"type": "string",
"nullable": true,
"format": "date-time",
- "default": "2026-09-10T07:58:20.617Z",
+ "default": "2026-10-08T18:46:39.061Z",
"description": "The date of the update in ISO8601 format"
},
"message": {
@@ -8058,7 +8059,8 @@
},
"message": {
"type": "string",
- "description": "The message describing the maintenance",
+ "minLength": 1,
+ "description": "The newest timeline update. On create it becomes the first update; on update it rewrites the newest one.",
"example": "Upgrading database to improve performance"
},
"from": {
@@ -8384,7 +8386,8 @@
},
"message": {
"type": "string",
- "description": "The message describing the maintenance",
+ "minLength": 1,
+ "description": "The newest timeline update. On create it becomes the first update; on update it rewrites the newest one.",
"example": "Upgrading database to improve performance"
},
"from": {
diff --git a/apps/server/static/openapi-yaml.ts b/apps/server/static/openapi-yaml.ts
index 6a85f6456..864e9db38 100644
--- a/apps/server/static/openapi-yaml.ts
+++ b/apps/server/static/openapi-yaml.ts
@@ -1,2 +1,2 @@
// Generated from openapi.yaml — run `pnpm --filter @openstatus/server openapi:json`.
-export default "openapi: 3.1.0\ninfo:\n description: OpenStatus is a open-source status page platform with global uptime monitoring. The OpenStatus API allows you to interact with the OpenStatus platform programmatically. To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings. Requests are rate limited per API key or token (600 per minute, 100 per 10 seconds); exceeding a limit returns HTTP 429 with a Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits.\n title: OpenStatus API\n version: v2.0.0\n contact:\n email: [email protected]\n url: https://www.openstatus.dev\nservers:\n - url: https://api.openstatus.dev\n description: Production\nexternalDocs:\n description: OpenStatus Documentation\n url: https://www.openstatus.dev/docs\ncomponents:\n responses:\n RateLimited:\n description: Rate limit exceeded (Connect code resource_exhausted). Retry after the number of seconds in the Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits.\n headers:\n Retry-After:\n description: Seconds to wait before retrying.\n schema:\n type: integer\n example: 7\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: x-openstatus-key\n schemas:\n connect.error:\n type: object\n properties:\n code:\n type: string\n examples:\n - not_found\n enum:\n - canceled\n - unknown\n - invalid_argument\n - deadline_exceeded\n - not_found\n - already_exists\n - permission_denied\n - resource_exhausted\n - failed_precondition\n - aborted\n - out_of_range\n - unimplemented\n - internal\n - unavailable\n - data_loss\n - unauthenticated\n description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].\n message:\n type: string\n description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.\n details:\n type: array\n items:\n $ref: '#/components/schemas/connect.error_details.Any'\n description: A list of messages that carry the error details. There is no limit on the number of messages.\n title: Connect Error\n additionalProperties: true\n description: 'Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation'\n connect.error_details.Any:\n type: object\n properties:\n type:\n type: string\n description: 'A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field.'\n value:\n type: string\n format: binary\n description: The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field.\n debug:\n oneOf:\n - type: object\n title: Any\n additionalProperties: true\n description: Detailed error information.\n discriminator:\n propertyName: type\n title: Debug\n description: Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic.\n additionalProperties: true\n description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.\n openstatus.health.v1.CheckRequest:\n type: object\n properties:\n service:\n type: string\n title: service\n description: Optional service name to check. If empty, checks overall service health.\n title: CheckRequest\n additionalProperties: false\n description: CheckRequest is the request message for health checks.\n openstatus.health.v1.CheckResponse:\n type: object\n properties:\n status:\n title: status\n description: The serving status of the service.\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse.ServingStatus'\n title: CheckResponse\n additionalProperties: false\n description: CheckResponse is the response message for health checks.\n openstatus.health.v1.CheckResponse.ServingStatus:\n type: string\n title: ServingStatus\n enum:\n - SERVING_STATUS_UNSPECIFIED\n - SERVING_STATUS_SERVING\n - SERVING_STATUS_NOT_SERVING\n description: ServingStatus represents the health status of the service.\n openstatus.maintenance.v1.CreateMaintenanceRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - Database Migration\n title: title\n maxLength: 256\n minLength: 1\n description: Title of the maintenance (required, 1-256 characters).\n message:\n type: string\n title: message\n minLength: 1\n description: Message describing the maintenance (required).\n from:\n type: string\n examples:\n - \"2024-03-01T02:00:00Z\"\n title: from\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Start time of the maintenance window (RFC 3339 format, required).\n to:\n type: string\n examples:\n - \"2024-03-01T06:00:00Z\"\n title: to\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: End time of the maintenance window (RFC 3339 format, required).\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: Page ID to associate with this maintenance (required).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: Page component IDs to associate with this maintenance (optional).\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this maintenance (optional, defaults to false).\n title: CreateMaintenanceRequest\n additionalProperties: false\n description: CreateMaintenanceRequest is the request to create a new maintenance window.\n openstatus.maintenance.v1.CreateMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The created maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: CreateMaintenanceResponse\n additionalProperties: false\n description: CreateMaintenanceResponse is the response after creating a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to delete (required).\n title: DeleteMaintenanceRequest\n additionalProperties: false\n description: DeleteMaintenanceRequest is the request to delete a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMaintenanceResponse\n additionalProperties: false\n description: DeleteMaintenanceResponse is the response after deleting a maintenance window.\n openstatus.maintenance.v1.GetMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to retrieve (required).\n title: GetMaintenanceRequest\n additionalProperties: false\n description: GetMaintenanceRequest is the request to get a maintenance window by ID.\n openstatus.maintenance.v1.GetMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The requested maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: GetMaintenanceResponse\n additionalProperties: false\n description: GetMaintenanceResponse is the response containing the maintenance window.\n openstatus.maintenance.v1.ListMaintenancesRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of maintenances to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of maintenances to skip for pagination (defaults to 0).\n pageId:\n type:\n - string\n - \"null\"\n title: page_id\n description: Filter by page ID (optional).\n title: ListMaintenancesRequest\n additionalProperties: false\n description: ListMaintenancesRequest is the request to list maintenance windows.\n openstatus.maintenance.v1.ListMaintenancesResponse:\n type: object\n properties:\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: List of maintenances.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of maintenances matching the filter.\n title: ListMaintenancesResponse\n additionalProperties: false\n description: ListMaintenancesResponse is the response containing maintenance window summaries.\n openstatus.maintenance.v1.Maintenance:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the maintenance.\n title:\n type: string\n title: title\n description: Title of the maintenance.\n message:\n type: string\n title: message\n description: Message describing the maintenance.\n from:\n type: string\n title: from\n description: Start time of the maintenance window (RFC 3339 format).\n to:\n type: string\n title: to\n description: End time of the maintenance window (RFC 3339 format).\n pageId:\n type: string\n title: page_id\n description: ID of the page this maintenance is associated with.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the maintenance was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the maintenance was last updated (RFC 3339 format).\n title: Maintenance\n additionalProperties: false\n description: Maintenance represents a maintenance window with full details.\n openstatus.maintenance.v1.MaintenanceSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the maintenance.\n title:\n type: string\n title: title\n description: Title of the maintenance.\n message:\n type: string\n title: message\n description: Message describing the maintenance.\n from:\n type: string\n title: from\n description: Start time of the maintenance window (RFC 3339 format).\n to:\n type: string\n title: to\n description: End time of the maintenance window (RFC 3339 format).\n pageId:\n type: string\n title: page_id\n description: ID of the page this maintenance is associated with.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the maintenance was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the maintenance was last updated (RFC 3339 format).\n title: MaintenanceSummary\n additionalProperties: false\n description: MaintenanceSummary represents metadata for a maintenance window (used in list responses).\n openstatus.maintenance.v1.UpdateMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n maxLength: 256\n minLength: 1\n description: New title for the maintenance (optional).\n message:\n type:\n - string\n - \"null\"\n title: message\n description: New message for the maintenance (optional).\n from:\n type:\n - string\n - \"null\"\n title: from\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New start time (RFC 3339 format, optional).\n to:\n type:\n - string\n - \"null\"\n title: to\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New end time (RFC 3339 format, optional).\n pageId:\n type:\n - string\n - \"null\"\n title: page_id\n description: 'Deprecated: page_id is now derived from page_component_ids.'\n deprecated: true\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: New list of page component IDs (optional, replaces existing list).\n updatePageComponentIds:\n type:\n - boolean\n - \"null\"\n title: update_page_component_ids\n description: |-\n Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved.\n title: UpdateMaintenanceRequest\n additionalProperties: false\n description: UpdateMaintenanceRequest is the request to update a maintenance window.\n openstatus.maintenance.v1.UpdateMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The updated maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: UpdateMaintenanceResponse\n additionalProperties: false\n description: UpdateMaintenanceResponse is the response after updating a maintenance window.\n openstatus.monitor.v1.BodyAssertion:\n type: object\n properties:\n target:\n type: string\n title: target\n description: Target value to compare against.\n comparator:\n not:\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'\n title: BodyAssertion\n additionalProperties: false\n description: BodyAssertion defines an assertion for response body content.\n openstatus.monitor.v1.CreateDNSMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: CreateDNSMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateDNSMonitorRequest is the request to create a new DNS monitor.\n openstatus.monitor.v1.CreateDNSMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: CreateDNSMonitorResponse\n additionalProperties: false\n description: CreateDNSMonitorResponse is the response after creating a DNS monitor.\n openstatus.monitor.v1.CreateGRPCMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: CreateGRPCMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateGRPCMonitorRequest is the request to create a new gRPC monitor.\n openstatus.monitor.v1.CreateGRPCMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: CreateGRPCMonitorResponse\n additionalProperties: false\n description: CreateGRPCMonitorResponse is the response after creating a gRPC monitor.\n openstatus.monitor.v1.CreateHTTPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: CreateHTTPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateHTTPMonitorRequest is the request to create a new HTTP monitor.\n openstatus.monitor.v1.CreateHTTPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: CreateHTTPMonitorResponse\n additionalProperties: false\n description: CreateHTTPMonitorResponse is the response after creating an HTTP monitor.\n openstatus.monitor.v1.CreateICMPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: CreateICMPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateICMPMonitorRequest is the request to create a new ICMP monitor.\n openstatus.monitor.v1.CreateICMPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: CreateICMPMonitorResponse\n additionalProperties: false\n description: CreateICMPMonitorResponse is the response after creating an ICMP monitor.\n openstatus.monitor.v1.CreateTCPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: CreateTCPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateTCPMonitorRequest is the request to create a new TCP monitor.\n openstatus.monitor.v1.CreateTCPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: CreateTCPMonitorResponse\n additionalProperties: false\n description: CreateTCPMonitorResponse is the response after creating a TCP monitor.\n openstatus.monitor.v1.DNSMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - DNS Resolution Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - example.com\n title: uri\n maxLength: 2048\n minLength: 1\n description: Domain to resolve (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n recordAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.RecordAssertion'\n title: record_assertions\n maxItems: 10\n description: DNS record assertions for validation.\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: DNSMonitor\n additionalProperties: false\n description: DNSMonitor defines the configuration for a DNS monitor.\n openstatus.monitor.v1.DeleteMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to delete (required).\n title: DeleteMonitorRequest\n additionalProperties: false\n description: DeleteMonitorRequest is the request to delete a monitor.\n openstatus.monitor.v1.DeleteMonitorResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMonitorResponse\n additionalProperties: false\n description: DeleteMonitorResponse is the response after deleting a monitor.\n openstatus.monitor.v1.GRPCMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Checkout gRPC\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - api.example.com:443\n title: uri\n maxLength: 2048\n minLength: 1\n pattern: ^(\\[[0-9a-fA-F:]+\\]|[^:/\\s]+):[0-9]{1,5}$\n description: Target in \"host:port\" form. IPv6 addresses must be bracketed.\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n service:\n type:\n - string\n - \"null\"\n examples:\n - checkout.v1.CheckoutService\n title: service\n maxLength: 512\n description: Service name passed to Health/Check. Empty means overall server health.\n tlsMode:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.GRPCTlsMode'\n - type: \"null\"\n title: tls_mode\n description: How the connection to the target is secured. Defaults to TLS.\n metadata:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: metadata\n maxItems: 20\n description: Metadata sent with the health check request.\n title: GRPCMonitor\n additionalProperties: false\n description: |-\n GRPCMonitor defines the configuration for a gRPC health check monitor.\n The probe calls grpc.health.v1.Health/Check on the target.\n openstatus.monitor.v1.GRPCTlsMode:\n type: string\n title: GRPCTlsMode\n enum:\n - GRPC_TLS_MODE_UNSPECIFIED\n - GRPC_TLS_MODE_TLS\n - GRPC_TLS_MODE_PLAINTEXT\n - GRPC_TLS_MODE_TLS_INSECURE\n description: GRPCTlsMode selects how the probe secures its connection to the target.\n openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get a response log for (required).\n logId:\n type: string\n title: log_id\n minLength: 1\n description: Response log ID to retrieve (required).\n title: GetMonitorHTTPResponseLogRequest\n additionalProperties: false\n description: GetMonitorHTTPResponseLogRequest is the request to get one response log.\n openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse:\n type: object\n properties:\n log:\n title: log\n description: Response log details.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogDetail'\n title: GetMonitorHTTPResponseLogResponse\n additionalProperties: false\n description: GetMonitorHTTPResponseLogResponse is the response containing one response log.\n openstatus.monitor.v1.GetMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to retrieve (required).\n title: GetMonitorRequest\n additionalProperties: false\n description: GetMonitorRequest is the request to get a single monitor by ID.\n openstatus.monitor.v1.GetMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The monitor configuration (one of HTTP, TCP, DNS, ICMP, or gRPC).\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorConfig'\n title: GetMonitorResponse\n additionalProperties: false\n description: GetMonitorResponse is the response containing the monitor.\n openstatus.monitor.v1.GetMonitorStatusRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get status for (required).\n title: GetMonitorStatusRequest\n additionalProperties: false\n description: GetMonitorStatusRequest is the request to get the status of all regions for a monitor.\n openstatus.monitor.v1.GetMonitorStatusResponse:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Monitor ID.\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.RegionStatus'\n title: regions\n description: Status for each region.\n title: GetMonitorStatusResponse\n additionalProperties: false\n description: GetMonitorStatusResponse is the response containing the status of all regions for a monitor.\n openstatus.monitor.v1.GetMonitorSummaryRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get summary for (required).\n timeRange:\n title: time_range\n description: Time range for metrics aggregation (defaults to 1 day if unspecified).\n $ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Optional filter by regions. If empty, returns metrics for all regions.\n title: GetMonitorSummaryRequest\n additionalProperties: false\n description: GetMonitorSummaryRequest is the request to get aggregated metrics for a monitor.\n openstatus.monitor.v1.GetMonitorSummaryResponse:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Monitor ID.\n lastPingAt:\n type: string\n title: last_ping_at\n description: Timestamp of the last check in RFC 3339 format.\n totalSuccessful:\n type:\n - integer\n - string\n title: total_successful\n format: int64\n description: Total number of successful requests.\n totalDegraded:\n type:\n - integer\n - string\n title: total_degraded\n format: int64\n description: Total number of degraded requests.\n totalFailed:\n type:\n - integer\n - string\n title: total_failed\n format: int64\n description: Total number of failed requests.\n p50:\n type:\n - integer\n - string\n title: p50\n format: int64\n description: 50th percentile (median) latency in milliseconds.\n p75:\n type:\n - integer\n - string\n title: p75\n format: int64\n description: 75th percentile latency in milliseconds.\n p90:\n type:\n - integer\n - string\n title: p90\n format: int64\n description: 90th percentile latency in milliseconds.\n p95:\n type:\n - integer\n - string\n title: p95\n format: int64\n description: 95th percentile latency in milliseconds.\n p99:\n type:\n - integer\n - string\n title: p99\n format: int64\n description: 99th percentile latency in milliseconds.\n timeRange:\n title: time_range\n description: Time range used for the metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n description: Regions included in the metrics.\n title: GetMonitorSummaryResponse\n additionalProperties: false\n description: GetMonitorSummaryResponse is the response containing aggregated metrics for a monitor.\n openstatus.monitor.v1.HTTPMethod:\n type: string\n title: HTTPMethod\n enum:\n - HTTP_METHOD_UNSPECIFIED\n - HTTP_METHOD_GET\n - HTTP_METHOD_POST\n - HTTP_METHOD_HEAD\n - HTTP_METHOD_PUT\n - HTTP_METHOD_PATCH\n - HTTP_METHOD_DELETE\n - HTTP_METHOD_TRACE\n - HTTP_METHOD_CONNECT\n - HTTP_METHOD_OPTIONS\n description: HTTP methods supported for monitors.\n openstatus.monitor.v1.HTTPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Production API Health Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n url:\n type: string\n examples:\n - https://api.example.com/health\n title: url\n maxLength: 2048\n minLength: 1\n format: uri\n description: URL to monitor (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n method:\n not:\n enum:\n - HTTP_METHOD_UNSPECIFIED\n title: method\n description: HTTP method to use (defaults to GET).\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMethod'\n body:\n type: string\n examples:\n - map[key:value]\n title: body\n description: Request body (optional).\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n followRedirects:\n type:\n - boolean\n - \"null\"\n title: follow_redirects\n description: Whether to follow HTTP redirects (defaults to true when not specified).\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: headers\n maxItems: 20\n description: Custom headers for the request.\n statusCodeAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.StatusCodeAssertion'\n title: status_code_assertions\n maxItems: 10\n description: Status code assertions for the response.\n bodyAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.BodyAssertion'\n title: body_assertions\n maxItems: 10\n description: Body content assertions for the response.\n headerAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HeaderAssertion'\n title: header_assertions\n maxItems: 10\n description: Header assertions for the response.\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: HTTPMonitor\n additionalProperties: false\n description: HTTPMonitor defines the configuration for an HTTP monitor.\n openstatus.monitor.v1.HTTPResponseLogDetail:\n type: object\n properties:\n log:\n title: log\n description: Compact response log fields.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'\n url:\n type: string\n title: url\n description: Checked URL.\n error:\n type: boolean\n title: error\n description: Whether the check errored.\n message:\n type:\n - string\n - \"null\"\n title: message\n description: Error message, when present.\n headers:\n type: object\n title: headers\n additionalProperties:\n type: string\n title: value\n description: Redacted response headers.\n assertions:\n type:\n - string\n - \"null\"\n title: assertions\n description: Serialized assertions used for the check.\n title: HTTPResponseLogDetail\n additionalProperties: false\n description: HTTPResponseLogDetail contains full response log debugging data.\n openstatus.monitor.v1.HTTPResponseLogDetail.HeadersEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: HeadersEntry\n additionalProperties: false\n openstatus.monitor.v1.HTTPResponseLogListItem:\n type: object\n properties:\n id:\n type:\n - string\n - \"null\"\n title: id\n description: Response log ID.\n latency:\n type: integer\n title: latency\n format: int32\n description: Latency in milliseconds.\n statusCode:\n type:\n - integer\n - \"null\"\n title: status_code\n format: int32\n description: HTTP status code.\n monitorId:\n type: string\n title: monitor_id\n description: Monitor ID.\n requestStatus:\n title: request_status\n description: Request status classification.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogRequestStatus'\n region:\n title: region\n description: Region where the check ran.\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n cronTimestamp:\n type:\n - integer\n - string\n title: cron_timestamp\n format: int64\n description: Cron bucket timestamp in Unix milliseconds.\n trigger:\n title: trigger\n description: Check trigger.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTrigger'\n timestamp:\n type:\n - integer\n - string\n title: timestamp\n format: int64\n description: Response timestamp in Unix milliseconds.\n timing:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTiming'\n - type: \"null\"\n title: timing\n description: Timing phases.\n title: HTTPResponseLogListItem\n additionalProperties: false\n description: HTTPResponseLogListItem is a compact response log entry.\n openstatus.monitor.v1.HTTPResponseLogPagination:\n type: object\n properties:\n limit:\n type: integer\n title: limit\n format: int32\n description: Requested page size.\n offset:\n type: integer\n title: offset\n format: int32\n description: Requested offset.\n hasMore:\n type: boolean\n title: has_more\n description: Whether more logs are available.\n nextOffset:\n type:\n - integer\n - \"null\"\n title: next_offset\n format: int32\n description: Next offset if more logs are available.\n title: HTTPResponseLogPagination\n additionalProperties: false\n description: HTTPResponseLogPagination contains offset pagination metadata.\n openstatus.monitor.v1.HTTPResponseLogRequestStatus:\n type: string\n title: HTTPResponseLogRequestStatus\n enum:\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_UNSPECIFIED\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_SUCCESS\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_ERROR\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_DEGRADED\n description: HTTPResponseLogRequestStatus is the result classification for an HTTP response log.\n openstatus.monitor.v1.HTTPResponseLogTiming:\n type: object\n properties:\n dns:\n type: integer\n title: dns\n format: int32\n description: DNS lookup duration.\n connect:\n type: integer\n title: connect\n format: int32\n description: TCP connection duration.\n tls:\n type: integer\n title: tls\n format: int32\n description: TLS handshake duration.\n ttfb:\n type: integer\n title: ttfb\n format: int32\n description: Time to first byte duration.\n transfer:\n type: integer\n title: transfer\n format: int32\n description: Response transfer duration.\n title: HTTPResponseLogTiming\n additionalProperties: false\n description: HTTPResponseLogTiming contains calculated timing phases in milliseconds.\n openstatus.monitor.v1.HTTPResponseLogTrigger:\n type: string\n title: HTTPResponseLogTrigger\n enum:\n - HTTP_RESPONSE_LOG_TRIGGER_UNSPECIFIED\n - HTTP_RESPONSE_LOG_TRIGGER_CRON\n - HTTP_RESPONSE_LOG_TRIGGER_API\n description: HTTPResponseLogTrigger describes what started the monitor check.\n openstatus.monitor.v1.HeaderAssertion:\n type: object\n properties:\n target:\n type: string\n title: target\n description: Target value to compare against.\n comparator:\n not:\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'\n key:\n type: string\n title: key\n minLength: 1\n description: Header key to check (required).\n title: HeaderAssertion\n additionalProperties: false\n description: HeaderAssertion defines an assertion for response headers.\n openstatus.monitor.v1.Headers:\n type: object\n properties:\n key:\n type: string\n examples:\n - Authorization\n title: key\n minLength: 1\n description: Header name.\n value:\n type: string\n examples:\n - Bearer token123\n title: value\n description: Header value.\n title: Headers\n additionalProperties: false\n description: Headers represents a key-value pair for HTTP headers.\n openstatus.monitor.v1.ICMPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Ping Gateway\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - 1.1.1.1\n title: uri\n maxLength: 2048\n minLength: 1\n description: URI to monitor in format \"host or IP\" (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: ICMPMonitor\n additionalProperties: false\n description: ICMPMonitor defines the configuration for a ICMP monitor.\n openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to list response logs for (required).\n fromTimestamp:\n type:\n - integer\n - string\n - \"null\"\n title: from_timestamp\n format: int64\n description: Start of the response log window as Unix milliseconds within the 14-day retention window.\n toTimestamp:\n type:\n - integer\n - string\n - \"null\"\n title: to_timestamp\n format: int64\n description: End of the response log window as Unix milliseconds within the 14-day retention window.\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of logs to return (1-100, defaults to 25).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of logs to skip for pagination (defaults to 0).\n title: ListMonitorHTTPResponseLogsRequest\n additionalProperties: false\n description: ListMonitorHTTPResponseLogsRequest is the request to list response logs within the 14-day HTTP response-log window.\n openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse:\n type: object\n properties:\n logs:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'\n title: logs\n description: Response logs.\n pagination:\n title: pagination\n description: Pagination metadata.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogPagination'\n title: ListMonitorHTTPResponseLogsResponse\n additionalProperties: false\n description: ListMonitorHTTPResponseLogsResponse is the response containing response logs.\n openstatus.monitor.v1.ListMonitorsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of monitors to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of monitors to skip for pagination (defaults to 0).\n title: ListMonitorsRequest\n additionalProperties: false\n description: ListMonitorsRequest is the request to list monitors.\n openstatus.monitor.v1.ListMonitorsResponse:\n type: object\n properties:\n httpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: http_monitors\n description: HTTP monitors in the workspace.\n tcpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: tcp_monitors\n description: TCP monitors in the workspace.\n dnsMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: dns_monitors\n description: DNS monitors in the workspace.\n icmpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: icmp_monitors\n description: ICMP monitors in the workspace.\n grpcMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: grpc_monitors\n description: gRPC monitors in the workspace.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of monitors across all types.\n title: ListMonitorsResponse\n additionalProperties: false\n description: ListMonitorsResponse is the response containing a list of monitors.\n openstatus.monitor.v1.MonitorConfig:\n type: object\n oneOf:\n - type: object\n properties:\n dns:\n title: dns\n description: DNS monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: dns\n required:\n - dns\n - type: object\n properties:\n grpc:\n title: grpc\n description: gRPC monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: grpc\n required:\n - grpc\n - type: object\n properties:\n http:\n title: http\n description: HTTP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: http\n required:\n - http\n - type: object\n properties:\n icmp:\n title: icmp\n description: ICMP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: icmp\n required:\n - icmp\n - type: object\n properties:\n tcp:\n title: tcp\n description: TCP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: tcp\n required:\n - tcp\n title: MonitorConfig\n additionalProperties: false\n description: MonitorConfig represents the type-specific configuration for a monitor.\n openstatus.monitor.v1.MonitorStatus:\n type: string\n title: MonitorStatus\n enum:\n - MONITOR_STATUS_UNSPECIFIED\n - MONITOR_STATUS_ACTIVE\n - MONITOR_STATUS_DEGRADED\n - MONITOR_STATUS_ERROR\n description: MonitorStatus represents the operational status of a monitor.\n openstatus.monitor.v1.NumberComparator:\n type: string\n title: NumberComparator\n enum:\n - NUMBER_COMPARATOR_UNSPECIFIED\n - NUMBER_COMPARATOR_EQUAL\n - NUMBER_COMPARATOR_NOT_EQUAL\n - NUMBER_COMPARATOR_GREATER_THAN\n - NUMBER_COMPARATOR_GREATER_THAN_OR_EQUAL\n - NUMBER_COMPARATOR_LESS_THAN\n - NUMBER_COMPARATOR_LESS_THAN_OR_EQUAL\n description: NumberComparator defines comparison operations for numeric values.\n openstatus.monitor.v1.OpenTelemetryConfig:\n type: object\n properties:\n endpoint:\n type: string\n title: endpoint\n maxLength: 2048\n description: OTEL endpoint URL.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: headers\n maxItems: 20\n description: Custom headers for OTEL requests.\n title: OpenTelemetryConfig\n additionalProperties: false\n description: OpenTelemetry configuration for exporting metrics.\n openstatus.monitor.v1.Periodicity:\n type: string\n title: Periodicity\n enum:\n - PERIODICITY_UNSPECIFIED\n - PERIODICITY_30S\n - PERIODICITY_1M\n - PERIODICITY_5M\n - PERIODICITY_10M\n - PERIODICITY_30M\n - PERIODICITY_1H\n description: Monitor periodicity options.\n openstatus.monitor.v1.RecordAssertion:\n type: object\n properties:\n record:\n type: string\n title: record\n enum:\n - A\n - AAAA\n - CNAME\n - MX\n - TXT\n description: DNS record type (e.g., \"A\", \"AAAA\", \"CNAME\", \"MX\", \"TXT\").\n comparator:\n not:\n enum:\n - RECORD_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.RecordComparator'\n target:\n type: string\n title: target\n description: Target value to compare against.\n title: RecordAssertion\n additionalProperties: false\n description: RecordAssertion defines an assertion for DNS records.\n openstatus.monitor.v1.RecordComparator:\n type: string\n title: RecordComparator\n enum:\n - RECORD_COMPARATOR_UNSPECIFIED\n - RECORD_COMPARATOR_EQUAL\n - RECORD_COMPARATOR_NOT_EQUAL\n - RECORD_COMPARATOR_CONTAINS\n - RECORD_COMPARATOR_NOT_CONTAINS\n description: RecordComparator defines comparison operations for DNS records.\n openstatus.monitor.v1.Region:\n type: string\n title: Region\n enum:\n - REGION_UNSPECIFIED\n - REGION_FLY_AMS\n - REGION_FLY_ARN\n - REGION_FLY_BOM\n - REGION_FLY_CDG\n - REGION_FLY_DFW\n - REGION_FLY_EWR\n - REGION_FLY_FRA\n - REGION_FLY_GRU\n - REGION_FLY_IAD\n - REGION_FLY_JNB\n - REGION_FLY_LAX\n - REGION_FLY_LHR\n - REGION_FLY_NRT\n - REGION_FLY_ORD\n - REGION_FLY_SJC\n - REGION_FLY_SIN\n - REGION_FLY_SYD\n - REGION_FLY_YYZ\n - REGION_KOYEB_FRA\n - REGION_KOYEB_PAR\n - REGION_KOYEB_SFO\n - REGION_KOYEB_SIN\n - REGION_KOYEB_TYO\n - REGION_KOYEB_WAS\n - REGION_RAILWAY_US_WEST2\n - REGION_RAILWAY_US_EAST4\n - REGION_RAILWAY_EUROPE_WEST4\n - REGION_RAILWAY_ASIA_SOUTHEAST1\n description: |-\n Geographic regions where monitors can run checks from.\n REGION_FLY_BOM is deprecated and rejected on create/update; use REGION_FLY_SIN.\n openstatus.monitor.v1.RegionStatus:\n type: object\n properties:\n region:\n title: region\n description: The region identifier.\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n status:\n title: status\n description: The status of the monitor in this region.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n title: RegionStatus\n additionalProperties: false\n description: RegionStatus represents the status of a monitor in a specific region.\n openstatus.monitor.v1.StatusCodeAssertion:\n type: object\n properties:\n target:\n type:\n - integer\n - string\n title: target\n maximum: 599\n minimum: 100\n format: int64\n description: Target status code to compare against (100-599).\n comparator:\n not:\n enum:\n - NUMBER_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.NumberComparator'\n title: StatusCodeAssertion\n additionalProperties: false\n description: StatusCodeAssertion defines an assertion for HTTP status codes.\n openstatus.monitor.v1.StringComparator:\n type: string\n title: StringComparator\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n - STRING_COMPARATOR_CONTAINS\n - STRING_COMPARATOR_NOT_CONTAINS\n - STRING_COMPARATOR_EQUAL\n - STRING_COMPARATOR_NOT_EQUAL\n - STRING_COMPARATOR_EMPTY\n - STRING_COMPARATOR_NOT_EMPTY\n - STRING_COMPARATOR_GREATER_THAN\n - STRING_COMPARATOR_GREATER_THAN_OR_EQUAL\n - STRING_COMPARATOR_LESS_THAN\n - STRING_COMPARATOR_LESS_THAN_OR_EQUAL\n description: StringComparator defines comparison operations for string values.\n openstatus.monitor.v1.TCPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Database Connection Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - tcp://db.example.com:5432\n title: uri\n maxLength: 2048\n minLength: 1\n description: URI to monitor in format \"host:port\" (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: TCPMonitor\n additionalProperties: false\n description: TCPMonitor defines the configuration for a TCP monitor.\n openstatus.monitor.v1.TimeRange:\n type: string\n title: TimeRange\n enum:\n - TIME_RANGE_UNSPECIFIED\n - TIME_RANGE_1D\n - TIME_RANGE_7D\n - TIME_RANGE_14D\n description: TimeRange represents the time period for metrics aggregation.\n openstatus.monitor.v1.TriggerMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to trigger (required).\n title: TriggerMonitorRequest\n additionalProperties: false\n description: TriggerMonitorRequest is the request to trigger a monitor check.\n openstatus.monitor.v1.TriggerMonitorResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the trigger was successful.\n title: TriggerMonitorResponse\n additionalProperties: false\n description: TriggerMonitorResponse is the response after triggering a monitor.\n openstatus.monitor.v1.UpdateDNSMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateDNSMonitorRequest\n additionalProperties: false\n description: UpdateDNSMonitorRequest is the request to update an existing DNS monitor.\n openstatus.monitor.v1.UpdateDNSMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: UpdateDNSMonitorResponse\n additionalProperties: false\n description: UpdateDNSMonitorResponse is the response after updating a DNS monitor.\n openstatus.monitor.v1.UpdateGRPCMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateGRPCMonitorRequest\n additionalProperties: false\n description: UpdateGRPCMonitorRequest is the request to update an existing gRPC monitor.\n openstatus.monitor.v1.UpdateGRPCMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: UpdateGRPCMonitorResponse\n additionalProperties: false\n description: UpdateGRPCMonitorResponse is the response after updating a gRPC monitor.\n openstatus.monitor.v1.UpdateHTTPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateHTTPMonitorRequest\n additionalProperties: false\n description: UpdateHTTPMonitorRequest is the request to update an existing HTTP monitor.\n openstatus.monitor.v1.UpdateHTTPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: UpdateHTTPMonitorResponse\n additionalProperties: false\n description: UpdateHTTPMonitorResponse is the response after updating an HTTP monitor.\n openstatus.monitor.v1.UpdateICMPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateICMPMonitorRequest\n additionalProperties: false\n description: UpdateICMPMonitorRequest is the request to update an existing ICMP monitor.\n openstatus.monitor.v1.UpdateICMPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: UpdateICMPMonitorResponse\n additionalProperties: false\n description: UpdateICMPMonitorResponse is the response after updating an ICMP monitor.\n openstatus.monitor.v1.UpdateTCPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateTCPMonitorRequest\n additionalProperties: false\n description: UpdateTCPMonitorRequest is the request to update an existing TCP monitor.\n openstatus.monitor.v1.UpdateTCPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: UpdateTCPMonitorResponse\n additionalProperties: false\n description: UpdateTCPMonitorResponse is the response after updating a TCP monitor.\n openstatus.notification.v1.CheckNotificationLimitRequest:\n type: object\n title: CheckNotificationLimitRequest\n additionalProperties: false\n description: CheckNotificationLimitRequest is the request to check notification limits.\n openstatus.notification.v1.CheckNotificationLimitResponse:\n type: object\n properties:\n limitReached:\n type: boolean\n title: limit_reached\n description: Whether the workspace has reached its notification limit.\n currentCount:\n type: integer\n title: current_count\n format: int32\n description: Current number of notification channels.\n maxCount:\n type: integer\n title: max_count\n format: int32\n description: Maximum allowed notification channels.\n title: CheckNotificationLimitResponse\n additionalProperties: false\n description: CheckNotificationLimitResponse is the response containing limit information.\n openstatus.notification.v1.CreateNotificationRequest:\n type: object\n properties:\n name:\n type: string\n examples:\n - Slack Ops Channel\n title: name\n minLength: 1\n description: Display name for the notification channel.\n provider:\n not:\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors to associate with this notification.\n title: CreateNotificationRequest\n required:\n - data\n additionalProperties: false\n description: CreateNotificationRequest is the request to create a new notification channel.\n openstatus.notification.v1.CreateNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The created notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: CreateNotificationResponse\n additionalProperties: false\n description: CreateNotificationResponse is the response after creating a notification channel.\n openstatus.notification.v1.DeleteNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to delete (required).\n title: DeleteNotificationRequest\n additionalProperties: false\n description: DeleteNotificationRequest is the request to delete a notification channel.\n openstatus.notification.v1.DeleteNotificationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteNotificationResponse\n additionalProperties: false\n description: DeleteNotificationResponse is the response after deleting a notification channel.\n openstatus.notification.v1.DiscordData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://discord.com/api/webhooks/123/abc\n title: webhook_url\n format: uri\n description: Discord webhook URL.\n title: DiscordData\n additionalProperties: false\n description: DiscordData contains configuration for Discord notifications.\n openstatus.notification.v1.EmailData:\n type: object\n properties:\n email:\n type: string\n examples:\n - [email protected]\n title: email\n format: email\n description: Email address to send notifications to.\n title: EmailData\n additionalProperties: false\n description: EmailData contains configuration for email notifications.\n openstatus.notification.v1.GetNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to retrieve (required).\n title: GetNotificationRequest\n additionalProperties: false\n description: GetNotificationRequest is the request to get a notification channel.\n openstatus.notification.v1.GetNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: GetNotificationResponse\n additionalProperties: false\n description: GetNotificationResponse is the response containing the notification channel.\n openstatus.notification.v1.GoogleChatData:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n format: uri\n description: Google Chat webhook URL.\n title: GoogleChatData\n additionalProperties: false\n description: GoogleChatData contains configuration for Google Chat notifications.\n openstatus.notification.v1.GrafanaOncallData:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n format: uri\n description: Grafana OnCall webhook URL.\n title: GrafanaOncallData\n additionalProperties: false\n description: GrafanaOncallData contains configuration for Grafana OnCall notifications.\n openstatus.notification.v1.ListNotificationsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of notifications to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of notifications to skip for pagination (defaults to 0).\n title: ListNotificationsRequest\n additionalProperties: false\n description: ListNotificationsRequest is the request to list notification channels.\n openstatus.notification.v1.ListNotificationsResponse:\n type: object\n properties:\n notifications:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationSummary'\n title: notifications\n description: Notification channel summaries.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of notification channels.\n title: ListNotificationsResponse\n additionalProperties: false\n description: ListNotificationsResponse is the response containing notification channels.\n openstatus.notification.v1.MsTeamsData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://prod-00.westeurope.logic.azure.com:443/workflows/abc/triggers/manual/paths/invoke\n title: webhook_url\n format: uri\n description: Microsoft Teams webhook URL (Power Automate Workflows).\n title: MsTeamsData\n additionalProperties: false\n description: MsTeamsData contains configuration for Microsoft Teams notifications.\n openstatus.notification.v1.Notification:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the notification.\n name:\n type: string\n title: name\n description: Display name for the notification channel.\n provider:\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors associated with this notification.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the notification was created (RFC 3339).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the notification was last updated (RFC 3339).\n title: Notification\n additionalProperties: false\n description: Notification represents a notification channel with full details.\n openstatus.notification.v1.NotificationData:\n type: object\n oneOf:\n - type: object\n properties:\n discord:\n title: discord\n description: Discord configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.DiscordData'\n title: discord\n required:\n - discord\n - type: object\n properties:\n email:\n title: email\n description: Email configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.EmailData'\n title: email\n required:\n - email\n - type: object\n properties:\n googleChat:\n title: google_chat\n description: Google Chat configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.GoogleChatData'\n title: google_chat\n required:\n - googleChat\n - type: object\n properties:\n grafanaOncall:\n title: grafana_oncall\n description: Grafana OnCall configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.GrafanaOncallData'\n title: grafana_oncall\n required:\n - grafanaOncall\n - type: object\n properties:\n msTeams:\n title: ms_teams\n description: Microsoft Teams configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.MsTeamsData'\n title: ms_teams\n required:\n - msTeams\n - type: object\n properties:\n ntfy:\n title: ntfy\n description: Ntfy configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NtfyData'\n title: ntfy\n required:\n - ntfy\n - type: object\n properties:\n opsgenie:\n title: opsgenie\n description: Opsgenie configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.OpsgenieData'\n title: opsgenie\n required:\n - opsgenie\n - type: object\n properties:\n pagerduty:\n title: pagerduty\n description: PagerDuty configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.PagerDutyData'\n title: pagerduty\n required:\n - pagerduty\n - type: object\n properties:\n slack:\n title: slack\n description: Slack configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.SlackData'\n title: slack\n required:\n - slack\n - type: object\n properties:\n sms:\n title: sms\n description: 'Deprecated: SMS is no longer offered; use whatsapp.'\n deprecated: true\n $ref: '#/components/schemas/openstatus.notification.v1.SmsData'\n title: sms\n required:\n - sms\n - type: object\n properties:\n telegram:\n title: telegram\n description: Telegram configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.TelegramData'\n title: telegram\n required:\n - telegram\n - type: object\n properties:\n webhook:\n title: webhook\n description: Webhook configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.WebhookData'\n title: webhook\n required:\n - webhook\n - type: object\n properties:\n whatsapp:\n title: whatsapp\n description: WhatsApp configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.WhatsappData'\n title: whatsapp\n required:\n - whatsapp\n title: NotificationData\n additionalProperties: false\n description: NotificationData is a union of provider-specific configuration.\n openstatus.notification.v1.NotificationProvider:\n type: string\n title: NotificationProvider\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n - NOTIFICATION_PROVIDER_DISCORD\n - NOTIFICATION_PROVIDER_EMAIL\n - NOTIFICATION_PROVIDER_GOOGLE_CHAT\n - NOTIFICATION_PROVIDER_GRAFANA_ONCALL\n - NOTIFICATION_PROVIDER_NTFY\n - NOTIFICATION_PROVIDER_PAGERDUTY\n - NOTIFICATION_PROVIDER_OPSGENIE\n - NOTIFICATION_PROVIDER_SLACK\n - NOTIFICATION_PROVIDER_SMS\n - NOTIFICATION_PROVIDER_TELEGRAM\n - NOTIFICATION_PROVIDER_WEBHOOK\n - NOTIFICATION_PROVIDER_WHATSAPP\n - NOTIFICATION_PROVIDER_MS_TEAMS\n description: NotificationProvider represents the supported notification channel types.\n openstatus.notification.v1.NotificationSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the notification.\n name:\n type: string\n title: name\n description: Display name for the notification channel.\n provider:\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n monitorCount:\n type: integer\n title: monitor_count\n format: int32\n description: Number of monitors associated with this notification.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the notification was created (RFC 3339).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the notification was last updated (RFC 3339).\n title: NotificationSummary\n additionalProperties: false\n description: NotificationSummary represents a notification channel summary for list responses.\n openstatus.notification.v1.NtfyData:\n type: object\n properties:\n topic:\n type: string\n examples:\n - openstatus-alerts\n title: topic\n minLength: 1\n description: Ntfy topic to publish to.\n serverUrl:\n type: string\n title: server_url\n description: Ntfy server URL (defaults to https://ntfy.sh).\n token:\n type:\n - string\n - \"null\"\n title: token\n description: Optional authentication token.\n title: NtfyData\n additionalProperties: false\n description: NtfyData contains configuration for Ntfy notifications.\n openstatus.notification.v1.OpsgenieData:\n type: object\n properties:\n apiKey:\n type: string\n title: api_key\n minLength: 1\n description: Opsgenie API key.\n region:\n title: region\n description: Opsgenie region.\n $ref: '#/components/schemas/openstatus.notification.v1.OpsgenieRegion'\n title: OpsgenieData\n additionalProperties: false\n description: OpsgenieData contains configuration for Opsgenie notifications.\n openstatus.notification.v1.OpsgenieRegion:\n type: string\n title: OpsgenieRegion\n enum:\n - OPSGENIE_REGION_UNSPECIFIED\n - OPSGENIE_REGION_US\n - OPSGENIE_REGION_EU\n description: OpsgenieRegion represents the Opsgenie API region.\n openstatus.notification.v1.PagerDutyData:\n type: object\n properties:\n integrationKey:\n type: string\n examples:\n - a1b2c3d4e5f6g7h8i9j0\n title: integration_key\n minLength: 1\n description: PagerDuty integration key.\n title: PagerDutyData\n additionalProperties: false\n description: PagerDutyData contains configuration for PagerDuty notifications.\n openstatus.notification.v1.SendTestNotificationRequest:\n type: object\n properties:\n provider:\n not:\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n title: SendTestNotificationRequest\n required:\n - data\n additionalProperties: false\n description: SendTestNotificationRequest is the request to send a test notification.\n openstatus.notification.v1.SendTestNotificationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the test was successful.\n errorMessage:\n type:\n - string\n - \"null\"\n title: error_message\n description: Optional error message if the test failed.\n title: SendTestNotificationResponse\n additionalProperties: false\n description: SendTestNotificationResponse is the response after sending a test notification.\n openstatus.notification.v1.SlackData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://hooks.slack.com/services/T00/B00/xxx\n title: webhook_url\n format: uri\n description: Slack webhook URL.\n title: SlackData\n additionalProperties: false\n description: SlackData contains configuration for Slack notifications.\n openstatus.notification.v1.SmsData:\n type: object\n properties:\n phoneNumber:\n type: string\n examples:\n - \"+14155551234\"\n title: phone_number\n minLength: 1\n description: Phone number to send SMS to.\n title: SmsData\n additionalProperties: false\n description: 'Deprecated: SMS is no longer offered; use WhatsappData. Kept for existing channels.'\n deprecated: true\n openstatus.notification.v1.TelegramData:\n type: object\n properties:\n chatId:\n type: string\n examples:\n - \"-1001234567890\"\n title: chat_id\n minLength: 1\n description: Telegram chat ID.\n title: TelegramData\n additionalProperties: false\n description: TelegramData contains configuration for Telegram notifications.\n openstatus.notification.v1.UpdateNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n description: Updated display name.\n data:\n oneOf:\n - $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n - type: \"null\"\n title: data\n description: Updated provider-specific configuration.\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: Updated monitor IDs to associate.\n updateMonitorIds:\n type:\n - boolean\n - \"null\"\n title: update_monitor_ids\n description: |-\n Set to true to update monitor associations.\n When true, monitor_ids replaces the existing list (empty clears all).\n When false or unset, monitor_ids is ignored and existing associations are preserved.\n title: UpdateNotificationRequest\n additionalProperties: false\n description: UpdateNotificationRequest is the request to update a notification channel.\n openstatus.notification.v1.UpdateNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The updated notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: UpdateNotificationResponse\n additionalProperties: false\n description: UpdateNotificationResponse is the response after updating a notification channel.\n openstatus.notification.v1.WebhookData:\n type: object\n properties:\n endpoint:\n type: string\n examples:\n - https://api.example.com/webhooks/openstatus\n title: endpoint\n format: uri\n description: Webhook endpoint URL.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.notification.v1.WebhookHeader'\n title: headers\n description: Optional custom headers.\n title: WebhookData\n additionalProperties: false\n description: WebhookData contains configuration for custom webhook notifications.\n openstatus.notification.v1.WebhookHeader:\n type: object\n properties:\n key:\n type: string\n title: key\n minLength: 1\n description: Header name.\n value:\n type: string\n title: value\n description: Header value.\n title: WebhookHeader\n additionalProperties: false\n description: WebhookHeader represents a custom header for webhook requests.\n openstatus.notification.v1.WhatsappData:\n type: object\n properties:\n phoneNumber:\n type: string\n title: phone_number\n minLength: 1\n description: Phone number to send WhatsApp messages to.\n title: WhatsappData\n additionalProperties: false\n description: WhatsappData contains configuration for WhatsApp notifications.\n openstatus.private_location.v1.CreatePrivateLocationRequest:\n type: object\n properties:\n name:\n type: string\n examples:\n - eu-west-agent\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the private location (required, 1-256 characters).\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors this private location should run (optional).\n metadata:\n type: object\n title: metadata\n maxProperties: 20\n additionalProperties:\n type: string\n title: value\n maxLength: 256\n description: User-defined key/value labels (optional, up to 20 entries).\n title: CreatePrivateLocationRequest\n additionalProperties: false\n description: CreatePrivateLocationRequest is the request to create a new private location.\n openstatus.private_location.v1.CreatePrivateLocationRequest.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.CreatePrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The created private location, including its generated agent token.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: CreatePrivateLocationResponse\n additionalProperties: false\n description: CreatePrivateLocationResponse is the response after creating a private location.\n openstatus.private_location.v1.DeletePrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to delete (required).\n title: DeletePrivateLocationRequest\n additionalProperties: false\n description: DeletePrivateLocationRequest is the request to delete a private location.\n openstatus.private_location.v1.DeletePrivateLocationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeletePrivateLocationResponse\n additionalProperties: false\n description: DeletePrivateLocationResponse is the response after deleting a private location.\n openstatus.private_location.v1.GetPrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to retrieve (required).\n title: GetPrivateLocationRequest\n additionalProperties: false\n description: GetPrivateLocationRequest is the request to get a private location by ID.\n openstatus.private_location.v1.GetPrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The requested private location.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: GetPrivateLocationResponse\n additionalProperties: false\n description: GetPrivateLocationResponse is the response containing the private location.\n openstatus.private_location.v1.ListPrivateLocationsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of private locations to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of private locations to skip for pagination (defaults to 0).\n title: ListPrivateLocationsRequest\n additionalProperties: false\n description: ListPrivateLocationsRequest is the request to list private locations.\n openstatus.private_location.v1.ListPrivateLocationsResponse:\n type: object\n properties:\n privateLocations:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationSummary'\n title: private_locations\n description: List of private locations.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of private locations in the workspace.\n title: ListPrivateLocationsResponse\n additionalProperties: false\n description: ListPrivateLocationsResponse is the response containing private location summaries.\n openstatus.private_location.v1.PrivateLocation:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the private location.\n name:\n type: string\n title: name\n description: Display name for the private location.\n token:\n type: string\n title: token\n description: |-\n Agent credential. Generated by the server on creation and used by the\n agent to authenticate; treat it as a secret.\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors this private location runs.\n lastSeenAt:\n type: string\n title: last_seen_at\n description: Last time the agent reported a result (RFC 3339), empty if it never has.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the private location was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the private location was last updated (RFC 3339 format).\n metadata:\n type: object\n title: metadata\n additionalProperties:\n type: string\n title: value\n description: User-defined key/value labels attached to this private location.\n status:\n title: status\n description: Computed health of the agent. Read-only.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'\n title: PrivateLocation\n additionalProperties: false\n description: PrivateLocation represents a self-hosted checker agent with full details.\n openstatus.private_location.v1.PrivateLocation.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.PrivateLocationStatus:\n type: string\n title: PrivateLocationStatus\n enum:\n - PRIVATE_LOCATION_STATUS_UNSPECIFIED\n - PRIVATE_LOCATION_STATUS_ACTIVE\n - PRIVATE_LOCATION_STATUS_ERROR\n description: |-\n PrivateLocationStatus is the computed health of a private location, derived\n from the agent heartbeat. Read-only — it cannot be set through the API.\n openstatus.private_location.v1.PrivateLocationSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the private location.\n name:\n type: string\n title: name\n description: Display name for the private location.\n monitorCount:\n type: integer\n title: monitor_count\n format: int32\n description: Number of monitors this private location runs.\n lastSeenAt:\n type: string\n title: last_seen_at\n description: Last time the agent reported a result (RFC 3339), empty if it never has.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the private location was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the private location was last updated (RFC 3339 format).\n status:\n title: status\n description: Computed health of the agent. Read-only.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'\n metadata:\n type: object\n title: metadata\n additionalProperties:\n type: string\n title: value\n description: User-defined key/value labels attached to this private location.\n title: PrivateLocationSummary\n additionalProperties: false\n description: |-\n PrivateLocationSummary represents metadata for a private location (used in\n list responses). The agent token is intentionally omitted.\n openstatus.private_location.v1.PrivateLocationSummary.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.UpdatePrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n minLength: 1\n description: New display name for the private location (optional).\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: New list of monitor IDs. Only applied when update_monitor_ids is true.\n updateMonitorIds:\n type:\n - boolean\n - \"null\"\n title: update_monitor_ids\n description: |-\n When true, monitor_ids replaces the current associations (an empty list\n clears all). When false or unset, monitor_ids is ignored and existing\n associations are preserved.\n metadata:\n type: object\n title: metadata\n maxProperties: 20\n additionalProperties:\n type: string\n title: value\n maxLength: 256\n description: New key/value labels. Only applied when update_metadata is true.\n updateMetadata:\n type:\n - boolean\n - \"null\"\n title: update_metadata\n description: |-\n When true, metadata replaces the current labels (an empty map clears all).\n When false or unset, metadata is ignored and existing labels are preserved.\n title: UpdatePrivateLocationRequest\n additionalProperties: false\n description: UpdatePrivateLocationRequest is the request to update a private location.\n openstatus.private_location.v1.UpdatePrivateLocationRequest.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.UpdatePrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The updated private location.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: UpdatePrivateLocationResponse\n additionalProperties: false\n description: UpdatePrivateLocationResponse is the response after updating a private location.\n openstatus.status_page.v1.AddMonitorComponentRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to add the component to (required).\n monitorId:\n type: string\n title: monitor_id\n minLength: 1\n description: ID of the monitor to associate with this component (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n description: Display name for the component (optional, defaults to monitor name).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: Display order of the component (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: ID of the group to add this component to (optional).\n title: AddMonitorComponentRequest\n additionalProperties: false\n description: AddMonitorComponentRequest is the request to add a monitor-based component to a status page.\n openstatus.status_page.v1.AddMonitorComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The created component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: AddMonitorComponentResponse\n additionalProperties: false\n description: AddMonitorComponentResponse is the response after adding a monitor component.\n openstatus.status_page.v1.AddStaticComponentRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to add the component to (required).\n name:\n type: string\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the component (required).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: Display order of the component (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: ID of the group to add this component to (optional).\n title: AddStaticComponentRequest\n additionalProperties: false\n description: AddStaticComponentRequest is the request to add a static component to a status page.\n openstatus.status_page.v1.AddStaticComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The created component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: AddStaticComponentResponse\n additionalProperties: false\n description: AddStaticComponentResponse is the response after adding a static component.\n openstatus.status_page.v1.ComponentDayBucket:\n type: object\n properties:\n day:\n type: string\n title: day\n description: Day in RFC 3339 format (UTC midnight).\n count:\n type:\n - integer\n - string\n title: count\n format: int64\n description: Total checks that day.\n ok:\n type:\n - integer\n - string\n title: ok\n format: int64\n description: Successful checks.\n degraded:\n type:\n - integer\n - string\n title: degraded\n format: int64\n description: Degraded checks.\n error:\n type:\n - integer\n - string\n title: error\n format: int64\n description: Failed checks.\n status:\n title: status\n description: Convenience resolved status for the day.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayStatus'\n impact:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n - type: \"null\"\n title: impact\n description: Worst status-report impact overlapping the day (absent when none).\n title: ComponentDayBucket\n additionalProperties: false\n description: ComponentDayBucket is one day of status data for a component.\n openstatus.status_page.v1.ComponentDayStatus:\n type: string\n title: ComponentDayStatus\n enum:\n - COMPONENT_DAY_STATUS_UNSPECIFIED\n - COMPONENT_DAY_STATUS_OPERATIONAL\n - COMPONENT_DAY_STATUS_DEGRADED\n - COMPONENT_DAY_STATUS_DOWN\n - COMPONENT_DAY_STATUS_MAINTENANCE\n - COMPONENT_DAY_STATUS_EMPTY\n description: ComponentDayStatus is the resolved status of a component on a given day.\n openstatus.status_page.v1.ComponentEvent:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Identifier of the underlying event.\n name:\n type: string\n title: name\n description: Human-readable name (incident \"Downtime\", maintenance / report title).\n type:\n title: type\n description: Kind of event.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventType'\n status:\n title: status\n description: Projected status this event contributes.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventStatus'\n from:\n type: string\n title: from\n description: Start time (RFC 3339).\n to:\n type:\n - string\n - \"null\"\n title: to\n description: End time (RFC 3339); absent while the event is ongoing.\n impact:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n - type: \"null\"\n title: impact\n description: Worst impact over the event (reports only; absent otherwise).\n title: ComponentEvent\n additionalProperties: false\n description: ComponentEvent is a single incident / maintenance / report affecting a component.\n openstatus.status_page.v1.ComponentEventStatus:\n type: string\n title: ComponentEventStatus\n enum:\n - COMPONENT_EVENT_STATUS_UNSPECIFIED\n - COMPONENT_EVENT_STATUS_OPERATIONAL\n - COMPONENT_EVENT_STATUS_DEGRADED\n - COMPONENT_EVENT_STATUS_DOWN\n - COMPONENT_EVENT_STATUS_MAINTENANCE\n description: ComponentEventStatus is the projected status an event contributes.\n openstatus.status_page.v1.ComponentEventType:\n type: string\n title: ComponentEventType\n enum:\n - COMPONENT_EVENT_TYPE_UNSPECIFIED\n - COMPONENT_EVENT_TYPE_MAINTENANCE\n - COMPONENT_EVENT_TYPE_INCIDENT\n - COMPONENT_EVENT_TYPE_REPORT\n description: ComponentEventType is the kind of timeline event affecting a component.\n openstatus.status_page.v1.ComponentStatus:\n type: object\n properties:\n componentId:\n type: string\n title: component_id\n description: ID of the component.\n status:\n title: status\n description: Current status of the component.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n title: ComponentStatus\n additionalProperties: false\n description: ComponentStatus represents the status of a single component.\n openstatus.status_page.v1.CreateComponentGroupRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to create the group in (required).\n name:\n type: string\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the group (required).\n defaultOpen:\n type:\n - boolean\n - \"null\"\n title: default_open\n description: Whether the group should be expanded by default on the status page (optional, defaults to false).\n title: CreateComponentGroupRequest\n additionalProperties: false\n description: CreateComponentGroupRequest is the request to create a new component group.\n openstatus.status_page.v1.CreateComponentGroupResponse:\n type: object\n properties:\n group:\n title: group\n description: The created component group.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: CreateComponentGroupResponse\n additionalProperties: false\n description: CreateComponentGroupResponse is the response after creating a component group.\n openstatus.status_page.v1.CreatePageSubscriptionRequest:\n type: object\n allOf:\n - properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 255\n description: Optional human-readable label.\n componentIds:\n type: array\n items:\n type: string\n title: component_ids\n description: Component scope. Empty = entire page.\n - oneOf:\n - type: object\n properties:\n emailChannel:\n title: email_channel\n $ref: '#/components/schemas/openstatus.status_page.v1.EmailChannel'\n title: email_channel\n required:\n - emailChannel\n - type: object\n properties:\n webhookChannel:\n title: webhook_channel\n $ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannel'\n title: webhook_channel\n required:\n - webhookChannel\n title: CreatePageSubscriptionRequest\n additionalProperties: false\n description: CreatePageSubscriptionRequest is the request to add a vendor-managed subscriber to a status page.\n openstatus.status_page.v1.CreatePageSubscriptionResponse:\n type: object\n properties:\n subscriber:\n title: subscriber\n description: The created subscriber.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: CreatePageSubscriptionResponse\n additionalProperties: false\n description: CreatePageSubscriptionResponse is the response after creating a vendor-managed subscription.\n openstatus.status_page.v1.CreateStatusPageRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - Acme Corp Status\n title: title\n maxLength: 256\n minLength: 1\n description: Title of the status page (required).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the status page (optional).\n slug:\n type: string\n examples:\n - my-status-page\n title: slug\n maxLength: 256\n minLength: 1\n pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$\n description: URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens.\n homepageUrl:\n type:\n - string\n - \"null\"\n examples:\n - https://www.example.com\n title: homepage_url\n description: URL to the homepage (optional).\n contactUrl:\n type:\n - string\n - \"null\"\n title: contact_url\n description: URL to the contact page (optional).\n defaultLocale:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n - type: \"null\"\n title: default_locale\n description: Default locale for the status page (optional, defaults to EN).\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: Enabled locales for the status page (optional).\n icon:\n type:\n - string\n - \"null\"\n title: icon\n maxLength: 1024\n description: Icon URL for the status page (optional).\n customDomain:\n type:\n - string\n - \"null\"\n title: custom_domain\n maxLength: 256\n description: Custom domain for the status page (optional).\n theme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n - type: \"null\"\n title: theme\n description: Visual theme for the status page (optional, defaults to SYSTEM).\n accessType:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n - type: \"null\"\n title: access_type\n description: Access type for the status page (optional, defaults to PUBLIC).\n password:\n type:\n - string\n - \"null\"\n title: password\n maxLength: 256\n minLength: 1\n description: Password for the status page (required when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: Email domains allowed to access the page (used when access_type is AUTHENTICATED).\n allowIndex:\n type:\n - boolean\n - \"null\"\n title: allow_index\n description: Whether search engines are allowed to index this status page (optional, defaults to true).\n allowedIpRanges:\n type:\n - string\n - \"null\"\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: |-\n Per-mode CSS variable overrides merged over the theme (optional).\n Only supported variable names are accepted. Requires the custom-theme plan feature.\n title: CreateStatusPageRequest\n additionalProperties: false\n description: CreateStatusPageRequest is the request to create a new status page.\n openstatus.status_page.v1.CreateStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The created status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: CreateStatusPageResponse\n additionalProperties: false\n description: CreateStatusPageResponse is the response after creating a status page.\n openstatus.status_page.v1.CustomTheme:\n type: object\n properties:\n light:\n type: object\n title: light\n additionalProperties:\n type: string\n title: value\n description: 'CSS variable overrides applied in light mode, keyed by variable name (e.g. \"--primary\": \"hsl(24 94% 50%)\").'\n dark:\n type: object\n title: dark\n additionalProperties:\n type: string\n title: value\n description: CSS variable overrides applied in dark mode, keyed by variable name.\n title: CustomTheme\n additionalProperties: false\n description: CustomTheme holds per-mode CSS variable overrides merged over the page theme.\n openstatus.status_page.v1.CustomTheme.DarkEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: DarkEntry\n additionalProperties: false\n openstatus.status_page.v1.CustomTheme.LightEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: LightEntry\n additionalProperties: false\n openstatus.status_page.v1.DeleteComponentGroupRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component group to delete (required).\n title: DeleteComponentGroupRequest\n additionalProperties: false\n description: DeleteComponentGroupRequest is the request to delete a component group.\n openstatus.status_page.v1.DeleteComponentGroupResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteComponentGroupResponse\n additionalProperties: false\n description: DeleteComponentGroupResponse is the response after deleting a component group.\n openstatus.status_page.v1.DeleteStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to delete (required).\n title: DeleteStatusPageRequest\n additionalProperties: false\n description: DeleteStatusPageRequest is the request to delete a status page.\n openstatus.status_page.v1.DeleteStatusPageResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteStatusPageResponse\n additionalProperties: false\n description: DeleteStatusPageResponse is the response after deleting a status page.\n openstatus.status_page.v1.EmailChannel:\n type: object\n properties:\n email:\n type: string\n title: email\n format: email\n description: Email address of the subscriber (required).\n title: EmailChannel\n additionalProperties: false\n description: EmailChannel carries the email-channel fields for CreatePageSubscription.\n openstatus.status_page.v1.GetOverallStatusRequest:\n type: object\n oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetOverallStatusRequest\n additionalProperties: false\n description: GetOverallStatusRequest is the request to get the overall status of a status page.\n openstatus.status_page.v1.GetOverallStatusResponse:\n type: object\n properties:\n overallStatus:\n title: overall_status\n description: Aggregated status across all components.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n componentStatuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'\n title: component_statuses\n description: Status of individual components.\n title: GetOverallStatusResponse\n additionalProperties: false\n description: GetOverallStatusResponse is the response containing the overall status and individual component statuses.\n openstatus.status_page.v1.GetPageComponentDailySummaryRequest:\n type: object\n allOf:\n - properties:\n componentIds:\n type: array\n items:\n type: string\n minLength: 1\n title: component_ids\n description: Restrict the result to these component ids (optional, defaults to all components).\n days:\n type:\n - integer\n - \"null\"\n title: days\n maximum: 45\n minimum: 1\n format: int32\n description: Number of days to return (1-45, defaults to 45 if unspecified).\n - oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetPageComponentDailySummaryRequest\n additionalProperties: false\n description: GetPageComponentDailySummaryRequest is the request for per-component daily summaries.\n openstatus.status_page.v1.GetPageComponentDailySummaryResponse:\n type: object\n properties:\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentDailySummary'\n title: components\n description: Per-component daily summaries, in page order.\n title: GetPageComponentDailySummaryResponse\n additionalProperties: false\n description: GetPageComponentDailySummaryResponse is the response containing per-component summaries.\n openstatus.status_page.v1.GetPageComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to retrieve (required).\n title: GetPageComponentRequest\n additionalProperties: false\n description: GetPageComponentRequest is the request to fetch a single component by ID.\n openstatus.status_page.v1.GetPageComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The requested component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: GetPageComponentResponse\n additionalProperties: false\n description: GetPageComponentResponse is the response containing the component.\n openstatus.status_page.v1.GetStatusPageContentRequest:\n type: object\n oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetStatusPageContentRequest\n additionalProperties: false\n description: GetStatusPageContentRequest is the request to get the full content of a status page.\n openstatus.status_page.v1.GetStatusPageContentResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The status page details.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: components\n description: Components on the status page.\n groups:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: groups\n description: Component groups on the status page.\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: status_reports\n description: Active and recent status reports.\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: Scheduled maintenances.\n title: GetStatusPageContentResponse\n additionalProperties: false\n description: GetStatusPageContentResponse is the response containing the full status page content.\n openstatus.status_page.v1.GetStatusPageOverviewRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page (required, workspace-scoped).\n title: GetStatusPageOverviewRequest\n additionalProperties: false\n description: GetStatusPageOverviewRequest requests the full overview of a status page by id.\n openstatus.status_page.v1.GetStatusPageOverviewResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The status page details.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n configuration:\n title: configuration\n description: Rich rendering configuration of the page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageConfiguration'\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: components\n description: Components on the status page.\n groups:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: groups\n description: Component groups on the status page.\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: status_reports\n description: Active and recent status reports.\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: Scheduled maintenances.\n overallStatus:\n title: overall_status\n description: Aggregated status across all components.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n componentStatuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'\n title: component_statuses\n description: Status of individual components.\n title: GetStatusPageOverviewResponse\n additionalProperties: false\n description: GetStatusPageOverviewResponse bundles all data for a single status page.\n openstatus.status_page.v1.GetStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to retrieve (required).\n title: GetStatusPageRequest\n additionalProperties: false\n description: GetStatusPageRequest is the request to get a status page by ID.\n openstatus.status_page.v1.GetStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The requested status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: GetStatusPageResponse\n additionalProperties: false\n description: GetStatusPageResponse is the response containing the status page.\n openstatus.status_page.v1.ListStatusPagesRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of pages to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of pages to skip for pagination (defaults to 0).\n title: ListStatusPagesRequest\n additionalProperties: false\n description: ListStatusPagesRequest is the request to list status pages.\n openstatus.status_page.v1.ListStatusPagesResponse:\n type: object\n properties:\n statusPages:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPageSummary'\n title: status_pages\n description: List of status pages (metadata only).\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of status pages.\n title: ListStatusPagesResponse\n additionalProperties: false\n description: ListStatusPagesResponse is the response containing status page summaries.\n openstatus.status_page.v1.ListSubscribersRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to list subscribers for (required).\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of subscribers to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of subscribers to skip for pagination (defaults to 0).\n includeUnsubscribed:\n type:\n - boolean\n - \"null\"\n title: include_unsubscribed\n description: Whether to include unsubscribed users (defaults to false).\n title: ListSubscribersRequest\n additionalProperties: false\n description: ListSubscribersRequest is the request to list subscribers of a status page.\n openstatus.status_page.v1.ListSubscribersResponse:\n type: object\n properties:\n subscribers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: subscribers\n description: List of subscribers.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of subscribers matching the filter.\n title: ListSubscribersResponse\n additionalProperties: false\n description: ListSubscribersResponse is the response containing status page subscribers.\n openstatus.status_page.v1.Locale:\n type: string\n title: Locale\n enum:\n - LOCALE_UNSPECIFIED\n - LOCALE_EN\n - LOCALE_FR\n - LOCALE_DE\n - LOCALE_TR\n - LOCALE_HI\n - LOCALE_KO\n - LOCALE_JA\n description: Locale defines the supported languages for a status page.\n openstatus.status_page.v1.OverallStatus:\n type: string\n title: OverallStatus\n enum:\n - OVERALL_STATUS_UNSPECIFIED\n - OVERALL_STATUS_OPERATIONAL\n - OVERALL_STATUS_DEGRADED\n - OVERALL_STATUS_PARTIAL_OUTAGE\n - OVERALL_STATUS_MAJOR_OUTAGE\n - OVERALL_STATUS_MAINTENANCE\n - OVERALL_STATUS_UNKNOWN\n description: OverallStatus represents the aggregated status of all components on a page.\n openstatus.status_page.v1.PageAccessType:\n type: string\n title: PageAccessType\n enum:\n - PAGE_ACCESS_TYPE_UNSPECIFIED\n - PAGE_ACCESS_TYPE_PUBLIC\n - PAGE_ACCESS_TYPE_PASSWORD_PROTECTED\n - PAGE_ACCESS_TYPE_AUTHENTICATED\n - PAGE_ACCESS_TYPE_IP_RESTRICTED\n description: PageAccessType defines who can access the status page.\n openstatus.status_page.v1.PageBarType:\n type: string\n title: PageBarType\n enum:\n - PAGE_BAR_TYPE_UNSPECIFIED\n - PAGE_BAR_TYPE_ABSOLUTE\n - PAGE_BAR_TYPE_MANUAL\n description: PageBarType mirrors page.configuration.type (how the status bar is computed).\n openstatus.status_page.v1.PageComponent:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the component.\n pageId:\n type: string\n title: page_id\n description: ID of the status page this component belongs to.\n name:\n type: string\n title: name\n description: Display name of the component.\n description:\n type: string\n title: description\n description: Description of the component (optional).\n type:\n title: type\n description: Type of the component (monitor or static).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'\n monitorId:\n type: string\n title: monitor_id\n description: ID of the monitor if type is MONITOR (optional).\n order:\n type: integer\n title: order\n format: int32\n description: Display order of the component.\n groupId:\n type: string\n title: group_id\n description: ID of the group this component belongs to (optional).\n groupOrder:\n type: integer\n title: group_order\n format: int32\n description: Order within the group if grouped.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the component was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the component was last updated (RFC 3339 format).\n title: PageComponent\n additionalProperties: false\n description: PageComponent represents a component displayed on a status page.\n openstatus.status_page.v1.PageComponentDailySummary:\n type: object\n properties:\n componentId:\n type: string\n title: component_id\n description: ID of the component.\n type:\n title: type\n description: Component type (monitor or static).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'\n monitorId:\n type:\n - string\n - \"null\"\n title: monitor_id\n description: Monitor id backing the component (absent for static components).\n name:\n type: string\n title: name\n description: Display name of the component.\n buckets:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayBucket'\n title: buckets\n description: Per-day buckets, oldest first.\n events:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEvent'\n title: events\n description: Events affecting the component within the window.\n title: PageComponentDailySummary\n additionalProperties: false\n description: PageComponentDailySummary is the per-day buckets + event timeline for one component.\n openstatus.status_page.v1.PageComponentGroup:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the group.\n pageId:\n type: string\n title: page_id\n description: ID of the status page this group belongs to.\n name:\n type: string\n title: name\n description: Display name of the group.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the group was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the group was last updated (RFC 3339 format).\n defaultOpen:\n type: boolean\n title: default_open\n description: Whether the group should be expanded by default on the status page.\n title: PageComponentGroup\n additionalProperties: false\n description: PageComponentGroup represents a group of components on a status page.\n openstatus.status_page.v1.PageComponentType:\n type: string\n title: PageComponentType\n enum:\n - PAGE_COMPONENT_TYPE_UNSPECIFIED\n - PAGE_COMPONENT_TYPE_MONITOR\n - PAGE_COMPONENT_TYPE_STATIC\n description: PageComponentType defines the type of a component on a status page.\n openstatus.status_page.v1.PageConfiguration:\n type: object\n properties:\n metricType:\n title: metric_type\n description: Which metric the status bars represent (configuration.value).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageMetricType'\n barType:\n title: bar_type\n description: How the status bar is computed (configuration.type).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageBarType'\n showUptime:\n type: boolean\n title: show_uptime\n description: Whether to show the uptime percentage (configuration.uptime).\n themeKey:\n type: string\n title: theme_key\n description: |-\n Theme key from the theme store (configuration.theme), e.g. \"default\".\n Free-form string rather than an enum because the theme catalog is dynamic.\n days:\n type: integer\n title: days\n format: int32\n description: 'Number of uptime-bar days rendered on the page (configuration.days): 30 or 45.'\n title: PageConfiguration\n additionalProperties: false\n description: PageConfiguration is the rich rendering config stored in page.configuration.\n openstatus.status_page.v1.PageMetricType:\n type: string\n title: PageMetricType\n enum:\n - PAGE_METRIC_TYPE_UNSPECIFIED\n - PAGE_METRIC_TYPE_DURATION\n - PAGE_METRIC_TYPE_REQUESTS\n - PAGE_METRIC_TYPE_MANUAL\n description: PageMetricType mirrors page.configuration.value (which metric the status bars represent).\n openstatus.status_page.v1.PageSubscriber:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the subscriber.\n pageId:\n type: string\n title: page_id\n description: ID of the status page the user is subscribed to.\n email:\n type: string\n title: email\n description: Email address of the subscriber (empty for webhook channels).\n acceptedAt:\n type: string\n title: accepted_at\n description: Timestamp when the subscription was accepted/confirmed (RFC 3339 format, optional).\n unsubscribedAt:\n type: string\n title: unsubscribed_at\n description: Timestamp when the user unsubscribed (RFC 3339 format, optional).\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the subscription was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the subscription was last updated (RFC 3339 format).\n source:\n title: source\n description: How the subscription was created. Vendor-added rows skip verification.\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscriberSource'\n name:\n type:\n - string\n - \"null\"\n title: name\n description: 'Optional human-readable label (e.g. \"Supabase #incidents\").'\n channelType:\n type: string\n title: channel_type\n description: 'Channel type: \"email\" or \"webhook\".'\n webhookUrl:\n type:\n - string\n - \"null\"\n title: webhook_url\n description: Webhook URL (populated only for channel_type = \"webhook\").\n channelConfig:\n type:\n - string\n - \"null\"\n title: channel_config\n description: JSON-encoded channel config (e.g. custom headers). Populated for webhook channels.\n componentIds:\n type: array\n items:\n type: string\n title: component_ids\n description: IDs of components this subscription is scoped to. Empty = entire page.\n title: PageSubscriber\n additionalProperties: false\n description: PageSubscriber represents a subscriber to a status page.\n openstatus.status_page.v1.PageTheme:\n type: string\n title: PageTheme\n enum:\n - PAGE_THEME_UNSPECIFIED\n - PAGE_THEME_SYSTEM\n - PAGE_THEME_LIGHT\n - PAGE_THEME_DARK\n description: PageTheme defines the visual theme of the status page.\n openstatus.status_page.v1.RemoveComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to remove (required).\n title: RemoveComponentRequest\n additionalProperties: false\n description: RemoveComponentRequest is the request to remove a component from a status page.\n openstatus.status_page.v1.RemoveComponentResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the removal was successful.\n title: RemoveComponentResponse\n additionalProperties: false\n description: RemoveComponentResponse is the response after removing a component.\n openstatus.status_page.v1.StatusPage:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status page.\n title:\n type: string\n title: title\n description: Title of the status page.\n description:\n type: string\n title: description\n description: Description of the status page.\n slug:\n type: string\n examples:\n - acme-corp\n title: slug\n description: URL-friendly slug for the status page.\n customDomain:\n type: string\n examples:\n - status.example.com\n title: custom_domain\n description: Custom domain for the status page (optional).\n published:\n type: boolean\n title: published\n description: Whether the status page is published and visible.\n accessType:\n title: access_type\n description: Access type for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n theme:\n title: theme\n description: Visual theme for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n homepageUrl:\n type: string\n title: homepage_url\n description: URL to the homepage (optional).\n contactUrl:\n type: string\n title: contact_url\n description: URL to the contact page (optional).\n icon:\n type: string\n title: icon\n description: Icon URL for the status page (optional).\n createdAt:\n type: string\n examples:\n - \"2024-01-15T09:00:00Z\"\n title: created_at\n description: Timestamp when the page was created (RFC 3339 format).\n updatedAt:\n type: string\n examples:\n - \"2024-06-20T14:30:00Z\"\n title: updated_at\n description: Timestamp when the page was last updated (RFC 3339 format).\n defaultLocale:\n title: default_locale\n description: Default locale for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: Enabled locales for the status page.\n password:\n type: string\n title: password\n description: Password for the status page (only set when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: Email domains allowed to access the page (only set when access_type is AUTHENTICATED).\n allowIndex:\n type: boolean\n title: allow_index\n description: Whether search engines are allowed to index this status page.\n allowedIpRanges:\n type: string\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (only set when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: Per-mode CSS variable overrides merged over the theme (only set when configured).\n title: StatusPage\n additionalProperties: false\n description: StatusPage represents a full status page with all details.\n openstatus.status_page.v1.StatusPageSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status page.\n title:\n type: string\n title: title\n description: Title of the status page.\n slug:\n type: string\n title: slug\n description: URL-friendly slug for the status page.\n published:\n type: boolean\n title: published\n description: Whether the status page is published and visible.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the page was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the page was last updated (RFC 3339 format).\n customDomain:\n type: string\n examples:\n - status.example.com\n title: custom_domain\n description: Custom domain for the status page (optional).\n title: StatusPageSummary\n additionalProperties: false\n description: StatusPageSummary represents metadata for a status page (used in list responses).\n openstatus.status_page.v1.SubscribeToPageRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to subscribe to (required).\n email:\n type: string\n examples:\n - [email protected]\n title: email\n format: email\n description: Email address to subscribe (required).\n title: SubscribeToPageRequest\n additionalProperties: false\n description: SubscribeToPageRequest is the request to subscribe an email to a status page.\n openstatus.status_page.v1.SubscribeToPageResponse:\n type: object\n properties:\n subscriber:\n title: subscriber\n description: The created subscriber.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: SubscribeToPageResponse\n additionalProperties: false\n description: SubscribeToPageResponse is the response after subscribing to a status page.\n openstatus.status_page.v1.SubscriberSource:\n type: string\n title: SubscriberSource\n enum:\n - SUBSCRIBER_SOURCE_UNSPECIFIED\n - SUBSCRIBER_SOURCE_SELF_SIGNUP\n - SUBSCRIBER_SOURCE_VENDOR\n - SUBSCRIBER_SOURCE_IMPORT\n description: SubscriberSource indicates how the subscription was created.\n openstatus.status_page.v1.UnsubscribeFromPageRequest:\n type: object\n allOf:\n - properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to unsubscribe from (required).\n - oneOf:\n - type: object\n properties:\n email:\n type: string\n title: email\n description: Email address to unsubscribe.\n title: email\n required:\n - email\n - type: object\n properties:\n id:\n type: string\n title: id\n description: Subscriber ID.\n title: id\n required:\n - id\n title: UnsubscribeFromPageRequest\n additionalProperties: false\n description: UnsubscribeFromPageRequest is the request to unsubscribe from a status page.\n openstatus.status_page.v1.UnsubscribeFromPageResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the unsubscription was successful.\n title: UnsubscribeFromPageResponse\n additionalProperties: false\n description: UnsubscribeFromPageResponse is the response after unsubscribing from a status page.\n openstatus.status_page.v1.UpdateComponentGroupRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component group to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n minLength: 1\n description: New display name for the group (optional).\n defaultOpen:\n type:\n - boolean\n - \"null\"\n title: default_open\n description: Whether the group should be expanded by default on the status page (optional).\n title: UpdateComponentGroupRequest\n additionalProperties: false\n description: UpdateComponentGroupRequest is the request to update a component group.\n openstatus.status_page.v1.UpdateComponentGroupResponse:\n type: object\n properties:\n group:\n title: group\n description: The updated component group.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: UpdateComponentGroupResponse\n additionalProperties: false\n description: UpdateComponentGroupResponse is the response after updating a component group.\n openstatus.status_page.v1.UpdateComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n description: New display name for the component (optional).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: New description for the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: New display order (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: New group ID (optional, set to empty string to remove from group).\n groupOrder:\n type:\n - integer\n - \"null\"\n title: group_order\n format: int32\n description: New order within the group (optional).\n title: UpdateComponentRequest\n additionalProperties: false\n description: UpdateComponentRequest is the request to update a component.\n openstatus.status_page.v1.UpdateComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The updated component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: UpdateComponentResponse\n additionalProperties: false\n description: UpdateComponentResponse is the response after updating a component.\n openstatus.status_page.v1.UpdateStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n maxLength: 256\n minLength: 1\n description: New title for the status page (optional).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: New description for the status page (optional).\n slug:\n type:\n - string\n - \"null\"\n title: slug\n maxLength: 256\n minLength: 1\n pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$\n description: New slug for the status page (optional).\n homepageUrl:\n type:\n - string\n - \"null\"\n title: homepage_url\n description: New homepage URL (optional).\n contactUrl:\n type:\n - string\n - \"null\"\n title: contact_url\n description: New contact URL (optional).\n defaultLocale:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n - type: \"null\"\n title: default_locale\n description: New default locale for the status page (optional).\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: New enabled locales for the status page (optional).\n icon:\n type:\n - string\n - \"null\"\n title: icon\n maxLength: 1024\n description: New icon URL for the status page (optional).\n customDomain:\n type:\n - string\n - \"null\"\n title: custom_domain\n maxLength: 256\n description: New custom domain (optional).\n theme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n - type: \"null\"\n title: theme\n description: New visual theme (optional).\n accessType:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n - type: \"null\"\n title: access_type\n description: New access type (optional).\n password:\n type:\n - string\n - \"null\"\n title: password\n maxLength: 256\n minLength: 1\n description: New password (optional, required when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: New email domains (optional, required when access_type is AUTHENTICATED).\n allowIndex:\n type:\n - boolean\n - \"null\"\n title: allow_index\n description: Whether search engines are allowed to index this status page (optional).\n allowedIpRanges:\n type:\n - string\n - \"null\"\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: |-\n New per-mode CSS variable overrides (optional). Omit to keep the current\n value; send an empty message to clear. Requires the custom-theme plan feature.\n title: UpdateStatusPageRequest\n additionalProperties: false\n description: UpdateStatusPageRequest is the request to update a status page.\n openstatus.status_page.v1.UpdateStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The updated status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: UpdateStatusPageResponse\n additionalProperties: false\n description: UpdateStatusPageResponse is the response after updating a status page.\n openstatus.status_page.v1.WebhookChannel:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n maxLength: 2048\n minLength: 1\n format: uri\n description: Webhook URL (required). Payload flavor (Slack / Discord / generic) is auto-detected from the URL prefix.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannelHeader'\n title: headers\n description: Optional custom HTTP headers attached to every dispatch.\n title: WebhookChannel\n additionalProperties: false\n description: WebhookChannel carries the webhook-channel fields for CreatePageSubscription.\n openstatus.status_page.v1.WebhookChannelHeader:\n type: object\n properties:\n key:\n type: string\n title: key\n minLength: 1\n value:\n type: string\n title: value\n title: WebhookChannelHeader\n additionalProperties: false\n description: WebhookChannelHeader is a single custom HTTP header.\n openstatus.status_report.v1.AddStatusReportUpdateRequest:\n type: object\n properties:\n statusReportId:\n type: string\n title: status_report_id\n minLength: 1\n description: ID of the status report to update (required).\n status:\n title: status\n description: New status for the report (required).\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n message:\n type: string\n title: message\n minLength: 1\n description: Message describing what changed (required).\n date:\n type:\n - string\n - \"null\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Optional date for the update (RFC 3339 format). Defaults to current time if not provided.\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this update (optional, defaults to false).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: |-\n Per-component impacts this update sets (optional). Components named here\n are added to the report's affected set; omitted components keep their\n prior impact.\n title: AddStatusReportUpdateRequest\n additionalProperties: false\n description: AddStatusReportUpdateRequest is the request to add a new update to a status report.\n openstatus.status_report.v1.AddStatusReportUpdateResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The updated status report with the new update included.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: AddStatusReportUpdateResponse\n additionalProperties: false\n description: AddStatusReportUpdateResponse is the response after adding an update to a status report.\n openstatus.status_report.v1.ComponentImpact:\n type: object\n properties:\n pageComponentId:\n type: string\n title: page_component_id\n description: ID of the affected page component.\n impact:\n title: impact\n description: Impact set for the component.\n $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n title: ComponentImpact\n additionalProperties: false\n description: ComponentImpact pairs a page component with the impact an update set for it.\n openstatus.status_report.v1.CreateStatusReportRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - API Degradation Investigation\n title: title\n minLength: 1\n description: Title of the status report (required).\n status:\n title: status\n description: Initial status (required).\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n message:\n type: string\n examples:\n - We are investigating reports of increased API latency.\n title: message\n minLength: 1\n description: Initial message describing the incident (required).\n date:\n type: string\n examples:\n - \"2024-03-15T10:30:00Z\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Date when the event occurred (RFC 3339 format, required).\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: Page ID to associate with this report (required).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: Page component IDs to associate with this report (optional).\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this status report (optional, defaults to false).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: |-\n Per-component impacts set by the initial update (optional). When provided,\n the named components are added to the report's affected set. Omitting this\n field creates a legacy report without impact tracking.\n title: CreateStatusReportRequest\n additionalProperties: false\n description: CreateStatusReportRequest is the request to create a new status report.\n openstatus.status_report.v1.CreateStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The created status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: CreateStatusReportResponse\n additionalProperties: false\n description: CreateStatusReportResponse is the response after creating a status report.\n openstatus.status_report.v1.DeleteStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to delete (required).\n title: DeleteStatusReportRequest\n additionalProperties: false\n description: DeleteStatusReportRequest is the request to delete a status report.\n openstatus.status_report.v1.DeleteStatusReportResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteStatusReportResponse\n additionalProperties: false\n description: DeleteStatusReportResponse is the response after deleting a status report.\n openstatus.status_report.v1.GetStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to retrieve (required).\n title: GetStatusReportRequest\n additionalProperties: false\n description: GetStatusReportRequest is the request to get a status report by ID.\n openstatus.status_report.v1.GetStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The requested status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: GetStatusReportResponse\n additionalProperties: false\n description: GetStatusReportResponse is the response containing the status report with its full update timeline.\n openstatus.status_report.v1.ListStatusReportsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of reports to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of reports to skip for pagination (defaults to 0).\n statuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title: statuses\n description: Filter by status (optional). If empty, returns all statuses.\n title: ListStatusReportsRequest\n additionalProperties: false\n description: ListStatusReportsRequest is the request to list status reports.\n openstatus.status_report.v1.ListStatusReportsResponse:\n type: object\n properties:\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportSummary'\n title: status_reports\n description: List of status reports (metadata only, use GetStatusReport for full details).\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of reports matching the filter.\n title: ListStatusReportsResponse\n additionalProperties: false\n description: ListStatusReportsResponse is the response containing status report summaries.\n openstatus.status_report.v1.PageComponentImpact:\n type: string\n title: PageComponentImpact\n enum:\n - PAGE_COMPONENT_IMPACT_UNSPECIFIED\n - PAGE_COMPONENT_IMPACT_OPERATIONAL\n - PAGE_COMPONENT_IMPACT_DEGRADED_PERFORMANCE\n - PAGE_COMPONENT_IMPACT_PARTIAL_OUTAGE\n - PAGE_COMPONENT_IMPACT_MAJOR_OUTAGE\n description: |-\n PageComponentImpact is the per-component impact a status report update sets.\n UNSPECIFIED means the caller doesn't speak impact (legacy) — it is NOT operational.\n openstatus.status_report.v1.StatusReport:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status report.\n status:\n title: status\n description: Current status of the report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title:\n type: string\n title: title\n description: Title of the status report.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n updates:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportUpdate'\n title: updates\n description: Timeline of updates for this report (only included in GetStatusReport).\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the report was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the report was last updated (RFC 3339 format).\n title: StatusReport\n additionalProperties: false\n description: StatusReport represents an incident or maintenance report with full details.\n openstatus.status_report.v1.StatusReportStatus:\n type: string\n title: StatusReportStatus\n enum:\n - STATUS_REPORT_STATUS_UNSPECIFIED\n - STATUS_REPORT_STATUS_INVESTIGATING\n - STATUS_REPORT_STATUS_IDENTIFIED\n - STATUS_REPORT_STATUS_MONITORING\n - STATUS_REPORT_STATUS_RESOLVED\n description: StatusReportStatus represents the current state of a status report.\n openstatus.status_report.v1.StatusReportSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status report.\n status:\n title: status\n description: Current status of the report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title:\n type: string\n title: title\n description: Title of the status report.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the report was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the report was last updated (RFC 3339 format).\n title: StatusReportSummary\n additionalProperties: false\n description: StatusReportSummary represents metadata for a status report (used in list responses).\n openstatus.status_report.v1.StatusReportUpdate:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the update.\n status:\n title: status\n description: Status at the time of this update.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n date:\n type: string\n title: date\n description: Timestamp when this update occurred (RFC 3339 format).\n message:\n type: string\n title: message\n description: Message describing the update.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the update was created (RFC 3339 format).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: Per-component impacts this update set (empty for legacy reports).\n title: StatusReportUpdate\n additionalProperties: false\n description: StatusReportUpdate represents a single update entry in a status report timeline.\n openstatus.status_report.v1.UpdateStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n description: New title for the report (optional).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: New list of page component IDs (optional, replaces existing list).\n updatePageComponentIds:\n type:\n - boolean\n - \"null\"\n title: update_page_component_ids\n description: |-\n Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved.\n title: UpdateStatusReportRequest\n additionalProperties: false\n description: UpdateStatusReportRequest is the request to update a status report's metadata.\n openstatus.status_report.v1.UpdateStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The updated status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: UpdateStatusReportResponse\n additionalProperties: false\n description: UpdateStatusReportResponse is the response after updating a status report.\nsecurity:\n - ApiKeyAuth: []\ntags:\n - name: MonitorService\n description: |\n Create, update, delete, and query monitors. Supports HTTP, TCP, and DNS monitor types\n with configurable check intervals, regions, assertions, and alerting thresholds.\n - name: StatusPageService\n description: |\n Manage public status pages with components, component groups, and email subscribers.\n Includes endpoints for retrieving full page content and aggregated status.\n - name: NotificationService\n description: |\n Configure notification channels (Slack, Discord, PagerDuty, email, webhooks, etc.)\n and associate them with monitors. Supports 12 notification providers.\n - name: StatusReportService\n description: |\n Create and manage incident reports with status updates. Reports follow a lifecycle:\n investigating -> identified -> monitoring -> resolved.\n - name: MaintenanceService\n description: |\n Schedule maintenance windows for status page components. Subscribers can be\n notified automatically when maintenance is created.\n - name: HealthService\n description: Health check endpoint for load balancer probes. No authentication required.\n - name: PrivateLocationService\n description: |-\n PrivateLocationService provides CRUD operations for private locations —\n self-hosted checker agents that run monitors from your own network.\npaths:\n /rpc/openstatus.health.v1.HealthService/Check:\n get:\n tags:\n - HealthService\n summary: Check\n description: Check returns the current serving status of the service.\n operationId: HealthService_Check.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse'\n post:\n tags:\n - HealthService\n summary: Check\n description: Check returns the current serving status of the service.\n operationId: HealthService_Check\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: CreateMaintenance\n description: CreateMaintenance creates a new maintenance window.\n operationId: MaintenanceService_CreateMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: DeleteMaintenance\n description: DeleteMaintenance removes a maintenance window.\n operationId: MaintenanceService_DeleteMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance:\n get:\n tags:\n - MaintenanceService\n summary: GetMaintenance\n description: GetMaintenance retrieves a specific maintenance window by ID.\n operationId: MaintenanceService_GetMaintenance.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'\n post:\n tags:\n - MaintenanceService\n summary: GetMaintenance\n description: GetMaintenance retrieves a specific maintenance window by ID.\n operationId: MaintenanceService_GetMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/ListMaintenances:\n get:\n tags:\n - MaintenanceService\n summary: ListMaintenances\n description: ListMaintenances returns all maintenance windows for the workspace.\n operationId: MaintenanceService_ListMaintenances.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'\n post:\n tags:\n - MaintenanceService\n summary: ListMaintenances\n description: ListMaintenances returns all maintenance windows for the workspace.\n operationId: MaintenanceService_ListMaintenances\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: UpdateMaintenance\n description: UpdateMaintenance updates a maintenance window.\n operationId: MaintenanceService_UpdateMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateDNSMonitor\n description: CreateDNSMonitor creates a new DNS monitor.\n operationId: MonitorService_CreateDNSMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateGRPCMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateGRPCMonitor\n description: CreateGRPCMonitor creates a new gRPC health check monitor.\n operationId: MonitorService_CreateGRPCMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateHTTPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateHTTPMonitor\n description: Creates a new HTTP monitor in the authenticated workspace. Configure the target URL, HTTP method, request headers and body, response assertions (status code, body content, headers), check periodicity, geographic regions, and optional OpenTelemetry export. The monitor starts checking immediately if set to active.\n operationId: MonitorService_CreateHTTPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateICMPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateICMPMonitor\n description: CreateICMPMonitor creates a new ICMP monitor.\n operationId: MonitorService_CreateICMPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateTCPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateTCPMonitor\n description: CreateTCPMonitor creates a new TCP monitor.\n operationId: MonitorService_CreateTCPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/DeleteMonitor:\n post:\n tags:\n - MonitorService\n summary: DeleteMonitor\n description: DeleteMonitor removes a monitor.\n operationId: MonitorService_DeleteMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitor:\n get:\n tags:\n - MonitorService\n summary: GetMonitor\n description: |-\n GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.\n operationId: MonitorService_GetMonitor.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitor\n description: |-\n GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.\n operationId: MonitorService_GetMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorHTTPResponseLog:\n get:\n tags:\n - MonitorService\n summary: GetMonitorHTTPResponseLog\n description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.\n operationId: MonitorService_GetMonitorHTTPResponseLog.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorHTTPResponseLog\n description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.\n operationId: MonitorService_GetMonitorHTTPResponseLog\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorStatus:\n get:\n tags:\n - MonitorService\n summary: GetMonitorStatus\n description: GetMonitorStatus returns the current status of all regions for a monitor.\n operationId: MonitorService_GetMonitorStatus.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorStatus\n description: GetMonitorStatus returns the current status of all regions for a monitor.\n operationId: MonitorService_GetMonitorStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorSummary:\n get:\n tags:\n - MonitorService\n summary: GetMonitorSummary\n description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.\n operationId: MonitorService_GetMonitorSummary.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorSummary\n description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.\n operationId: MonitorService_GetMonitorSummary\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'\n /rpc/openstatus.monitor.v1.MonitorService/ListMonitorHTTPResponseLogs:\n get:\n tags:\n - MonitorService\n summary: ListMonitorHTTPResponseLogs\n description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.\n operationId: MonitorService_ListMonitorHTTPResponseLogs.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'\n post:\n tags:\n - MonitorService\n summary: ListMonitorHTTPResponseLogs\n description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.\n operationId: MonitorService_ListMonitorHTTPResponseLogs\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'\n /rpc/openstatus.monitor.v1.MonitorService/ListMonitors:\n get:\n tags:\n - MonitorService\n summary: ListMonitors\n description: ListMonitors returns a paginated list of all monitors in the workspace.\n operationId: MonitorService_ListMonitors.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'\n post:\n tags:\n - MonitorService\n summary: ListMonitors\n description: ListMonitors returns a paginated list of all monitors in the workspace.\n operationId: MonitorService_ListMonitors\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'\n /rpc/openstatus.monitor.v1.MonitorService/TriggerMonitor:\n post:\n tags:\n - MonitorService\n summary: TriggerMonitor\n description: Manually triggers an immediate check for the specified monitor across all configured regions. This operation is rate-limited under the synthetic-checks quota. A monitor run record is created and the check is dispatched to the checker service.\n operationId: MonitorService_TriggerMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateDNSMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateDNSMonitor\n description: UpdateDNSMonitor updates an existing DNS monitor.\n operationId: MonitorService_UpdateDNSMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateGRPCMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateGRPCMonitor\n description: UpdateGRPCMonitor updates an existing gRPC monitor.\n operationId: MonitorService_UpdateGRPCMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateHTTPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateHTTPMonitor\n description: UpdateHTTPMonitor updates an existing HTTP monitor.\n operationId: MonitorService_UpdateHTTPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateICMPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateICMPMonitor\n description: UpdateICMPMonitor updates an existing ICMP monitor.\n operationId: MonitorService_UpdateICMPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateTCPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateTCPMonitor\n description: UpdateTCPMonitor updates an existing TCP monitor.\n operationId: MonitorService_UpdateTCPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorResponse'\n /rpc/openstatus.notification.v1.NotificationService/CheckNotificationLimit:\n get:\n tags:\n - NotificationService\n summary: CheckNotificationLimit\n description: CheckNotificationLimit checks if the workspace has reached its notification limit.\n operationId: NotificationService_CheckNotificationLimit.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'\n post:\n tags:\n - NotificationService\n summary: CheckNotificationLimit\n description: CheckNotificationLimit checks if the workspace has reached its notification limit.\n operationId: NotificationService_CheckNotificationLimit\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'\n /rpc/openstatus.notification.v1.NotificationService/CreateNotification:\n post:\n tags:\n - NotificationService\n summary: CreateNotification\n description: CreateNotification creates a new notification channel.\n operationId: NotificationService_CreateNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/DeleteNotification:\n post:\n tags:\n - NotificationService\n summary: DeleteNotification\n description: DeleteNotification removes a notification channel.\n operationId: NotificationService_DeleteNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/GetNotification:\n get:\n tags:\n - NotificationService\n summary: GetNotification\n description: GetNotification retrieves a notification channel by ID.\n operationId: NotificationService_GetNotification.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'\n post:\n tags:\n - NotificationService\n summary: GetNotification\n description: GetNotification retrieves a notification channel by ID.\n operationId: NotificationService_GetNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/ListNotifications:\n get:\n tags:\n - NotificationService\n summary: ListNotifications\n description: ListNotifications returns a list of notification channels.\n operationId: NotificationService_ListNotifications.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'\n post:\n tags:\n - NotificationService\n summary: ListNotifications\n description: ListNotifications returns a list of notification channels.\n operationId: NotificationService_ListNotifications\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'\n /rpc/openstatus.notification.v1.NotificationService/SendTestNotification:\n post:\n tags:\n - NotificationService\n summary: SendTestNotification\n description: Sends a test notification to the specified provider to verify that the configuration is correct. This does not require an existing notification channel - just provide the provider type and its configuration data. Returns success status and an error message if the test failed.\n operationId: NotificationService_SendTestNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/UpdateNotification:\n post:\n tags:\n - NotificationService\n summary: UpdateNotification\n description: UpdateNotification updates an existing notification channel.\n operationId: NotificationService_UpdateNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/CreatePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: CreatePrivateLocation\n description: Creates a private location. The agent token is generated by the server and returned in the response - it cannot be supplied by the caller. Use the token to configure the agent so it can pull its monitors and report results.\n operationId: PrivateLocationService_CreatePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/DeletePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: DeletePrivateLocation\n description: DeletePrivateLocation removes a private location.\n operationId: PrivateLocationService_DeletePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/GetPrivateLocation:\n get:\n tags:\n - PrivateLocationService\n summary: GetPrivateLocation\n description: |-\n GetPrivateLocation retrieves a single private location by ID, including\n its agent token.\n operationId: PrivateLocationService_GetPrivateLocation.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'\n post:\n tags:\n - PrivateLocationService\n summary: GetPrivateLocation\n description: |-\n GetPrivateLocation retrieves a single private location by ID, including\n its agent token.\n operationId: PrivateLocationService_GetPrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/ListPrivateLocations:\n get:\n tags:\n - PrivateLocationService\n summary: ListPrivateLocations\n description: |-\n ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.\n operationId: PrivateLocationService_ListPrivateLocations.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'\n post:\n tags:\n - PrivateLocationService\n summary: ListPrivateLocations\n description: |-\n ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.\n operationId: PrivateLocationService_ListPrivateLocations\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/UpdatePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: UpdatePrivateLocation\n description: UpdatePrivateLocation updates a private location.\n operationId: PrivateLocationService_UpdatePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/AddMonitorComponent:\n post:\n tags:\n - StatusPageService\n summary: AddMonitorComponent\n description: AddMonitorComponent adds a monitor-based component to a status page.\n operationId: StatusPageService_AddMonitorComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/AddStaticComponent:\n post:\n tags:\n - StatusPageService\n summary: AddStaticComponent\n description: AddStaticComponent adds a static component to a status page.\n operationId: StatusPageService_AddStaticComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreateComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: CreateComponentGroup\n description: CreateComponentGroup creates a new component group.\n operationId: StatusPageService_CreateComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreatePageSubscription:\n post:\n tags:\n - StatusPageService\n summary: 'CreatePageSubscription: operator-added subscriber (email or webhook), no verification.'\n description: Operator-added subscriber (email or webhook) with no verification flow — the partner starts receiving notifications immediately. Supports Slack and Discord webhook URLs in addition to email. A management token is still generated so the subscriber can self-manage (update scope, unsubscribe) without operator involvement. Use this for vendor/partner integrations where consent is established out-of-band; use SubscribeToPage for subscriber-initiated signups that require double opt-in.\n operationId: StatusPageService_CreatePageSubscription\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreateStatusPage:\n post:\n tags:\n - StatusPageService\n summary: CreateStatusPage\n description: CreateStatusPage creates a new status page.\n operationId: StatusPageService_CreateStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/DeleteComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: DeleteComponentGroup\n description: DeleteComponentGroup removes a component group.\n operationId: StatusPageService_DeleteComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/DeleteStatusPage:\n post:\n tags:\n - StatusPageService\n summary: DeleteStatusPage\n description: DeleteStatusPage removes a status page.\n operationId: StatusPageService_DeleteStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetOverallStatus:\n get:\n tags:\n - StatusPageService\n summary: GetOverallStatus\n description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'\n operationId: StatusPageService_GetOverallStatus.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'\n post:\n tags:\n - StatusPageService\n summary: GetOverallStatus\n description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'\n operationId: StatusPageService_GetOverallStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetPageComponent:\n get:\n tags:\n - StatusPageService\n summary: GetPageComponent\n description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.\n operationId: StatusPageService_GetPageComponent.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'\n post:\n tags:\n - StatusPageService\n summary: GetPageComponent\n description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.\n operationId: StatusPageService_GetPageComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetPageComponentDailySummary:\n get:\n tags:\n - StatusPageService\n summary: GetPageComponentDailySummary\n description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetPageComponentDailySummary.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'\n post:\n tags:\n - StatusPageService\n summary: GetPageComponentDailySummary\n description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetPageComponentDailySummary\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPage:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPage\n description: GetStatusPage retrieves a specific status page by ID.\n operationId: StatusPageService_GetStatusPage.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPage\n description: GetStatusPage retrieves a specific status page by ID.\n operationId: StatusPageService_GetStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageContent:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPageContent\n description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetStatusPageContent.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPageContent\n description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetStatusPageContent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageOverview:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPageOverview\n description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'\n operationId: StatusPageService_GetStatusPageOverview.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPageOverview\n description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'\n operationId: StatusPageService_GetStatusPageOverview\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/ListStatusPages:\n get:\n tags:\n - StatusPageService\n summary: ListStatusPages\n description: ListStatusPages returns all status pages for the workspace.\n operationId: StatusPageService_ListStatusPages.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'\n post:\n tags:\n - StatusPageService\n summary: ListStatusPages\n description: ListStatusPages returns all status pages for the workspace.\n operationId: StatusPageService_ListStatusPages\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/ListSubscribers:\n get:\n tags:\n - StatusPageService\n summary: ListSubscribers\n description: ListSubscribers returns all subscribers for a status page.\n operationId: StatusPageService_ListSubscribers.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'\n post:\n tags:\n - StatusPageService\n summary: ListSubscribers\n description: ListSubscribers returns all subscribers for a status page.\n operationId: StatusPageService_ListSubscribers\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/RemoveComponent:\n post:\n tags:\n - StatusPageService\n summary: RemoveComponent\n description: RemoveComponent removes a component from a status page.\n operationId: StatusPageService_RemoveComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/SubscribeToPage:\n post:\n tags:\n - StatusPageService\n summary: 'SubscribeToPage: end-user email self-signup with double opt-in verification.'\n description: End-user email self-signup with double opt-in verification. A verification email is sent and the subscription activates only after the recipient confirms. If the email was previously unsubscribed, the existing row is reactivated instead of a duplicate being created. Use this for subscriber-initiated signups on the public status page; use CreatePageSubscription for operator-initiated (vendor) subscriptions that should skip verification.\n operationId: StatusPageService_SubscribeToPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UnsubscribeFromPage:\n post:\n tags:\n - StatusPageService\n summary: UnsubscribeFromPage\n description: UnsubscribeFromPage removes a subscription from a status page.\n operationId: StatusPageService_UnsubscribeFromPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateComponent:\n post:\n tags:\n - StatusPageService\n summary: UpdateComponent\n description: UpdateComponent updates an existing component.\n operationId: StatusPageService_UpdateComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: UpdateComponentGroup\n description: UpdateComponentGroup updates an existing component group.\n operationId: StatusPageService_UpdateComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateStatusPage:\n post:\n tags:\n - StatusPageService\n summary: UpdateStatusPage\n description: UpdateStatusPage updates an existing status page.\n operationId: StatusPageService_UpdateStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/AddStatusReportUpdate:\n post:\n tags:\n - StatusReportService\n summary: AddStatusReportUpdate\n description: 'Adds a new update entry to an existing status report and transitions the report to the specified status. Status reports follow a lifecycle: investigating -> identified -> monitoring -> resolved. If notify is true, subscribers of the associated page are notified by email about the update.'\n operationId: StatusReportService_AddStatusReportUpdate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/CreateStatusReport:\n post:\n tags:\n - StatusReportService\n summary: CreateStatusReport\n description: Creates a new status report with an initial update entry. The report is associated with a status page and optionally specific page components. An initial StatusReportUpdate is created automatically with the provided status, message, and date. If notify is true, subscribers of the associated page are notified by email.\n operationId: StatusReportService_CreateStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/DeleteStatusReport:\n post:\n tags:\n - StatusReportService\n summary: DeleteStatusReport\n description: DeleteStatusReport removes a status report and all its updates.\n operationId: StatusReportService_DeleteStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/GetStatusReport:\n get:\n tags:\n - StatusReportService\n summary: GetStatusReport\n description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).\n operationId: StatusReportService_GetStatusReport.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'\n post:\n tags:\n - StatusReportService\n summary: GetStatusReport\n description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).\n operationId: StatusReportService_GetStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/ListStatusReports:\n get:\n tags:\n - StatusReportService\n summary: ListStatusReports\n description: ListStatusReports returns all status reports for the workspace (metadata only).\n operationId: StatusReportService_ListStatusReports.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'\n post:\n tags:\n - StatusReportService\n summary: ListStatusReports\n description: ListStatusReports returns all status reports for the workspace (metadata only).\n operationId: StatusReportService_ListStatusReports\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/UpdateStatusReport:\n post:\n tags:\n - StatusReportService\n summary: UpdateStatusReport\n description: UpdateStatusReport updates the metadata of a status report (title, page components).\n operationId: StatusReportService_UpdateStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportResponse'\n";
+export default "openapi: 3.1.0\ninfo:\n description: OpenStatus is a open-source status page platform with global uptime monitoring. The OpenStatus API allows you to interact with the OpenStatus platform programmatically. To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings. Requests are rate limited per API key or token (600 per minute, 100 per 10 seconds); exceeding a limit returns HTTP 429 with a Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits.\n title: OpenStatus API\n version: v2.0.0\n contact:\n email: [email protected]\n url: https://www.openstatus.dev\nservers:\n - url: https://api.openstatus.dev\n description: Production\nexternalDocs:\n description: OpenStatus Documentation\n url: https://www.openstatus.dev/docs\ncomponents:\n responses:\n RateLimited:\n description: Rate limit exceeded (Connect code resource_exhausted). Retry after the number of seconds in the Retry-After header. See https://www.openstatus.dev/docs/reference/api-rate-limits.\n headers:\n Retry-After:\n description: Seconds to wait before retrying.\n schema:\n type: integer\n example: 7\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: x-openstatus-key\n schemas:\n connect.error:\n type: object\n properties:\n code:\n type: string\n examples:\n - not_found\n enum:\n - canceled\n - unknown\n - invalid_argument\n - deadline_exceeded\n - not_found\n - already_exists\n - permission_denied\n - resource_exhausted\n - failed_precondition\n - aborted\n - out_of_range\n - unimplemented\n - internal\n - unavailable\n - data_loss\n - unauthenticated\n description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].\n message:\n type: string\n description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.\n details:\n type: array\n items:\n $ref: '#/components/schemas/connect.error_details.Any'\n description: A list of messages that carry the error details. There is no limit on the number of messages.\n title: Connect Error\n additionalProperties: true\n description: 'Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation'\n connect.error_details.Any:\n type: object\n properties:\n type:\n type: string\n description: 'A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field.'\n value:\n type: string\n format: binary\n description: The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field.\n debug:\n oneOf:\n - type: object\n title: Any\n additionalProperties: true\n description: Detailed error information.\n discriminator:\n propertyName: type\n title: Debug\n description: Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic.\n additionalProperties: true\n description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.\n openstatus.health.v1.CheckRequest:\n type: object\n properties:\n service:\n type: string\n title: service\n description: Optional service name to check. If empty, checks overall service health.\n title: CheckRequest\n additionalProperties: false\n description: CheckRequest is the request message for health checks.\n openstatus.health.v1.CheckResponse:\n type: object\n properties:\n status:\n title: status\n description: The serving status of the service.\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse.ServingStatus'\n title: CheckResponse\n additionalProperties: false\n description: CheckResponse is the response message for health checks.\n openstatus.health.v1.CheckResponse.ServingStatus:\n type: string\n title: ServingStatus\n enum:\n - SERVING_STATUS_UNSPECIFIED\n - SERVING_STATUS_SERVING\n - SERVING_STATUS_NOT_SERVING\n description: ServingStatus represents the health status of the service.\n openstatus.maintenance.v1.AddMaintenanceUpdateRequest:\n type: object\n properties:\n maintenanceId:\n type: string\n title: maintenance_id\n minLength: 1\n description: ID of the maintenance to update (required).\n message:\n type: string\n title: message\n minLength: 1\n description: Public update message (required).\n date:\n type:\n - string\n - \"null\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Optional date for the update (RFC 3339 format). Defaults to current time.\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this update.\n title: AddMaintenanceUpdateRequest\n additionalProperties: false\n description: AddMaintenanceUpdateRequest is the request to append a maintenance update.\n openstatus.maintenance.v1.AddMaintenanceUpdateResponse:\n type: object\n properties:\n maintenanceUpdate:\n title: maintenance_update\n description: The created update.\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'\n title: AddMaintenanceUpdateResponse\n additionalProperties: false\n description: AddMaintenanceUpdateResponse is the response after appending an update.\n openstatus.maintenance.v1.CreateMaintenanceRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - Database Migration\n title: title\n maxLength: 256\n minLength: 1\n description: Title of the maintenance (required, 1-256 characters).\n message:\n type: string\n title: message\n minLength: 1\n description: |-\n Message describing the maintenance (required). Posted as the first\n maintenance update.\n from:\n type: string\n examples:\n - \"2024-03-01T02:00:00Z\"\n title: from\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Start time of the maintenance window (RFC 3339 format, required).\n to:\n type: string\n examples:\n - \"2024-03-01T06:00:00Z\"\n title: to\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: End time of the maintenance window (RFC 3339 format, required).\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: Page ID to associate with this maintenance (required).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: Page component IDs to associate with this maintenance (optional).\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this maintenance (optional, defaults to false).\n title: CreateMaintenanceRequest\n additionalProperties: false\n description: CreateMaintenanceRequest is the request to create a new maintenance window.\n openstatus.maintenance.v1.CreateMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The created maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: CreateMaintenanceResponse\n additionalProperties: false\n description: CreateMaintenanceResponse is the response after creating a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to delete (required).\n title: DeleteMaintenanceRequest\n additionalProperties: false\n description: DeleteMaintenanceRequest is the request to delete a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMaintenanceResponse\n additionalProperties: false\n description: DeleteMaintenanceResponse is the response after deleting a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the update to remove (required).\n title: DeleteMaintenanceUpdateRequest\n additionalProperties: false\n description: DeleteMaintenanceUpdateRequest is the request to remove an update.\n openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMaintenanceUpdateResponse\n additionalProperties: false\n description: DeleteMaintenanceUpdateResponse is the response after removing an update.\n openstatus.maintenance.v1.GetMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to retrieve (required).\n title: GetMaintenanceRequest\n additionalProperties: false\n description: GetMaintenanceRequest is the request to get a maintenance window by ID.\n openstatus.maintenance.v1.GetMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The requested maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: GetMaintenanceResponse\n additionalProperties: false\n description: GetMaintenanceResponse is the response containing the maintenance window.\n openstatus.maintenance.v1.ListMaintenancesRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of maintenances to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of maintenances to skip for pagination (defaults to 0).\n pageId:\n type:\n - string\n - \"null\"\n title: page_id\n description: Filter by page ID (optional).\n title: ListMaintenancesRequest\n additionalProperties: false\n description: ListMaintenancesRequest is the request to list maintenance windows.\n openstatus.maintenance.v1.ListMaintenancesResponse:\n type: object\n properties:\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: List of maintenances.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of maintenances matching the filter.\n title: ListMaintenancesResponse\n additionalProperties: false\n description: ListMaintenancesResponse is the response containing maintenance window summaries.\n openstatus.maintenance.v1.Maintenance:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the maintenance.\n title:\n type: string\n title: title\n description: Title of the maintenance.\n message:\n type: string\n title: message\n description: Message of the newest maintenance update.\n from:\n type: string\n title: from\n description: Start time of the maintenance window (RFC 3339 format).\n to:\n type: string\n title: to\n description: End time of the maintenance window (RFC 3339 format).\n pageId:\n type: string\n title: page_id\n description: ID of the page this maintenance is associated with.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the maintenance was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the maintenance was last updated (RFC 3339 format).\n updates:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'\n title: updates\n description: Full maintenance update timeline, newest first.\n title: Maintenance\n additionalProperties: false\n description: Maintenance represents a maintenance window with full details.\n openstatus.maintenance.v1.MaintenanceSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the maintenance.\n title:\n type: string\n title: title\n description: Title of the maintenance.\n message:\n type: string\n title: message\n description: Message of the newest maintenance update.\n from:\n type: string\n title: from\n description: Start time of the maintenance window (RFC 3339 format).\n to:\n type: string\n title: to\n description: End time of the maintenance window (RFC 3339 format).\n pageId:\n type: string\n title: page_id\n description: ID of the page this maintenance is associated with.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the maintenance was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the maintenance was last updated (RFC 3339 format).\n title: MaintenanceSummary\n additionalProperties: false\n description: MaintenanceSummary represents metadata for a maintenance window (used in list responses).\n openstatus.maintenance.v1.MaintenanceUpdate:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the update.\n message:\n type: string\n title: message\n description: Public update message.\n date:\n type: string\n title: date\n description: Date of the update (RFC 3339 format).\n maintenanceId:\n type: string\n title: maintenance_id\n description: ID of the maintenance this update belongs to.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the update was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the update was last updated (RFC 3339 format).\n title: MaintenanceUpdate\n additionalProperties: false\n description: MaintenanceUpdate represents a timeline entry for a maintenance window.\n openstatus.maintenance.v1.UpdateMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n maxLength: 256\n minLength: 1\n description: New title for the maintenance (optional).\n message:\n type:\n - string\n - \"null\"\n title: message\n description: Replaces the message of the newest maintenance update (optional).\n from:\n type:\n - string\n - \"null\"\n title: from\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New start time (RFC 3339 format, optional).\n to:\n type:\n - string\n - \"null\"\n title: to\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New end time (RFC 3339 format, optional).\n pageId:\n type:\n - string\n - \"null\"\n title: page_id\n description: 'Deprecated: page_id is now derived from page_component_ids.'\n deprecated: true\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: New list of page component IDs (optional, replaces existing list).\n updatePageComponentIds:\n type:\n - boolean\n - \"null\"\n title: update_page_component_ids\n description: |-\n Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved.\n title: UpdateMaintenanceRequest\n additionalProperties: false\n description: UpdateMaintenanceRequest is the request to update a maintenance window.\n openstatus.maintenance.v1.UpdateMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The updated maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: UpdateMaintenanceResponse\n additionalProperties: false\n description: UpdateMaintenanceResponse is the response after updating a maintenance window.\n openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the update to edit (required).\n message:\n type:\n - string\n - \"null\"\n title: message\n minLength: 1\n description: New public message.\n date:\n type:\n - string\n - \"null\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New update date (RFC 3339 format).\n title: UpdateMaintenanceUpdateRequest\n additionalProperties: false\n description: UpdateMaintenanceUpdateRequest is the request to edit an update.\n openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse:\n type: object\n properties:\n maintenanceUpdate:\n title: maintenance_update\n description: The updated timeline entry.\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'\n title: UpdateMaintenanceUpdateResponse\n additionalProperties: false\n description: UpdateMaintenanceUpdateResponse is the response after editing an update.\n openstatus.monitor.v1.BodyAssertion:\n type: object\n properties:\n target:\n type: string\n title: target\n description: Target value to compare against.\n comparator:\n not:\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'\n title: BodyAssertion\n additionalProperties: false\n description: BodyAssertion defines an assertion for response body content.\n openstatus.monitor.v1.CreateDNSMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: CreateDNSMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateDNSMonitorRequest is the request to create a new DNS monitor.\n openstatus.monitor.v1.CreateDNSMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: CreateDNSMonitorResponse\n additionalProperties: false\n description: CreateDNSMonitorResponse is the response after creating a DNS monitor.\n openstatus.monitor.v1.CreateGRPCMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: CreateGRPCMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateGRPCMonitorRequest is the request to create a new gRPC monitor.\n openstatus.monitor.v1.CreateGRPCMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: CreateGRPCMonitorResponse\n additionalProperties: false\n description: CreateGRPCMonitorResponse is the response after creating a gRPC monitor.\n openstatus.monitor.v1.CreateHTTPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: CreateHTTPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateHTTPMonitorRequest is the request to create a new HTTP monitor.\n openstatus.monitor.v1.CreateHTTPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: CreateHTTPMonitorResponse\n additionalProperties: false\n description: CreateHTTPMonitorResponse is the response after creating an HTTP monitor.\n openstatus.monitor.v1.CreateICMPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: CreateICMPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateICMPMonitorRequest is the request to create a new ICMP monitor.\n openstatus.monitor.v1.CreateICMPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: CreateICMPMonitorResponse\n additionalProperties: false\n description: CreateICMPMonitorResponse is the response after creating an ICMP monitor.\n openstatus.monitor.v1.CreateTCPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: CreateTCPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateTCPMonitorRequest is the request to create a new TCP monitor.\n openstatus.monitor.v1.CreateTCPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: CreateTCPMonitorResponse\n additionalProperties: false\n description: CreateTCPMonitorResponse is the response after creating a TCP monitor.\n openstatus.monitor.v1.DNSMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - DNS Resolution Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - example.com\n title: uri\n maxLength: 2048\n minLength: 1\n description: Domain to resolve (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n recordAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.RecordAssertion'\n title: record_assertions\n maxItems: 10\n description: DNS record assertions for validation.\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: DNSMonitor\n additionalProperties: false\n description: DNSMonitor defines the configuration for a DNS monitor.\n openstatus.monitor.v1.DeleteMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to delete (required).\n title: DeleteMonitorRequest\n additionalProperties: false\n description: DeleteMonitorRequest is the request to delete a monitor.\n openstatus.monitor.v1.DeleteMonitorResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMonitorResponse\n additionalProperties: false\n description: DeleteMonitorResponse is the response after deleting a monitor.\n openstatus.monitor.v1.GRPCMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Checkout gRPC\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - api.example.com:443\n title: uri\n maxLength: 2048\n minLength: 1\n pattern: ^(\\[[0-9a-fA-F:]+\\]|[^:/\\s]+):[0-9]{1,5}$\n description: Target in \"host:port\" form. IPv6 addresses must be bracketed.\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n service:\n type:\n - string\n - \"null\"\n examples:\n - checkout.v1.CheckoutService\n title: service\n maxLength: 512\n description: Service name passed to Health/Check. Empty means overall server health.\n tlsMode:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.GRPCTlsMode'\n - type: \"null\"\n title: tls_mode\n description: How the connection to the target is secured. Defaults to TLS.\n metadata:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: metadata\n maxItems: 20\n description: Metadata sent with the health check request.\n title: GRPCMonitor\n additionalProperties: false\n description: |-\n GRPCMonitor defines the configuration for a gRPC health check monitor.\n The probe calls grpc.health.v1.Health/Check on the target.\n openstatus.monitor.v1.GRPCTlsMode:\n type: string\n title: GRPCTlsMode\n enum:\n - GRPC_TLS_MODE_UNSPECIFIED\n - GRPC_TLS_MODE_TLS\n - GRPC_TLS_MODE_PLAINTEXT\n - GRPC_TLS_MODE_TLS_INSECURE\n description: GRPCTlsMode selects how the probe secures its connection to the target.\n openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get a response log for (required).\n logId:\n type: string\n title: log_id\n minLength: 1\n description: Response log ID to retrieve (required).\n title: GetMonitorHTTPResponseLogRequest\n additionalProperties: false\n description: GetMonitorHTTPResponseLogRequest is the request to get one response log.\n openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse:\n type: object\n properties:\n log:\n title: log\n description: Response log details.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogDetail'\n title: GetMonitorHTTPResponseLogResponse\n additionalProperties: false\n description: GetMonitorHTTPResponseLogResponse is the response containing one response log.\n openstatus.monitor.v1.GetMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to retrieve (required).\n title: GetMonitorRequest\n additionalProperties: false\n description: GetMonitorRequest is the request to get a single monitor by ID.\n openstatus.monitor.v1.GetMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The monitor configuration (one of HTTP, TCP, DNS, ICMP, or gRPC).\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorConfig'\n title: GetMonitorResponse\n additionalProperties: false\n description: GetMonitorResponse is the response containing the monitor.\n openstatus.monitor.v1.GetMonitorStatusRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get status for (required).\n title: GetMonitorStatusRequest\n additionalProperties: false\n description: GetMonitorStatusRequest is the request to get the status of all regions for a monitor.\n openstatus.monitor.v1.GetMonitorStatusResponse:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Monitor ID.\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.RegionStatus'\n title: regions\n description: Status for each region.\n title: GetMonitorStatusResponse\n additionalProperties: false\n description: GetMonitorStatusResponse is the response containing the status of all regions for a monitor.\n openstatus.monitor.v1.GetMonitorSummaryRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get summary for (required).\n timeRange:\n title: time_range\n description: Time range for metrics aggregation (defaults to 1 day if unspecified).\n $ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Optional filter by regions. If empty, returns metrics for all regions.\n title: GetMonitorSummaryRequest\n additionalProperties: false\n description: GetMonitorSummaryRequest is the request to get aggregated metrics for a monitor.\n openstatus.monitor.v1.GetMonitorSummaryResponse:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Monitor ID.\n lastPingAt:\n type: string\n title: last_ping_at\n description: Timestamp of the last check in RFC 3339 format.\n totalSuccessful:\n type:\n - integer\n - string\n title: total_successful\n format: int64\n description: Total number of successful requests.\n totalDegraded:\n type:\n - integer\n - string\n title: total_degraded\n format: int64\n description: Total number of degraded requests.\n totalFailed:\n type:\n - integer\n - string\n title: total_failed\n format: int64\n description: Total number of failed requests.\n p50:\n type:\n - integer\n - string\n title: p50\n format: int64\n description: 50th percentile (median) latency in milliseconds.\n p75:\n type:\n - integer\n - string\n title: p75\n format: int64\n description: 75th percentile latency in milliseconds.\n p90:\n type:\n - integer\n - string\n title: p90\n format: int64\n description: 90th percentile latency in milliseconds.\n p95:\n type:\n - integer\n - string\n title: p95\n format: int64\n description: 95th percentile latency in milliseconds.\n p99:\n type:\n - integer\n - string\n title: p99\n format: int64\n description: 99th percentile latency in milliseconds.\n timeRange:\n title: time_range\n description: Time range used for the metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n description: Regions included in the metrics.\n title: GetMonitorSummaryResponse\n additionalProperties: false\n description: GetMonitorSummaryResponse is the response containing aggregated metrics for a monitor.\n openstatus.monitor.v1.HTTPMethod:\n type: string\n title: HTTPMethod\n enum:\n - HTTP_METHOD_UNSPECIFIED\n - HTTP_METHOD_GET\n - HTTP_METHOD_POST\n - HTTP_METHOD_HEAD\n - HTTP_METHOD_PUT\n - HTTP_METHOD_PATCH\n - HTTP_METHOD_DELETE\n - HTTP_METHOD_TRACE\n - HTTP_METHOD_CONNECT\n - HTTP_METHOD_OPTIONS\n description: HTTP methods supported for monitors.\n openstatus.monitor.v1.HTTPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Production API Health Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n url:\n type: string\n examples:\n - https://api.example.com/health\n title: url\n maxLength: 2048\n minLength: 1\n format: uri\n description: URL to monitor (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n method:\n not:\n enum:\n - HTTP_METHOD_UNSPECIFIED\n title: method\n description: HTTP method to use (defaults to GET).\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMethod'\n body:\n type: string\n examples:\n - map[key:value]\n title: body\n description: Request body (optional).\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n followRedirects:\n type:\n - boolean\n - \"null\"\n title: follow_redirects\n description: Whether to follow HTTP redirects (defaults to true when not specified).\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: headers\n maxItems: 20\n description: Custom headers for the request.\n statusCodeAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.StatusCodeAssertion'\n title: status_code_assertions\n maxItems: 10\n description: Status code assertions for the response.\n bodyAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.BodyAssertion'\n title: body_assertions\n maxItems: 10\n description: Body content assertions for the response.\n headerAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HeaderAssertion'\n title: header_assertions\n maxItems: 10\n description: Header assertions for the response.\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: HTTPMonitor\n additionalProperties: false\n description: HTTPMonitor defines the configuration for an HTTP monitor.\n openstatus.monitor.v1.HTTPResponseLogDetail:\n type: object\n properties:\n log:\n title: log\n description: Compact response log fields.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'\n url:\n type: string\n title: url\n description: Checked URL.\n error:\n type: boolean\n title: error\n description: Whether the check errored.\n message:\n type:\n - string\n - \"null\"\n title: message\n description: Error message, when present.\n headers:\n type: object\n title: headers\n additionalProperties:\n type: string\n title: value\n description: Redacted response headers.\n assertions:\n type:\n - string\n - \"null\"\n title: assertions\n description: Serialized assertions used for the check.\n title: HTTPResponseLogDetail\n additionalProperties: false\n description: HTTPResponseLogDetail contains full response log debugging data.\n openstatus.monitor.v1.HTTPResponseLogDetail.HeadersEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: HeadersEntry\n additionalProperties: false\n openstatus.monitor.v1.HTTPResponseLogListItem:\n type: object\n properties:\n id:\n type:\n - string\n - \"null\"\n title: id\n description: Response log ID.\n latency:\n type: integer\n title: latency\n format: int32\n description: Latency in milliseconds.\n statusCode:\n type:\n - integer\n - \"null\"\n title: status_code\n format: int32\n description: HTTP status code.\n monitorId:\n type: string\n title: monitor_id\n description: Monitor ID.\n requestStatus:\n title: request_status\n description: Request status classification.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogRequestStatus'\n region:\n title: region\n description: Region where the check ran.\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n cronTimestamp:\n type:\n - integer\n - string\n title: cron_timestamp\n format: int64\n description: Cron bucket timestamp in Unix milliseconds.\n trigger:\n title: trigger\n description: Check trigger.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTrigger'\n timestamp:\n type:\n - integer\n - string\n title: timestamp\n format: int64\n description: Response timestamp in Unix milliseconds.\n timing:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTiming'\n - type: \"null\"\n title: timing\n description: Timing phases.\n title: HTTPResponseLogListItem\n additionalProperties: false\n description: HTTPResponseLogListItem is a compact response log entry.\n openstatus.monitor.v1.HTTPResponseLogPagination:\n type: object\n properties:\n limit:\n type: integer\n title: limit\n format: int32\n description: Requested page size.\n offset:\n type: integer\n title: offset\n format: int32\n description: Requested offset.\n hasMore:\n type: boolean\n title: has_more\n description: Whether more logs are available.\n nextOffset:\n type:\n - integer\n - \"null\"\n title: next_offset\n format: int32\n description: Next offset if more logs are available.\n title: HTTPResponseLogPagination\n additionalProperties: false\n description: HTTPResponseLogPagination contains offset pagination metadata.\n openstatus.monitor.v1.HTTPResponseLogRequestStatus:\n type: string\n title: HTTPResponseLogRequestStatus\n enum:\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_UNSPECIFIED\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_SUCCESS\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_ERROR\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_DEGRADED\n description: HTTPResponseLogRequestStatus is the result classification for an HTTP response log.\n openstatus.monitor.v1.HTTPResponseLogTiming:\n type: object\n properties:\n dns:\n type: integer\n title: dns\n format: int32\n description: DNS lookup duration.\n connect:\n type: integer\n title: connect\n format: int32\n description: TCP connection duration.\n tls:\n type: integer\n title: tls\n format: int32\n description: TLS handshake duration.\n ttfb:\n type: integer\n title: ttfb\n format: int32\n description: Time to first byte duration.\n transfer:\n type: integer\n title: transfer\n format: int32\n description: Response transfer duration.\n title: HTTPResponseLogTiming\n additionalProperties: false\n description: HTTPResponseLogTiming contains calculated timing phases in milliseconds.\n openstatus.monitor.v1.HTTPResponseLogTrigger:\n type: string\n title: HTTPResponseLogTrigger\n enum:\n - HTTP_RESPONSE_LOG_TRIGGER_UNSPECIFIED\n - HTTP_RESPONSE_LOG_TRIGGER_CRON\n - HTTP_RESPONSE_LOG_TRIGGER_API\n description: HTTPResponseLogTrigger describes what started the monitor check.\n openstatus.monitor.v1.HeaderAssertion:\n type: object\n properties:\n target:\n type: string\n title: target\n description: Target value to compare against.\n comparator:\n not:\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'\n key:\n type: string\n title: key\n minLength: 1\n description: Header key to check (required).\n title: HeaderAssertion\n additionalProperties: false\n description: HeaderAssertion defines an assertion for response headers.\n openstatus.monitor.v1.Headers:\n type: object\n properties:\n key:\n type: string\n examples:\n - Authorization\n title: key\n minLength: 1\n description: Header name.\n value:\n type: string\n examples:\n - Bearer token123\n title: value\n description: Header value.\n title: Headers\n additionalProperties: false\n description: Headers represents a key-value pair for HTTP headers.\n openstatus.monitor.v1.ICMPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Ping Gateway\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - 1.1.1.1\n title: uri\n maxLength: 2048\n minLength: 1\n description: URI to monitor in format \"host or IP\" (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: ICMPMonitor\n additionalProperties: false\n description: ICMPMonitor defines the configuration for a ICMP monitor.\n openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to list response logs for (required).\n fromTimestamp:\n type:\n - integer\n - string\n - \"null\"\n title: from_timestamp\n format: int64\n description: Start of the response log window as Unix milliseconds within the 14-day retention window.\n toTimestamp:\n type:\n - integer\n - string\n - \"null\"\n title: to_timestamp\n format: int64\n description: End of the response log window as Unix milliseconds within the 14-day retention window.\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of logs to return (1-100, defaults to 25).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of logs to skip for pagination (defaults to 0).\n title: ListMonitorHTTPResponseLogsRequest\n additionalProperties: false\n description: ListMonitorHTTPResponseLogsRequest is the request to list response logs within the 14-day HTTP response-log window.\n openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse:\n type: object\n properties:\n logs:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'\n title: logs\n description: Response logs.\n pagination:\n title: pagination\n description: Pagination metadata.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogPagination'\n title: ListMonitorHTTPResponseLogsResponse\n additionalProperties: false\n description: ListMonitorHTTPResponseLogsResponse is the response containing response logs.\n openstatus.monitor.v1.ListMonitorsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of monitors to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of monitors to skip for pagination (defaults to 0).\n title: ListMonitorsRequest\n additionalProperties: false\n description: ListMonitorsRequest is the request to list monitors.\n openstatus.monitor.v1.ListMonitorsResponse:\n type: object\n properties:\n httpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: http_monitors\n description: HTTP monitors in the workspace.\n tcpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: tcp_monitors\n description: TCP monitors in the workspace.\n dnsMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: dns_monitors\n description: DNS monitors in the workspace.\n icmpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: icmp_monitors\n description: ICMP monitors in the workspace.\n grpcMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: grpc_monitors\n description: gRPC monitors in the workspace.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of monitors across all types.\n title: ListMonitorsResponse\n additionalProperties: false\n description: ListMonitorsResponse is the response containing a list of monitors.\n openstatus.monitor.v1.MonitorConfig:\n type: object\n oneOf:\n - type: object\n properties:\n dns:\n title: dns\n description: DNS monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: dns\n required:\n - dns\n - type: object\n properties:\n grpc:\n title: grpc\n description: gRPC monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: grpc\n required:\n - grpc\n - type: object\n properties:\n http:\n title: http\n description: HTTP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: http\n required:\n - http\n - type: object\n properties:\n icmp:\n title: icmp\n description: ICMP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: icmp\n required:\n - icmp\n - type: object\n properties:\n tcp:\n title: tcp\n description: TCP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: tcp\n required:\n - tcp\n title: MonitorConfig\n additionalProperties: false\n description: MonitorConfig represents the type-specific configuration for a monitor.\n openstatus.monitor.v1.MonitorStatus:\n type: string\n title: MonitorStatus\n enum:\n - MONITOR_STATUS_UNSPECIFIED\n - MONITOR_STATUS_ACTIVE\n - MONITOR_STATUS_DEGRADED\n - MONITOR_STATUS_ERROR\n description: MonitorStatus represents the operational status of a monitor.\n openstatus.monitor.v1.NumberComparator:\n type: string\n title: NumberComparator\n enum:\n - NUMBER_COMPARATOR_UNSPECIFIED\n - NUMBER_COMPARATOR_EQUAL\n - NUMBER_COMPARATOR_NOT_EQUAL\n - NUMBER_COMPARATOR_GREATER_THAN\n - NUMBER_COMPARATOR_GREATER_THAN_OR_EQUAL\n - NUMBER_COMPARATOR_LESS_THAN\n - NUMBER_COMPARATOR_LESS_THAN_OR_EQUAL\n description: NumberComparator defines comparison operations for numeric values.\n openstatus.monitor.v1.OpenTelemetryConfig:\n type: object\n properties:\n endpoint:\n type: string\n title: endpoint\n maxLength: 2048\n description: OTEL endpoint URL.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: headers\n maxItems: 20\n description: Custom headers for OTEL requests.\n title: OpenTelemetryConfig\n additionalProperties: false\n description: OpenTelemetry configuration for exporting metrics.\n openstatus.monitor.v1.Periodicity:\n type: string\n title: Periodicity\n enum:\n - PERIODICITY_UNSPECIFIED\n - PERIODICITY_30S\n - PERIODICITY_1M\n - PERIODICITY_5M\n - PERIODICITY_10M\n - PERIODICITY_30M\n - PERIODICITY_1H\n description: Monitor periodicity options.\n openstatus.monitor.v1.RecordAssertion:\n type: object\n properties:\n record:\n type: string\n title: record\n enum:\n - A\n - AAAA\n - CNAME\n - MX\n - TXT\n description: DNS record type (e.g., \"A\", \"AAAA\", \"CNAME\", \"MX\", \"TXT\").\n comparator:\n not:\n enum:\n - RECORD_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.RecordComparator'\n target:\n type: string\n title: target\n description: Target value to compare against.\n title: RecordAssertion\n additionalProperties: false\n description: RecordAssertion defines an assertion for DNS records.\n openstatus.monitor.v1.RecordComparator:\n type: string\n title: RecordComparator\n enum:\n - RECORD_COMPARATOR_UNSPECIFIED\n - RECORD_COMPARATOR_EQUAL\n - RECORD_COMPARATOR_NOT_EQUAL\n - RECORD_COMPARATOR_CONTAINS\n - RECORD_COMPARATOR_NOT_CONTAINS\n description: RecordComparator defines comparison operations for DNS records.\n openstatus.monitor.v1.Region:\n type: string\n title: Region\n enum:\n - REGION_UNSPECIFIED\n - REGION_FLY_AMS\n - REGION_FLY_ARN\n - REGION_FLY_BOM\n - REGION_FLY_CDG\n - REGION_FLY_DFW\n - REGION_FLY_EWR\n - REGION_FLY_FRA\n - REGION_FLY_GRU\n - REGION_FLY_IAD\n - REGION_FLY_JNB\n - REGION_FLY_LAX\n - REGION_FLY_LHR\n - REGION_FLY_NRT\n - REGION_FLY_ORD\n - REGION_FLY_SJC\n - REGION_FLY_SIN\n - REGION_FLY_SYD\n - REGION_FLY_YYZ\n - REGION_KOYEB_FRA\n - REGION_KOYEB_PAR\n - REGION_KOYEB_SFO\n - REGION_KOYEB_SIN\n - REGION_KOYEB_TYO\n - REGION_KOYEB_WAS\n - REGION_RAILWAY_US_WEST2\n - REGION_RAILWAY_US_EAST4\n - REGION_RAILWAY_EUROPE_WEST4\n - REGION_RAILWAY_ASIA_SOUTHEAST1\n description: |-\n Geographic regions where monitors can run checks from.\n REGION_FLY_BOM is deprecated and rejected on create/update; use REGION_FLY_SIN.\n openstatus.monitor.v1.RegionStatus:\n type: object\n properties:\n region:\n title: region\n description: The region identifier.\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n status:\n title: status\n description: The status of the monitor in this region.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n title: RegionStatus\n additionalProperties: false\n description: RegionStatus represents the status of a monitor in a specific region.\n openstatus.monitor.v1.StatusCodeAssertion:\n type: object\n properties:\n target:\n type:\n - integer\n - string\n title: target\n maximum: 599\n minimum: 100\n format: int64\n description: Target status code to compare against (100-599).\n comparator:\n not:\n enum:\n - NUMBER_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.NumberComparator'\n title: StatusCodeAssertion\n additionalProperties: false\n description: StatusCodeAssertion defines an assertion for HTTP status codes.\n openstatus.monitor.v1.StringComparator:\n type: string\n title: StringComparator\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n - STRING_COMPARATOR_CONTAINS\n - STRING_COMPARATOR_NOT_CONTAINS\n - STRING_COMPARATOR_EQUAL\n - STRING_COMPARATOR_NOT_EQUAL\n - STRING_COMPARATOR_EMPTY\n - STRING_COMPARATOR_NOT_EMPTY\n - STRING_COMPARATOR_GREATER_THAN\n - STRING_COMPARATOR_GREATER_THAN_OR_EQUAL\n - STRING_COMPARATOR_LESS_THAN\n - STRING_COMPARATOR_LESS_THAN_OR_EQUAL\n description: StringComparator defines comparison operations for string values.\n openstatus.monitor.v1.TCPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Database Connection Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - tcp://db.example.com:5432\n title: uri\n maxLength: 2048\n minLength: 1\n description: URI to monitor in format \"host:port\" (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: TCPMonitor\n additionalProperties: false\n description: TCPMonitor defines the configuration for a TCP monitor.\n openstatus.monitor.v1.TimeRange:\n type: string\n title: TimeRange\n enum:\n - TIME_RANGE_UNSPECIFIED\n - TIME_RANGE_1D\n - TIME_RANGE_7D\n - TIME_RANGE_14D\n description: TimeRange represents the time period for metrics aggregation.\n openstatus.monitor.v1.TriggerMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to trigger (required).\n title: TriggerMonitorRequest\n additionalProperties: false\n description: TriggerMonitorRequest is the request to trigger a monitor check.\n openstatus.monitor.v1.TriggerMonitorResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the trigger was successful.\n title: TriggerMonitorResponse\n additionalProperties: false\n description: TriggerMonitorResponse is the response after triggering a monitor.\n openstatus.monitor.v1.UpdateDNSMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateDNSMonitorRequest\n additionalProperties: false\n description: UpdateDNSMonitorRequest is the request to update an existing DNS monitor.\n openstatus.monitor.v1.UpdateDNSMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: UpdateDNSMonitorResponse\n additionalProperties: false\n description: UpdateDNSMonitorResponse is the response after updating a DNS monitor.\n openstatus.monitor.v1.UpdateGRPCMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateGRPCMonitorRequest\n additionalProperties: false\n description: UpdateGRPCMonitorRequest is the request to update an existing gRPC monitor.\n openstatus.monitor.v1.UpdateGRPCMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: UpdateGRPCMonitorResponse\n additionalProperties: false\n description: UpdateGRPCMonitorResponse is the response after updating a gRPC monitor.\n openstatus.monitor.v1.UpdateHTTPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateHTTPMonitorRequest\n additionalProperties: false\n description: UpdateHTTPMonitorRequest is the request to update an existing HTTP monitor.\n openstatus.monitor.v1.UpdateHTTPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: UpdateHTTPMonitorResponse\n additionalProperties: false\n description: UpdateHTTPMonitorResponse is the response after updating an HTTP monitor.\n openstatus.monitor.v1.UpdateICMPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateICMPMonitorRequest\n additionalProperties: false\n description: UpdateICMPMonitorRequest is the request to update an existing ICMP monitor.\n openstatus.monitor.v1.UpdateICMPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: UpdateICMPMonitorResponse\n additionalProperties: false\n description: UpdateICMPMonitorResponse is the response after updating an ICMP monitor.\n openstatus.monitor.v1.UpdateTCPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateTCPMonitorRequest\n additionalProperties: false\n description: UpdateTCPMonitorRequest is the request to update an existing TCP monitor.\n openstatus.monitor.v1.UpdateTCPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: UpdateTCPMonitorResponse\n additionalProperties: false\n description: UpdateTCPMonitorResponse is the response after updating a TCP monitor.\n openstatus.notification.v1.CheckNotificationLimitRequest:\n type: object\n title: CheckNotificationLimitRequest\n additionalProperties: false\n description: CheckNotificationLimitRequest is the request to check notification limits.\n openstatus.notification.v1.CheckNotificationLimitResponse:\n type: object\n properties:\n limitReached:\n type: boolean\n title: limit_reached\n description: Whether the workspace has reached its notification limit.\n currentCount:\n type: integer\n title: current_count\n format: int32\n description: Current number of notification channels.\n maxCount:\n type: integer\n title: max_count\n format: int32\n description: Maximum allowed notification channels.\n title: CheckNotificationLimitResponse\n additionalProperties: false\n description: CheckNotificationLimitResponse is the response containing limit information.\n openstatus.notification.v1.CreateNotificationRequest:\n type: object\n properties:\n name:\n type: string\n examples:\n - Slack Ops Channel\n title: name\n minLength: 1\n description: Display name for the notification channel.\n provider:\n not:\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors to associate with this notification.\n title: CreateNotificationRequest\n required:\n - data\n additionalProperties: false\n description: CreateNotificationRequest is the request to create a new notification channel.\n openstatus.notification.v1.CreateNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The created notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: CreateNotificationResponse\n additionalProperties: false\n description: CreateNotificationResponse is the response after creating a notification channel.\n openstatus.notification.v1.DeleteNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to delete (required).\n title: DeleteNotificationRequest\n additionalProperties: false\n description: DeleteNotificationRequest is the request to delete a notification channel.\n openstatus.notification.v1.DeleteNotificationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteNotificationResponse\n additionalProperties: false\n description: DeleteNotificationResponse is the response after deleting a notification channel.\n openstatus.notification.v1.DiscordData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://discord.com/api/webhooks/123/abc\n title: webhook_url\n format: uri\n description: Discord webhook URL.\n title: DiscordData\n additionalProperties: false\n description: DiscordData contains configuration for Discord notifications.\n openstatus.notification.v1.EmailData:\n type: object\n properties:\n email:\n type: string\n examples:\n - [email protected]\n title: email\n format: email\n description: Email address to send notifications to.\n title: EmailData\n additionalProperties: false\n description: EmailData contains configuration for email notifications.\n openstatus.notification.v1.GetNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to retrieve (required).\n title: GetNotificationRequest\n additionalProperties: false\n description: GetNotificationRequest is the request to get a notification channel.\n openstatus.notification.v1.GetNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: GetNotificationResponse\n additionalProperties: false\n description: GetNotificationResponse is the response containing the notification channel.\n openstatus.notification.v1.GoogleChatData:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n format: uri\n description: Google Chat webhook URL.\n title: GoogleChatData\n additionalProperties: false\n description: GoogleChatData contains configuration for Google Chat notifications.\n openstatus.notification.v1.GrafanaOncallData:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n format: uri\n description: Grafana OnCall webhook URL.\n title: GrafanaOncallData\n additionalProperties: false\n description: GrafanaOncallData contains configuration for Grafana OnCall notifications.\n openstatus.notification.v1.ListNotificationsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of notifications to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of notifications to skip for pagination (defaults to 0).\n title: ListNotificationsRequest\n additionalProperties: false\n description: ListNotificationsRequest is the request to list notification channels.\n openstatus.notification.v1.ListNotificationsResponse:\n type: object\n properties:\n notifications:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationSummary'\n title: notifications\n description: Notification channel summaries.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of notification channels.\n title: ListNotificationsResponse\n additionalProperties: false\n description: ListNotificationsResponse is the response containing notification channels.\n openstatus.notification.v1.MsTeamsData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://prod-00.westeurope.logic.azure.com:443/workflows/abc/triggers/manual/paths/invoke\n title: webhook_url\n format: uri\n description: Microsoft Teams webhook URL (Power Automate Workflows).\n title: MsTeamsData\n additionalProperties: false\n description: MsTeamsData contains configuration for Microsoft Teams notifications.\n openstatus.notification.v1.Notification:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the notification.\n name:\n type: string\n title: name\n description: Display name for the notification channel.\n provider:\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors associated with this notification.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the notification was created (RFC 3339).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the notification was last updated (RFC 3339).\n title: Notification\n additionalProperties: false\n description: Notification represents a notification channel with full details.\n openstatus.notification.v1.NotificationData:\n type: object\n oneOf:\n - type: object\n properties:\n discord:\n title: discord\n description: Discord configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.DiscordData'\n title: discord\n required:\n - discord\n - type: object\n properties:\n email:\n title: email\n description: Email configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.EmailData'\n title: email\n required:\n - email\n - type: object\n properties:\n googleChat:\n title: google_chat\n description: Google Chat configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.GoogleChatData'\n title: google_chat\n required:\n - googleChat\n - type: object\n properties:\n grafanaOncall:\n title: grafana_oncall\n description: Grafana OnCall configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.GrafanaOncallData'\n title: grafana_oncall\n required:\n - grafanaOncall\n - type: object\n properties:\n msTeams:\n title: ms_teams\n description: Microsoft Teams configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.MsTeamsData'\n title: ms_teams\n required:\n - msTeams\n - type: object\n properties:\n ntfy:\n title: ntfy\n description: Ntfy configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NtfyData'\n title: ntfy\n required:\n - ntfy\n - type: object\n properties:\n opsgenie:\n title: opsgenie\n description: Opsgenie configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.OpsgenieData'\n title: opsgenie\n required:\n - opsgenie\n - type: object\n properties:\n pagerduty:\n title: pagerduty\n description: PagerDuty configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.PagerDutyData'\n title: pagerduty\n required:\n - pagerduty\n - type: object\n properties:\n slack:\n title: slack\n description: Slack configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.SlackData'\n title: slack\n required:\n - slack\n - type: object\n properties:\n sms:\n title: sms\n description: 'Deprecated: SMS is no longer offered; use whatsapp.'\n deprecated: true\n $ref: '#/components/schemas/openstatus.notification.v1.SmsData'\n title: sms\n required:\n - sms\n - type: object\n properties:\n telegram:\n title: telegram\n description: Telegram configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.TelegramData'\n title: telegram\n required:\n - telegram\n - type: object\n properties:\n webhook:\n title: webhook\n description: Webhook configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.WebhookData'\n title: webhook\n required:\n - webhook\n - type: object\n properties:\n whatsapp:\n title: whatsapp\n description: WhatsApp configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.WhatsappData'\n title: whatsapp\n required:\n - whatsapp\n title: NotificationData\n additionalProperties: false\n description: NotificationData is a union of provider-specific configuration.\n openstatus.notification.v1.NotificationProvider:\n type: string\n title: NotificationProvider\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n - NOTIFICATION_PROVIDER_DISCORD\n - NOTIFICATION_PROVIDER_EMAIL\n - NOTIFICATION_PROVIDER_GOOGLE_CHAT\n - NOTIFICATION_PROVIDER_GRAFANA_ONCALL\n - NOTIFICATION_PROVIDER_NTFY\n - NOTIFICATION_PROVIDER_PAGERDUTY\n - NOTIFICATION_PROVIDER_OPSGENIE\n - NOTIFICATION_PROVIDER_SLACK\n - NOTIFICATION_PROVIDER_SMS\n - NOTIFICATION_PROVIDER_TELEGRAM\n - NOTIFICATION_PROVIDER_WEBHOOK\n - NOTIFICATION_PROVIDER_WHATSAPP\n - NOTIFICATION_PROVIDER_MS_TEAMS\n description: NotificationProvider represents the supported notification channel types.\n openstatus.notification.v1.NotificationSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the notification.\n name:\n type: string\n title: name\n description: Display name for the notification channel.\n provider:\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n monitorCount:\n type: integer\n title: monitor_count\n format: int32\n description: Number of monitors associated with this notification.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the notification was created (RFC 3339).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the notification was last updated (RFC 3339).\n title: NotificationSummary\n additionalProperties: false\n description: NotificationSummary represents a notification channel summary for list responses.\n openstatus.notification.v1.NtfyData:\n type: object\n properties:\n topic:\n type: string\n examples:\n - openstatus-alerts\n title: topic\n minLength: 1\n description: Ntfy topic to publish to.\n serverUrl:\n type: string\n title: server_url\n description: Ntfy server URL (defaults to https://ntfy.sh).\n token:\n type:\n - string\n - \"null\"\n title: token\n description: Optional authentication token.\n title: NtfyData\n additionalProperties: false\n description: NtfyData contains configuration for Ntfy notifications.\n openstatus.notification.v1.OpsgenieData:\n type: object\n properties:\n apiKey:\n type: string\n title: api_key\n minLength: 1\n description: Opsgenie API key.\n region:\n title: region\n description: Opsgenie region.\n $ref: '#/components/schemas/openstatus.notification.v1.OpsgenieRegion'\n title: OpsgenieData\n additionalProperties: false\n description: OpsgenieData contains configuration for Opsgenie notifications.\n openstatus.notification.v1.OpsgenieRegion:\n type: string\n title: OpsgenieRegion\n enum:\n - OPSGENIE_REGION_UNSPECIFIED\n - OPSGENIE_REGION_US\n - OPSGENIE_REGION_EU\n description: OpsgenieRegion represents the Opsgenie API region.\n openstatus.notification.v1.PagerDutyData:\n type: object\n properties:\n integrationKey:\n type: string\n examples:\n - a1b2c3d4e5f6g7h8i9j0\n title: integration_key\n minLength: 1\n description: PagerDuty integration key.\n title: PagerDutyData\n additionalProperties: false\n description: PagerDutyData contains configuration for PagerDuty notifications.\n openstatus.notification.v1.SendTestNotificationRequest:\n type: object\n properties:\n provider:\n not:\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n title: SendTestNotificationRequest\n required:\n - data\n additionalProperties: false\n description: SendTestNotificationRequest is the request to send a test notification.\n openstatus.notification.v1.SendTestNotificationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the test was successful.\n errorMessage:\n type:\n - string\n - \"null\"\n title: error_message\n description: Optional error message if the test failed.\n title: SendTestNotificationResponse\n additionalProperties: false\n description: SendTestNotificationResponse is the response after sending a test notification.\n openstatus.notification.v1.SlackData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://hooks.slack.com/services/T00/B00/xxx\n title: webhook_url\n format: uri\n description: Slack webhook URL.\n title: SlackData\n additionalProperties: false\n description: SlackData contains configuration for Slack notifications.\n openstatus.notification.v1.SmsData:\n type: object\n properties:\n phoneNumber:\n type: string\n examples:\n - \"+14155551234\"\n title: phone_number\n minLength: 1\n description: Phone number to send SMS to.\n title: SmsData\n additionalProperties: false\n description: 'Deprecated: SMS is no longer offered; use WhatsappData. Kept for existing channels.'\n deprecated: true\n openstatus.notification.v1.TelegramData:\n type: object\n properties:\n chatId:\n type: string\n examples:\n - \"-1001234567890\"\n title: chat_id\n minLength: 1\n description: Telegram chat ID.\n title: TelegramData\n additionalProperties: false\n description: TelegramData contains configuration for Telegram notifications.\n openstatus.notification.v1.UpdateNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n description: Updated display name.\n data:\n oneOf:\n - $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n - type: \"null\"\n title: data\n description: Updated provider-specific configuration.\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: Updated monitor IDs to associate.\n updateMonitorIds:\n type:\n - boolean\n - \"null\"\n title: update_monitor_ids\n description: |-\n Set to true to update monitor associations.\n When true, monitor_ids replaces the existing list (empty clears all).\n When false or unset, monitor_ids is ignored and existing associations are preserved.\n title: UpdateNotificationRequest\n additionalProperties: false\n description: UpdateNotificationRequest is the request to update a notification channel.\n openstatus.notification.v1.UpdateNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The updated notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: UpdateNotificationResponse\n additionalProperties: false\n description: UpdateNotificationResponse is the response after updating a notification channel.\n openstatus.notification.v1.WebhookData:\n type: object\n properties:\n endpoint:\n type: string\n examples:\n - https://api.example.com/webhooks/openstatus\n title: endpoint\n format: uri\n description: Webhook endpoint URL.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.notification.v1.WebhookHeader'\n title: headers\n description: Optional custom headers.\n title: WebhookData\n additionalProperties: false\n description: WebhookData contains configuration for custom webhook notifications.\n openstatus.notification.v1.WebhookHeader:\n type: object\n properties:\n key:\n type: string\n title: key\n minLength: 1\n description: Header name.\n value:\n type: string\n title: value\n description: Header value.\n title: WebhookHeader\n additionalProperties: false\n description: WebhookHeader represents a custom header for webhook requests.\n openstatus.notification.v1.WhatsappData:\n type: object\n properties:\n phoneNumber:\n type: string\n title: phone_number\n minLength: 1\n description: Phone number to send WhatsApp messages to.\n title: WhatsappData\n additionalProperties: false\n description: WhatsappData contains configuration for WhatsApp notifications.\n openstatus.private_location.v1.CreatePrivateLocationRequest:\n type: object\n properties:\n name:\n type: string\n examples:\n - eu-west-agent\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the private location (required, 1-256 characters).\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors this private location should run (optional).\n metadata:\n type: object\n title: metadata\n maxProperties: 20\n additionalProperties:\n type: string\n title: value\n maxLength: 256\n description: User-defined key/value labels (optional, up to 20 entries).\n title: CreatePrivateLocationRequest\n additionalProperties: false\n description: CreatePrivateLocationRequest is the request to create a new private location.\n openstatus.private_location.v1.CreatePrivateLocationRequest.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.CreatePrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The created private location, including its generated agent token.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: CreatePrivateLocationResponse\n additionalProperties: false\n description: CreatePrivateLocationResponse is the response after creating a private location.\n openstatus.private_location.v1.DeletePrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to delete (required).\n title: DeletePrivateLocationRequest\n additionalProperties: false\n description: DeletePrivateLocationRequest is the request to delete a private location.\n openstatus.private_location.v1.DeletePrivateLocationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeletePrivateLocationResponse\n additionalProperties: false\n description: DeletePrivateLocationResponse is the response after deleting a private location.\n openstatus.private_location.v1.GetPrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to retrieve (required).\n title: GetPrivateLocationRequest\n additionalProperties: false\n description: GetPrivateLocationRequest is the request to get a private location by ID.\n openstatus.private_location.v1.GetPrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The requested private location.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: GetPrivateLocationResponse\n additionalProperties: false\n description: GetPrivateLocationResponse is the response containing the private location.\n openstatus.private_location.v1.ListPrivateLocationsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of private locations to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of private locations to skip for pagination (defaults to 0).\n title: ListPrivateLocationsRequest\n additionalProperties: false\n description: ListPrivateLocationsRequest is the request to list private locations.\n openstatus.private_location.v1.ListPrivateLocationsResponse:\n type: object\n properties:\n privateLocations:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationSummary'\n title: private_locations\n description: List of private locations.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of private locations in the workspace.\n title: ListPrivateLocationsResponse\n additionalProperties: false\n description: ListPrivateLocationsResponse is the response containing private location summaries.\n openstatus.private_location.v1.PrivateLocation:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the private location.\n name:\n type: string\n title: name\n description: Display name for the private location.\n token:\n type: string\n title: token\n description: |-\n Agent credential. Generated by the server on creation and used by the\n agent to authenticate; treat it as a secret.\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors this private location runs.\n lastSeenAt:\n type: string\n title: last_seen_at\n description: Last time the agent reported a result (RFC 3339), empty if it never has.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the private location was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the private location was last updated (RFC 3339 format).\n metadata:\n type: object\n title: metadata\n additionalProperties:\n type: string\n title: value\n description: User-defined key/value labels attached to this private location.\n status:\n title: status\n description: Computed health of the agent. Read-only.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'\n title: PrivateLocation\n additionalProperties: false\n description: PrivateLocation represents a self-hosted checker agent with full details.\n openstatus.private_location.v1.PrivateLocation.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.PrivateLocationStatus:\n type: string\n title: PrivateLocationStatus\n enum:\n - PRIVATE_LOCATION_STATUS_UNSPECIFIED\n - PRIVATE_LOCATION_STATUS_ACTIVE\n - PRIVATE_LOCATION_STATUS_ERROR\n description: |-\n PrivateLocationStatus is the computed health of a private location, derived\n from the agent heartbeat. Read-only — it cannot be set through the API.\n openstatus.private_location.v1.PrivateLocationSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the private location.\n name:\n type: string\n title: name\n description: Display name for the private location.\n monitorCount:\n type: integer\n title: monitor_count\n format: int32\n description: Number of monitors this private location runs.\n lastSeenAt:\n type: string\n title: last_seen_at\n description: Last time the agent reported a result (RFC 3339), empty if it never has.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the private location was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the private location was last updated (RFC 3339 format).\n status:\n title: status\n description: Computed health of the agent. Read-only.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'\n metadata:\n type: object\n title: metadata\n additionalProperties:\n type: string\n title: value\n description: User-defined key/value labels attached to this private location.\n title: PrivateLocationSummary\n additionalProperties: false\n description: |-\n PrivateLocationSummary represents metadata for a private location (used in\n list responses). The agent token is intentionally omitted.\n openstatus.private_location.v1.PrivateLocationSummary.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.UpdatePrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n minLength: 1\n description: New display name for the private location (optional).\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: New list of monitor IDs. Only applied when update_monitor_ids is true.\n updateMonitorIds:\n type:\n - boolean\n - \"null\"\n title: update_monitor_ids\n description: |-\n When true, monitor_ids replaces the current associations (an empty list\n clears all). When false or unset, monitor_ids is ignored and existing\n associations are preserved.\n metadata:\n type: object\n title: metadata\n maxProperties: 20\n additionalProperties:\n type: string\n title: value\n maxLength: 256\n description: New key/value labels. Only applied when update_metadata is true.\n updateMetadata:\n type:\n - boolean\n - \"null\"\n title: update_metadata\n description: |-\n When true, metadata replaces the current labels (an empty map clears all).\n When false or unset, metadata is ignored and existing labels are preserved.\n title: UpdatePrivateLocationRequest\n additionalProperties: false\n description: UpdatePrivateLocationRequest is the request to update a private location.\n openstatus.private_location.v1.UpdatePrivateLocationRequest.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.UpdatePrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The updated private location.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: UpdatePrivateLocationResponse\n additionalProperties: false\n description: UpdatePrivateLocationResponse is the response after updating a private location.\n openstatus.status_page.v1.AddMonitorComponentRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to add the component to (required).\n monitorId:\n type: string\n title: monitor_id\n minLength: 1\n description: ID of the monitor to associate with this component (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n description: Display name for the component (optional, defaults to monitor name).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: Display order of the component (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: ID of the group to add this component to (optional).\n title: AddMonitorComponentRequest\n additionalProperties: false\n description: AddMonitorComponentRequest is the request to add a monitor-based component to a status page.\n openstatus.status_page.v1.AddMonitorComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The created component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: AddMonitorComponentResponse\n additionalProperties: false\n description: AddMonitorComponentResponse is the response after adding a monitor component.\n openstatus.status_page.v1.AddStaticComponentRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to add the component to (required).\n name:\n type: string\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the component (required).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: Display order of the component (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: ID of the group to add this component to (optional).\n title: AddStaticComponentRequest\n additionalProperties: false\n description: AddStaticComponentRequest is the request to add a static component to a status page.\n openstatus.status_page.v1.AddStaticComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The created component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: AddStaticComponentResponse\n additionalProperties: false\n description: AddStaticComponentResponse is the response after adding a static component.\n openstatus.status_page.v1.ComponentDayBucket:\n type: object\n properties:\n day:\n type: string\n title: day\n description: Day in RFC 3339 format (UTC midnight).\n count:\n type:\n - integer\n - string\n title: count\n format: int64\n description: Total checks that day.\n ok:\n type:\n - integer\n - string\n title: ok\n format: int64\n description: Successful checks.\n degraded:\n type:\n - integer\n - string\n title: degraded\n format: int64\n description: Degraded checks.\n error:\n type:\n - integer\n - string\n title: error\n format: int64\n description: Failed checks.\n status:\n title: status\n description: Convenience resolved status for the day.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayStatus'\n impact:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n - type: \"null\"\n title: impact\n description: Worst status-report impact overlapping the day (absent when none).\n title: ComponentDayBucket\n additionalProperties: false\n description: ComponentDayBucket is one day of status data for a component.\n openstatus.status_page.v1.ComponentDayStatus:\n type: string\n title: ComponentDayStatus\n enum:\n - COMPONENT_DAY_STATUS_UNSPECIFIED\n - COMPONENT_DAY_STATUS_OPERATIONAL\n - COMPONENT_DAY_STATUS_DEGRADED\n - COMPONENT_DAY_STATUS_DOWN\n - COMPONENT_DAY_STATUS_MAINTENANCE\n - COMPONENT_DAY_STATUS_EMPTY\n description: ComponentDayStatus is the resolved status of a component on a given day.\n openstatus.status_page.v1.ComponentEvent:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Identifier of the underlying event.\n name:\n type: string\n title: name\n description: Human-readable name (incident \"Downtime\", maintenance / report title).\n type:\n title: type\n description: Kind of event.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventType'\n status:\n title: status\n description: Projected status this event contributes.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventStatus'\n from:\n type: string\n title: from\n description: Start time (RFC 3339).\n to:\n type:\n - string\n - \"null\"\n title: to\n description: End time (RFC 3339); absent while the event is ongoing.\n impact:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n - type: \"null\"\n title: impact\n description: Worst impact over the event (reports only; absent otherwise).\n title: ComponentEvent\n additionalProperties: false\n description: ComponentEvent is a single incident / maintenance / report affecting a component.\n openstatus.status_page.v1.ComponentEventStatus:\n type: string\n title: ComponentEventStatus\n enum:\n - COMPONENT_EVENT_STATUS_UNSPECIFIED\n - COMPONENT_EVENT_STATUS_OPERATIONAL\n - COMPONENT_EVENT_STATUS_DEGRADED\n - COMPONENT_EVENT_STATUS_DOWN\n - COMPONENT_EVENT_STATUS_MAINTENANCE\n description: ComponentEventStatus is the projected status an event contributes.\n openstatus.status_page.v1.ComponentEventType:\n type: string\n title: ComponentEventType\n enum:\n - COMPONENT_EVENT_TYPE_UNSPECIFIED\n - COMPONENT_EVENT_TYPE_MAINTENANCE\n - COMPONENT_EVENT_TYPE_INCIDENT\n - COMPONENT_EVENT_TYPE_REPORT\n description: ComponentEventType is the kind of timeline event affecting a component.\n openstatus.status_page.v1.ComponentStatus:\n type: object\n properties:\n componentId:\n type: string\n title: component_id\n description: ID of the component.\n status:\n title: status\n description: Current status of the component.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n title: ComponentStatus\n additionalProperties: false\n description: ComponentStatus represents the status of a single component.\n openstatus.status_page.v1.CreateComponentGroupRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to create the group in (required).\n name:\n type: string\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the group (required).\n defaultOpen:\n type:\n - boolean\n - \"null\"\n title: default_open\n description: Whether the group should be expanded by default on the status page (optional, defaults to false).\n title: CreateComponentGroupRequest\n additionalProperties: false\n description: CreateComponentGroupRequest is the request to create a new component group.\n openstatus.status_page.v1.CreateComponentGroupResponse:\n type: object\n properties:\n group:\n title: group\n description: The created component group.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: CreateComponentGroupResponse\n additionalProperties: false\n description: CreateComponentGroupResponse is the response after creating a component group.\n openstatus.status_page.v1.CreatePageSubscriptionRequest:\n type: object\n allOf:\n - properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 255\n description: Optional human-readable label.\n componentIds:\n type: array\n items:\n type: string\n title: component_ids\n description: Component scope. Empty = entire page.\n - oneOf:\n - type: object\n properties:\n emailChannel:\n title: email_channel\n $ref: '#/components/schemas/openstatus.status_page.v1.EmailChannel'\n title: email_channel\n required:\n - emailChannel\n - type: object\n properties:\n webhookChannel:\n title: webhook_channel\n $ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannel'\n title: webhook_channel\n required:\n - webhookChannel\n title: CreatePageSubscriptionRequest\n additionalProperties: false\n description: CreatePageSubscriptionRequest is the request to add a vendor-managed subscriber to a status page.\n openstatus.status_page.v1.CreatePageSubscriptionResponse:\n type: object\n properties:\n subscriber:\n title: subscriber\n description: The created subscriber.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: CreatePageSubscriptionResponse\n additionalProperties: false\n description: CreatePageSubscriptionResponse is the response after creating a vendor-managed subscription.\n openstatus.status_page.v1.CreateStatusPageRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - Acme Corp Status\n title: title\n maxLength: 256\n minLength: 1\n description: Title of the status page (required).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the status page (optional).\n slug:\n type: string\n examples:\n - my-status-page\n title: slug\n maxLength: 256\n minLength: 1\n pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$\n description: URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens.\n homepageUrl:\n type:\n - string\n - \"null\"\n examples:\n - https://www.example.com\n title: homepage_url\n description: URL to the homepage (optional).\n contactUrl:\n type:\n - string\n - \"null\"\n title: contact_url\n description: URL to the contact page (optional).\n defaultLocale:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n - type: \"null\"\n title: default_locale\n description: Default locale for the status page (optional, defaults to EN).\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: Enabled locales for the status page (optional).\n icon:\n type:\n - string\n - \"null\"\n title: icon\n maxLength: 1024\n description: Icon URL for the status page (optional).\n customDomain:\n type:\n - string\n - \"null\"\n title: custom_domain\n maxLength: 256\n description: Custom domain for the status page (optional).\n theme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n - type: \"null\"\n title: theme\n description: Visual theme for the status page (optional, defaults to SYSTEM).\n accessType:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n - type: \"null\"\n title: access_type\n description: Access type for the status page (optional, defaults to PUBLIC).\n password:\n type:\n - string\n - \"null\"\n title: password\n maxLength: 256\n minLength: 1\n description: Password for the status page (required when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: Email domains allowed to access the page (used when access_type is AUTHENTICATED).\n allowIndex:\n type:\n - boolean\n - \"null\"\n title: allow_index\n description: Whether search engines are allowed to index this status page (optional, defaults to true).\n allowedIpRanges:\n type:\n - string\n - \"null\"\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: |-\n Per-mode CSS variable overrides merged over the theme (optional).\n Only supported variable names are accepted. Requires the custom-theme plan feature.\n title: CreateStatusPageRequest\n additionalProperties: false\n description: CreateStatusPageRequest is the request to create a new status page.\n openstatus.status_page.v1.CreateStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The created status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: CreateStatusPageResponse\n additionalProperties: false\n description: CreateStatusPageResponse is the response after creating a status page.\n openstatus.status_page.v1.CustomTheme:\n type: object\n properties:\n light:\n type: object\n title: light\n additionalProperties:\n type: string\n title: value\n description: 'CSS variable overrides applied in light mode, keyed by variable name (e.g. \"--primary\": \"hsl(24 94% 50%)\").'\n dark:\n type: object\n title: dark\n additionalProperties:\n type: string\n title: value\n description: CSS variable overrides applied in dark mode, keyed by variable name.\n title: CustomTheme\n additionalProperties: false\n description: CustomTheme holds per-mode CSS variable overrides merged over the page theme.\n openstatus.status_page.v1.CustomTheme.DarkEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: DarkEntry\n additionalProperties: false\n openstatus.status_page.v1.CustomTheme.LightEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: LightEntry\n additionalProperties: false\n openstatus.status_page.v1.DeleteComponentGroupRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component group to delete (required).\n title: DeleteComponentGroupRequest\n additionalProperties: false\n description: DeleteComponentGroupRequest is the request to delete a component group.\n openstatus.status_page.v1.DeleteComponentGroupResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteComponentGroupResponse\n additionalProperties: false\n description: DeleteComponentGroupResponse is the response after deleting a component group.\n openstatus.status_page.v1.DeleteStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to delete (required).\n title: DeleteStatusPageRequest\n additionalProperties: false\n description: DeleteStatusPageRequest is the request to delete a status page.\n openstatus.status_page.v1.DeleteStatusPageResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteStatusPageResponse\n additionalProperties: false\n description: DeleteStatusPageResponse is the response after deleting a status page.\n openstatus.status_page.v1.EmailChannel:\n type: object\n properties:\n email:\n type: string\n title: email\n format: email\n description: Email address of the subscriber (required).\n title: EmailChannel\n additionalProperties: false\n description: EmailChannel carries the email-channel fields for CreatePageSubscription.\n openstatus.status_page.v1.GetOverallStatusRequest:\n type: object\n oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetOverallStatusRequest\n additionalProperties: false\n description: GetOverallStatusRequest is the request to get the overall status of a status page.\n openstatus.status_page.v1.GetOverallStatusResponse:\n type: object\n properties:\n overallStatus:\n title: overall_status\n description: Aggregated status across all components.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n componentStatuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'\n title: component_statuses\n description: Status of individual components.\n title: GetOverallStatusResponse\n additionalProperties: false\n description: GetOverallStatusResponse is the response containing the overall status and individual component statuses.\n openstatus.status_page.v1.GetPageComponentDailySummaryRequest:\n type: object\n allOf:\n - properties:\n componentIds:\n type: array\n items:\n type: string\n minLength: 1\n title: component_ids\n description: Restrict the result to these component ids (optional, defaults to all components).\n days:\n type:\n - integer\n - \"null\"\n title: days\n maximum: 45\n minimum: 1\n format: int32\n description: Number of days to return (1-45, defaults to 45 if unspecified).\n - oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetPageComponentDailySummaryRequest\n additionalProperties: false\n description: GetPageComponentDailySummaryRequest is the request for per-component daily summaries.\n openstatus.status_page.v1.GetPageComponentDailySummaryResponse:\n type: object\n properties:\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentDailySummary'\n title: components\n description: Per-component daily summaries, in page order.\n title: GetPageComponentDailySummaryResponse\n additionalProperties: false\n description: GetPageComponentDailySummaryResponse is the response containing per-component summaries.\n openstatus.status_page.v1.GetPageComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to retrieve (required).\n title: GetPageComponentRequest\n additionalProperties: false\n description: GetPageComponentRequest is the request to fetch a single component by ID.\n openstatus.status_page.v1.GetPageComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The requested component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: GetPageComponentResponse\n additionalProperties: false\n description: GetPageComponentResponse is the response containing the component.\n openstatus.status_page.v1.GetStatusPageContentRequest:\n type: object\n oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetStatusPageContentRequest\n additionalProperties: false\n description: GetStatusPageContentRequest is the request to get the full content of a status page.\n openstatus.status_page.v1.GetStatusPageContentResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The status page details.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: components\n description: Components on the status page.\n groups:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: groups\n description: Component groups on the status page.\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: status_reports\n description: Active and recent status reports.\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: Scheduled maintenances.\n title: GetStatusPageContentResponse\n additionalProperties: false\n description: GetStatusPageContentResponse is the response containing the full status page content.\n openstatus.status_page.v1.GetStatusPageOverviewRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page (required, workspace-scoped).\n title: GetStatusPageOverviewRequest\n additionalProperties: false\n description: GetStatusPageOverviewRequest requests the full overview of a status page by id.\n openstatus.status_page.v1.GetStatusPageOverviewResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The status page details.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n configuration:\n title: configuration\n description: Rich rendering configuration of the page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageConfiguration'\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: components\n description: Components on the status page.\n groups:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: groups\n description: Component groups on the status page.\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: status_reports\n description: Active and recent status reports.\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: Scheduled maintenances.\n overallStatus:\n title: overall_status\n description: Aggregated status across all components.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n componentStatuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'\n title: component_statuses\n description: Status of individual components.\n title: GetStatusPageOverviewResponse\n additionalProperties: false\n description: GetStatusPageOverviewResponse bundles all data for a single status page.\n openstatus.status_page.v1.GetStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to retrieve (required).\n title: GetStatusPageRequest\n additionalProperties: false\n description: GetStatusPageRequest is the request to get a status page by ID.\n openstatus.status_page.v1.GetStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The requested status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: GetStatusPageResponse\n additionalProperties: false\n description: GetStatusPageResponse is the response containing the status page.\n openstatus.status_page.v1.ListStatusPagesRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of pages to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of pages to skip for pagination (defaults to 0).\n title: ListStatusPagesRequest\n additionalProperties: false\n description: ListStatusPagesRequest is the request to list status pages.\n openstatus.status_page.v1.ListStatusPagesResponse:\n type: object\n properties:\n statusPages:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPageSummary'\n title: status_pages\n description: List of status pages (metadata only).\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of status pages.\n title: ListStatusPagesResponse\n additionalProperties: false\n description: ListStatusPagesResponse is the response containing status page summaries.\n openstatus.status_page.v1.ListSubscribersRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to list subscribers for (required).\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of subscribers to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of subscribers to skip for pagination (defaults to 0).\n includeUnsubscribed:\n type:\n - boolean\n - \"null\"\n title: include_unsubscribed\n description: Whether to include unsubscribed users (defaults to false).\n title: ListSubscribersRequest\n additionalProperties: false\n description: ListSubscribersRequest is the request to list subscribers of a status page.\n openstatus.status_page.v1.ListSubscribersResponse:\n type: object\n properties:\n subscribers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: subscribers\n description: List of subscribers.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of subscribers matching the filter.\n title: ListSubscribersResponse\n additionalProperties: false\n description: ListSubscribersResponse is the response containing status page subscribers.\n openstatus.status_page.v1.Locale:\n type: string\n title: Locale\n enum:\n - LOCALE_UNSPECIFIED\n - LOCALE_EN\n - LOCALE_FR\n - LOCALE_DE\n - LOCALE_TR\n - LOCALE_HI\n - LOCALE_KO\n - LOCALE_JA\n description: Locale defines the supported languages for a status page.\n openstatus.status_page.v1.OverallStatus:\n type: string\n title: OverallStatus\n enum:\n - OVERALL_STATUS_UNSPECIFIED\n - OVERALL_STATUS_OPERATIONAL\n - OVERALL_STATUS_DEGRADED\n - OVERALL_STATUS_PARTIAL_OUTAGE\n - OVERALL_STATUS_MAJOR_OUTAGE\n - OVERALL_STATUS_MAINTENANCE\n - OVERALL_STATUS_UNKNOWN\n description: OverallStatus represents the aggregated status of all components on a page.\n openstatus.status_page.v1.PageAccessType:\n type: string\n title: PageAccessType\n enum:\n - PAGE_ACCESS_TYPE_UNSPECIFIED\n - PAGE_ACCESS_TYPE_PUBLIC\n - PAGE_ACCESS_TYPE_PASSWORD_PROTECTED\n - PAGE_ACCESS_TYPE_AUTHENTICATED\n - PAGE_ACCESS_TYPE_IP_RESTRICTED\n description: PageAccessType defines who can access the status page.\n openstatus.status_page.v1.PageBarType:\n type: string\n title: PageBarType\n enum:\n - PAGE_BAR_TYPE_UNSPECIFIED\n - PAGE_BAR_TYPE_ABSOLUTE\n - PAGE_BAR_TYPE_MANUAL\n description: PageBarType mirrors page.configuration.type (how the status bar is computed).\n openstatus.status_page.v1.PageComponent:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the component.\n pageId:\n type: string\n title: page_id\n description: ID of the status page this component belongs to.\n name:\n type: string\n title: name\n description: Display name of the component.\n description:\n type: string\n title: description\n description: Description of the component (optional).\n type:\n title: type\n description: Type of the component (monitor or static).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'\n monitorId:\n type: string\n title: monitor_id\n description: ID of the monitor if type is MONITOR (optional).\n order:\n type: integer\n title: order\n format: int32\n description: Display order of the component.\n groupId:\n type: string\n title: group_id\n description: ID of the group this component belongs to (optional).\n groupOrder:\n type: integer\n title: group_order\n format: int32\n description: Order within the group if grouped.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the component was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the component was last updated (RFC 3339 format).\n title: PageComponent\n additionalProperties: false\n description: PageComponent represents a component displayed on a status page.\n openstatus.status_page.v1.PageComponentDailySummary:\n type: object\n properties:\n componentId:\n type: string\n title: component_id\n description: ID of the component.\n type:\n title: type\n description: Component type (monitor or static).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'\n monitorId:\n type:\n - string\n - \"null\"\n title: monitor_id\n description: Monitor id backing the component (absent for static components).\n name:\n type: string\n title: name\n description: Display name of the component.\n buckets:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayBucket'\n title: buckets\n description: Per-day buckets, oldest first.\n events:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEvent'\n title: events\n description: Events affecting the component within the window.\n title: PageComponentDailySummary\n additionalProperties: false\n description: PageComponentDailySummary is the per-day buckets + event timeline for one component.\n openstatus.status_page.v1.PageComponentGroup:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the group.\n pageId:\n type: string\n title: page_id\n description: ID of the status page this group belongs to.\n name:\n type: string\n title: name\n description: Display name of the group.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the group was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the group was last updated (RFC 3339 format).\n defaultOpen:\n type: boolean\n title: default_open\n description: Whether the group should be expanded by default on the status page.\n title: PageComponentGroup\n additionalProperties: false\n description: PageComponentGroup represents a group of components on a status page.\n openstatus.status_page.v1.PageComponentType:\n type: string\n title: PageComponentType\n enum:\n - PAGE_COMPONENT_TYPE_UNSPECIFIED\n - PAGE_COMPONENT_TYPE_MONITOR\n - PAGE_COMPONENT_TYPE_STATIC\n description: PageComponentType defines the type of a component on a status page.\n openstatus.status_page.v1.PageConfiguration:\n type: object\n properties:\n metricType:\n title: metric_type\n description: Which metric the status bars represent (configuration.value).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageMetricType'\n barType:\n title: bar_type\n description: How the status bar is computed (configuration.type).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageBarType'\n showUptime:\n type: boolean\n title: show_uptime\n description: Whether to show the uptime percentage (configuration.uptime).\n themeKey:\n type: string\n title: theme_key\n description: |-\n Theme key from the theme store (configuration.theme), e.g. \"default\".\n Free-form string rather than an enum because the theme catalog is dynamic.\n days:\n type: integer\n title: days\n format: int32\n description: 'Number of uptime-bar days rendered on the page (configuration.days): 30 or 45.'\n title: PageConfiguration\n additionalProperties: false\n description: PageConfiguration is the rich rendering config stored in page.configuration.\n openstatus.status_page.v1.PageMetricType:\n type: string\n title: PageMetricType\n enum:\n - PAGE_METRIC_TYPE_UNSPECIFIED\n - PAGE_METRIC_TYPE_DURATION\n - PAGE_METRIC_TYPE_REQUESTS\n - PAGE_METRIC_TYPE_MANUAL\n description: PageMetricType mirrors page.configuration.value (which metric the status bars represent).\n openstatus.status_page.v1.PageSubscriber:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the subscriber.\n pageId:\n type: string\n title: page_id\n description: ID of the status page the user is subscribed to.\n email:\n type: string\n title: email\n description: Email address of the subscriber (empty for webhook channels).\n acceptedAt:\n type: string\n title: accepted_at\n description: Timestamp when the subscription was accepted/confirmed (RFC 3339 format, optional).\n unsubscribedAt:\n type: string\n title: unsubscribed_at\n description: Timestamp when the user unsubscribed (RFC 3339 format, optional).\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the subscription was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the subscription was last updated (RFC 3339 format).\n source:\n title: source\n description: How the subscription was created. Vendor-added rows skip verification.\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscriberSource'\n name:\n type:\n - string\n - \"null\"\n title: name\n description: 'Optional human-readable label (e.g. \"Supabase #incidents\").'\n channelType:\n type: string\n title: channel_type\n description: 'Channel type: \"email\" or \"webhook\".'\n webhookUrl:\n type:\n - string\n - \"null\"\n title: webhook_url\n description: Webhook URL (populated only for channel_type = \"webhook\").\n channelConfig:\n type:\n - string\n - \"null\"\n title: channel_config\n description: JSON-encoded channel config (e.g. custom headers). Populated for webhook channels.\n componentIds:\n type: array\n items:\n type: string\n title: component_ids\n description: IDs of components this subscription is scoped to. Empty = entire page.\n title: PageSubscriber\n additionalProperties: false\n description: PageSubscriber represents a subscriber to a status page.\n openstatus.status_page.v1.PageTheme:\n type: string\n title: PageTheme\n enum:\n - PAGE_THEME_UNSPECIFIED\n - PAGE_THEME_SYSTEM\n - PAGE_THEME_LIGHT\n - PAGE_THEME_DARK\n description: PageTheme defines the visual theme of the status page.\n openstatus.status_page.v1.RemoveComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to remove (required).\n title: RemoveComponentRequest\n additionalProperties: false\n description: RemoveComponentRequest is the request to remove a component from a status page.\n openstatus.status_page.v1.RemoveComponentResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the removal was successful.\n title: RemoveComponentResponse\n additionalProperties: false\n description: RemoveComponentResponse is the response after removing a component.\n openstatus.status_page.v1.StatusPage:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status page.\n title:\n type: string\n title: title\n description: Title of the status page.\n description:\n type: string\n title: description\n description: Description of the status page.\n slug:\n type: string\n examples:\n - acme-corp\n title: slug\n description: URL-friendly slug for the status page.\n customDomain:\n type: string\n examples:\n - status.example.com\n title: custom_domain\n description: Custom domain for the status page (optional).\n published:\n type: boolean\n title: published\n description: Whether the status page is published and visible.\n accessType:\n title: access_type\n description: Access type for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n theme:\n title: theme\n description: Visual theme for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n homepageUrl:\n type: string\n title: homepage_url\n description: URL to the homepage (optional).\n contactUrl:\n type: string\n title: contact_url\n description: URL to the contact page (optional).\n icon:\n type: string\n title: icon\n description: Icon URL for the status page (optional).\n createdAt:\n type: string\n examples:\n - \"2024-01-15T09:00:00Z\"\n title: created_at\n description: Timestamp when the page was created (RFC 3339 format).\n updatedAt:\n type: string\n examples:\n - \"2024-06-20T14:30:00Z\"\n title: updated_at\n description: Timestamp when the page was last updated (RFC 3339 format).\n defaultLocale:\n title: default_locale\n description: Default locale for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: Enabled locales for the status page.\n password:\n type: string\n title: password\n description: Password for the status page (only set when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: Email domains allowed to access the page (only set when access_type is AUTHENTICATED).\n allowIndex:\n type: boolean\n title: allow_index\n description: Whether search engines are allowed to index this status page.\n allowedIpRanges:\n type: string\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (only set when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: Per-mode CSS variable overrides merged over the theme (only set when configured).\n title: StatusPage\n additionalProperties: false\n description: StatusPage represents a full status page with all details.\n openstatus.status_page.v1.StatusPageSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status page.\n title:\n type: string\n title: title\n description: Title of the status page.\n slug:\n type: string\n title: slug\n description: URL-friendly slug for the status page.\n published:\n type: boolean\n title: published\n description: Whether the status page is published and visible.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the page was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the page was last updated (RFC 3339 format).\n customDomain:\n type: string\n examples:\n - status.example.com\n title: custom_domain\n description: Custom domain for the status page (optional).\n title: StatusPageSummary\n additionalProperties: false\n description: StatusPageSummary represents metadata for a status page (used in list responses).\n openstatus.status_page.v1.SubscribeToPageRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to subscribe to (required).\n email:\n type: string\n examples:\n - [email protected]\n title: email\n format: email\n description: Email address to subscribe (required).\n title: SubscribeToPageRequest\n additionalProperties: false\n description: SubscribeToPageRequest is the request to subscribe an email to a status page.\n openstatus.status_page.v1.SubscribeToPageResponse:\n type: object\n properties:\n subscriber:\n title: subscriber\n description: The created subscriber.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: SubscribeToPageResponse\n additionalProperties: false\n description: SubscribeToPageResponse is the response after subscribing to a status page.\n openstatus.status_page.v1.SubscriberSource:\n type: string\n title: SubscriberSource\n enum:\n - SUBSCRIBER_SOURCE_UNSPECIFIED\n - SUBSCRIBER_SOURCE_SELF_SIGNUP\n - SUBSCRIBER_SOURCE_VENDOR\n - SUBSCRIBER_SOURCE_IMPORT\n description: SubscriberSource indicates how the subscription was created.\n openstatus.status_page.v1.UnsubscribeFromPageRequest:\n type: object\n allOf:\n - properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to unsubscribe from (required).\n - oneOf:\n - type: object\n properties:\n email:\n type: string\n title: email\n description: Email address to unsubscribe.\n title: email\n required:\n - email\n - type: object\n properties:\n id:\n type: string\n title: id\n description: Subscriber ID.\n title: id\n required:\n - id\n title: UnsubscribeFromPageRequest\n additionalProperties: false\n description: UnsubscribeFromPageRequest is the request to unsubscribe from a status page.\n openstatus.status_page.v1.UnsubscribeFromPageResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the unsubscription was successful.\n title: UnsubscribeFromPageResponse\n additionalProperties: false\n description: UnsubscribeFromPageResponse is the response after unsubscribing from a status page.\n openstatus.status_page.v1.UpdateComponentGroupRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component group to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n minLength: 1\n description: New display name for the group (optional).\n defaultOpen:\n type:\n - boolean\n - \"null\"\n title: default_open\n description: Whether the group should be expanded by default on the status page (optional).\n title: UpdateComponentGroupRequest\n additionalProperties: false\n description: UpdateComponentGroupRequest is the request to update a component group.\n openstatus.status_page.v1.UpdateComponentGroupResponse:\n type: object\n properties:\n group:\n title: group\n description: The updated component group.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: UpdateComponentGroupResponse\n additionalProperties: false\n description: UpdateComponentGroupResponse is the response after updating a component group.\n openstatus.status_page.v1.UpdateComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n description: New display name for the component (optional).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: New description for the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: New display order (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: New group ID (optional, set to empty string to remove from group).\n groupOrder:\n type:\n - integer\n - \"null\"\n title: group_order\n format: int32\n description: New order within the group (optional).\n title: UpdateComponentRequest\n additionalProperties: false\n description: UpdateComponentRequest is the request to update a component.\n openstatus.status_page.v1.UpdateComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The updated component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: UpdateComponentResponse\n additionalProperties: false\n description: UpdateComponentResponse is the response after updating a component.\n openstatus.status_page.v1.UpdateStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n maxLength: 256\n minLength: 1\n description: New title for the status page (optional).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: New description for the status page (optional).\n slug:\n type:\n - string\n - \"null\"\n title: slug\n maxLength: 256\n minLength: 1\n pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$\n description: New slug for the status page (optional).\n homepageUrl:\n type:\n - string\n - \"null\"\n title: homepage_url\n description: New homepage URL (optional).\n contactUrl:\n type:\n - string\n - \"null\"\n title: contact_url\n description: New contact URL (optional).\n defaultLocale:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n - type: \"null\"\n title: default_locale\n description: New default locale for the status page (optional).\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: New enabled locales for the status page (optional).\n icon:\n type:\n - string\n - \"null\"\n title: icon\n maxLength: 1024\n description: New icon URL for the status page (optional).\n customDomain:\n type:\n - string\n - \"null\"\n title: custom_domain\n maxLength: 256\n description: New custom domain (optional).\n theme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n - type: \"null\"\n title: theme\n description: New visual theme (optional).\n accessType:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n - type: \"null\"\n title: access_type\n description: New access type (optional).\n password:\n type:\n - string\n - \"null\"\n title: password\n maxLength: 256\n minLength: 1\n description: New password (optional, required when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: New email domains (optional, required when access_type is AUTHENTICATED).\n allowIndex:\n type:\n - boolean\n - \"null\"\n title: allow_index\n description: Whether search engines are allowed to index this status page (optional).\n allowedIpRanges:\n type:\n - string\n - \"null\"\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: |-\n New per-mode CSS variable overrides (optional). Omit to keep the current\n value; send an empty message to clear. Requires the custom-theme plan feature.\n title: UpdateStatusPageRequest\n additionalProperties: false\n description: UpdateStatusPageRequest is the request to update a status page.\n openstatus.status_page.v1.UpdateStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The updated status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: UpdateStatusPageResponse\n additionalProperties: false\n description: UpdateStatusPageResponse is the response after updating a status page.\n openstatus.status_page.v1.WebhookChannel:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n maxLength: 2048\n minLength: 1\n format: uri\n description: Webhook URL (required). Payload flavor (Slack / Discord / generic) is auto-detected from the URL prefix.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannelHeader'\n title: headers\n description: Optional custom HTTP headers attached to every dispatch.\n title: WebhookChannel\n additionalProperties: false\n description: WebhookChannel carries the webhook-channel fields for CreatePageSubscription.\n openstatus.status_page.v1.WebhookChannelHeader:\n type: object\n properties:\n key:\n type: string\n title: key\n minLength: 1\n value:\n type: string\n title: value\n title: WebhookChannelHeader\n additionalProperties: false\n description: WebhookChannelHeader is a single custom HTTP header.\n openstatus.status_report.v1.AddStatusReportUpdateRequest:\n type: object\n properties:\n statusReportId:\n type: string\n title: status_report_id\n minLength: 1\n description: ID of the status report to update (required).\n status:\n title: status\n description: New status for the report (required).\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n message:\n type: string\n title: message\n minLength: 1\n description: Message describing what changed (required).\n date:\n type:\n - string\n - \"null\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Optional date for the update (RFC 3339 format). Defaults to current time if not provided.\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this update (optional, defaults to false).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: |-\n Per-component impacts this update sets (optional). Components named here\n are added to the report's affected set; omitted components keep their\n prior impact.\n title: AddStatusReportUpdateRequest\n additionalProperties: false\n description: AddStatusReportUpdateRequest is the request to add a new update to a status report.\n openstatus.status_report.v1.AddStatusReportUpdateResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The updated status report with the new update included.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: AddStatusReportUpdateResponse\n additionalProperties: false\n description: AddStatusReportUpdateResponse is the response after adding an update to a status report.\n openstatus.status_report.v1.ComponentImpact:\n type: object\n properties:\n pageComponentId:\n type: string\n title: page_component_id\n description: ID of the affected page component.\n impact:\n title: impact\n description: Impact set for the component.\n $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n title: ComponentImpact\n additionalProperties: false\n description: ComponentImpact pairs a page component with the impact an update set for it.\n openstatus.status_report.v1.CreateStatusReportRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - API Degradation Investigation\n title: title\n minLength: 1\n description: Title of the status report (required).\n status:\n title: status\n description: Initial status (required).\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n message:\n type: string\n examples:\n - We are investigating reports of increased API latency.\n title: message\n minLength: 1\n description: Initial message describing the incident (required).\n date:\n type: string\n examples:\n - \"2024-03-15T10:30:00Z\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Date when the event occurred (RFC 3339 format, required).\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: Page ID to associate with this report (required).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: Page component IDs to associate with this report (optional).\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this status report (optional, defaults to false).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: |-\n Per-component impacts set by the initial update (optional). When provided,\n the named components are added to the report's affected set. Omitting this\n field creates a legacy report without impact tracking.\n title: CreateStatusReportRequest\n additionalProperties: false\n description: CreateStatusReportRequest is the request to create a new status report.\n openstatus.status_report.v1.CreateStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The created status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: CreateStatusReportResponse\n additionalProperties: false\n description: CreateStatusReportResponse is the response after creating a status report.\n openstatus.status_report.v1.DeleteStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to delete (required).\n title: DeleteStatusReportRequest\n additionalProperties: false\n description: DeleteStatusReportRequest is the request to delete a status report.\n openstatus.status_report.v1.DeleteStatusReportResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteStatusReportResponse\n additionalProperties: false\n description: DeleteStatusReportResponse is the response after deleting a status report.\n openstatus.status_report.v1.GetStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to retrieve (required).\n title: GetStatusReportRequest\n additionalProperties: false\n description: GetStatusReportRequest is the request to get a status report by ID.\n openstatus.status_report.v1.GetStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The requested status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: GetStatusReportResponse\n additionalProperties: false\n description: GetStatusReportResponse is the response containing the status report with its full update timeline.\n openstatus.status_report.v1.ListStatusReportsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of reports to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of reports to skip for pagination (defaults to 0).\n statuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title: statuses\n description: Filter by status (optional). If empty, returns all statuses.\n title: ListStatusReportsRequest\n additionalProperties: false\n description: ListStatusReportsRequest is the request to list status reports.\n openstatus.status_report.v1.ListStatusReportsResponse:\n type: object\n properties:\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportSummary'\n title: status_reports\n description: List of status reports (metadata only, use GetStatusReport for full details).\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of reports matching the filter.\n title: ListStatusReportsResponse\n additionalProperties: false\n description: ListStatusReportsResponse is the response containing status report summaries.\n openstatus.status_report.v1.PageComponentImpact:\n type: string\n title: PageComponentImpact\n enum:\n - PAGE_COMPONENT_IMPACT_UNSPECIFIED\n - PAGE_COMPONENT_IMPACT_OPERATIONAL\n - PAGE_COMPONENT_IMPACT_DEGRADED_PERFORMANCE\n - PAGE_COMPONENT_IMPACT_PARTIAL_OUTAGE\n - PAGE_COMPONENT_IMPACT_MAJOR_OUTAGE\n description: |-\n PageComponentImpact is the per-component impact a status report update sets.\n UNSPECIFIED means the caller doesn't speak impact (legacy) — it is NOT operational.\n openstatus.status_report.v1.StatusReport:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status report.\n status:\n title: status\n description: Current status of the report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title:\n type: string\n title: title\n description: Title of the status report.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n updates:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportUpdate'\n title: updates\n description: Timeline of updates for this report (only included in GetStatusReport).\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the report was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the report was last updated (RFC 3339 format).\n title: StatusReport\n additionalProperties: false\n description: StatusReport represents an incident or maintenance report with full details.\n openstatus.status_report.v1.StatusReportStatus:\n type: string\n title: StatusReportStatus\n enum:\n - STATUS_REPORT_STATUS_UNSPECIFIED\n - STATUS_REPORT_STATUS_INVESTIGATING\n - STATUS_REPORT_STATUS_IDENTIFIED\n - STATUS_REPORT_STATUS_MONITORING\n - STATUS_REPORT_STATUS_RESOLVED\n description: StatusReportStatus represents the current state of a status report.\n openstatus.status_report.v1.StatusReportSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status report.\n status:\n title: status\n description: Current status of the report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title:\n type: string\n title: title\n description: Title of the status report.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the report was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the report was last updated (RFC 3339 format).\n title: StatusReportSummary\n additionalProperties: false\n description: StatusReportSummary represents metadata for a status report (used in list responses).\n openstatus.status_report.v1.StatusReportUpdate:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the update.\n status:\n title: status\n description: Status at the time of this update.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n date:\n type: string\n title: date\n description: Timestamp when this update occurred (RFC 3339 format).\n message:\n type: string\n title: message\n description: Message describing the update.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the update was created (RFC 3339 format).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: Per-component impacts this update set (empty for legacy reports).\n title: StatusReportUpdate\n additionalProperties: false\n description: StatusReportUpdate represents a single update entry in a status report timeline.\n openstatus.status_report.v1.UpdateStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n description: New title for the report (optional).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: New list of page component IDs (optional, replaces existing list).\n updatePageComponentIds:\n type:\n - boolean\n - \"null\"\n title: update_page_component_ids\n description: |-\n Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved.\n title: UpdateStatusReportRequest\n additionalProperties: false\n description: UpdateStatusReportRequest is the request to update a status report's metadata.\n openstatus.status_report.v1.UpdateStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The updated status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: UpdateStatusReportResponse\n additionalProperties: false\n description: UpdateStatusReportResponse is the response after updating a status report.\nsecurity:\n - ApiKeyAuth: []\ntags:\n - name: MonitorService\n description: |\n Create, update, delete, and query monitors. Supports HTTP, TCP, and DNS monitor types\n with configurable check intervals, regions, assertions, and alerting thresholds.\n - name: StatusPageService\n description: |\n Manage public status pages with components, component groups, and email subscribers.\n Includes endpoints for retrieving full page content and aggregated status.\n - name: NotificationService\n description: |\n Configure notification channels (Slack, Discord, PagerDuty, email, webhooks, etc.)\n and associate them with monitors. Supports 12 notification providers.\n - name: StatusReportService\n description: |\n Create and manage incident reports with status updates. Reports follow a lifecycle:\n investigating -> identified -> monitoring -> resolved.\n - name: MaintenanceService\n description: |\n Schedule maintenance windows for status page components. Subscribers can be\n notified automatically when maintenance is created.\n - name: HealthService\n description: Health check endpoint for load balancer probes. No authentication required.\n - name: PrivateLocationService\n description: |-\n PrivateLocationService provides CRUD operations for private locations —\n self-hosted checker agents that run monitors from your own network.\npaths:\n /rpc/openstatus.health.v1.HealthService/Check:\n get:\n tags:\n - HealthService\n summary: Check\n description: Check returns the current serving status of the service.\n operationId: HealthService_Check.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse'\n post:\n tags:\n - HealthService\n summary: Check\n description: Check returns the current serving status of the service.\n operationId: HealthService_Check\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/AddMaintenanceUpdate:\n post:\n tags:\n - MaintenanceService\n summary: AddMaintenanceUpdate\n description: AddMaintenanceUpdate appends a public update to a maintenance timeline.\n operationId: MaintenanceService_AddMaintenanceUpdate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: CreateMaintenance\n description: CreateMaintenance creates a new maintenance window.\n operationId: MaintenanceService_CreateMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: DeleteMaintenance\n description: DeleteMaintenance removes a maintenance window.\n operationId: MaintenanceService_DeleteMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenanceUpdate:\n post:\n tags:\n - MaintenanceService\n summary: DeleteMaintenanceUpdate\n description: DeleteMaintenanceUpdate removes an existing maintenance update.\n operationId: MaintenanceService_DeleteMaintenanceUpdate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance:\n get:\n tags:\n - MaintenanceService\n summary: GetMaintenance\n description: GetMaintenance retrieves a specific maintenance window by ID.\n operationId: MaintenanceService_GetMaintenance.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'\n post:\n tags:\n - MaintenanceService\n summary: GetMaintenance\n description: GetMaintenance retrieves a specific maintenance window by ID.\n operationId: MaintenanceService_GetMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/ListMaintenances:\n get:\n tags:\n - MaintenanceService\n summary: ListMaintenances\n description: ListMaintenances returns all maintenance windows for the workspace.\n operationId: MaintenanceService_ListMaintenances.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'\n post:\n tags:\n - MaintenanceService\n summary: ListMaintenances\n description: ListMaintenances returns all maintenance windows for the workspace.\n operationId: MaintenanceService_ListMaintenances\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: UpdateMaintenance\n description: UpdateMaintenance updates a maintenance window.\n operationId: MaintenanceService_UpdateMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenanceUpdate:\n post:\n tags:\n - MaintenanceService\n summary: UpdateMaintenanceUpdate\n description: UpdateMaintenanceUpdate edits an existing maintenance update.\n operationId: MaintenanceService_UpdateMaintenanceUpdate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateDNSMonitor\n description: CreateDNSMonitor creates a new DNS monitor.\n operationId: MonitorService_CreateDNSMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateGRPCMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateGRPCMonitor\n description: CreateGRPCMonitor creates a new gRPC health check monitor.\n operationId: MonitorService_CreateGRPCMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateHTTPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateHTTPMonitor\n description: Creates a new HTTP monitor in the authenticated workspace. Configure the target URL, HTTP method, request headers and body, response assertions (status code, body content, headers), check periodicity, geographic regions, and optional OpenTelemetry export. The monitor starts checking immediately if set to active.\n operationId: MonitorService_CreateHTTPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateICMPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateICMPMonitor\n description: CreateICMPMonitor creates a new ICMP monitor.\n operationId: MonitorService_CreateICMPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateTCPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateTCPMonitor\n description: CreateTCPMonitor creates a new TCP monitor.\n operationId: MonitorService_CreateTCPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/DeleteMonitor:\n post:\n tags:\n - MonitorService\n summary: DeleteMonitor\n description: DeleteMonitor removes a monitor.\n operationId: MonitorService_DeleteMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitor:\n get:\n tags:\n - MonitorService\n summary: GetMonitor\n description: |-\n GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.\n operationId: MonitorService_GetMonitor.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitor\n description: |-\n GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.\n operationId: MonitorService_GetMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorHTTPResponseLog:\n get:\n tags:\n - MonitorService\n summary: GetMonitorHTTPResponseLog\n description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.\n operationId: MonitorService_GetMonitorHTTPResponseLog.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorHTTPResponseLog\n description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.\n operationId: MonitorService_GetMonitorHTTPResponseLog\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorStatus:\n get:\n tags:\n - MonitorService\n summary: GetMonitorStatus\n description: GetMonitorStatus returns the current status of all regions for a monitor.\n operationId: MonitorService_GetMonitorStatus.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorStatus\n description: GetMonitorStatus returns the current status of all regions for a monitor.\n operationId: MonitorService_GetMonitorStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorSummary:\n get:\n tags:\n - MonitorService\n summary: GetMonitorSummary\n description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.\n operationId: MonitorService_GetMonitorSummary.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorSummary\n description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.\n operationId: MonitorService_GetMonitorSummary\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'\n /rpc/openstatus.monitor.v1.MonitorService/ListMonitorHTTPResponseLogs:\n get:\n tags:\n - MonitorService\n summary: ListMonitorHTTPResponseLogs\n description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.\n operationId: MonitorService_ListMonitorHTTPResponseLogs.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'\n post:\n tags:\n - MonitorService\n summary: ListMonitorHTTPResponseLogs\n description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.\n operationId: MonitorService_ListMonitorHTTPResponseLogs\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'\n /rpc/openstatus.monitor.v1.MonitorService/ListMonitors:\n get:\n tags:\n - MonitorService\n summary: ListMonitors\n description: ListMonitors returns a paginated list of all monitors in the workspace.\n operationId: MonitorService_ListMonitors.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'\n post:\n tags:\n - MonitorService\n summary: ListMonitors\n description: ListMonitors returns a paginated list of all monitors in the workspace.\n operationId: MonitorService_ListMonitors\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'\n /rpc/openstatus.monitor.v1.MonitorService/TriggerMonitor:\n post:\n tags:\n - MonitorService\n summary: TriggerMonitor\n description: Manually triggers an immediate check for the specified monitor across all configured regions. This operation is rate-limited under the synthetic-checks quota. A monitor run record is created and the check is dispatched to the checker service.\n operationId: MonitorService_TriggerMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateDNSMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateDNSMonitor\n description: UpdateDNSMonitor updates an existing DNS monitor.\n operationId: MonitorService_UpdateDNSMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateGRPCMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateGRPCMonitor\n description: UpdateGRPCMonitor updates an existing gRPC monitor.\n operationId: MonitorService_UpdateGRPCMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateHTTPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateHTTPMonitor\n description: UpdateHTTPMonitor updates an existing HTTP monitor.\n operationId: MonitorService_UpdateHTTPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateICMPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateICMPMonitor\n description: UpdateICMPMonitor updates an existing ICMP monitor.\n operationId: MonitorService_UpdateICMPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateTCPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateTCPMonitor\n description: UpdateTCPMonitor updates an existing TCP monitor.\n operationId: MonitorService_UpdateTCPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorResponse'\n /rpc/openstatus.notification.v1.NotificationService/CheckNotificationLimit:\n get:\n tags:\n - NotificationService\n summary: CheckNotificationLimit\n description: CheckNotificationLimit checks if the workspace has reached its notification limit.\n operationId: NotificationService_CheckNotificationLimit.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'\n post:\n tags:\n - NotificationService\n summary: CheckNotificationLimit\n description: CheckNotificationLimit checks if the workspace has reached its notification limit.\n operationId: NotificationService_CheckNotificationLimit\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'\n /rpc/openstatus.notification.v1.NotificationService/CreateNotification:\n post:\n tags:\n - NotificationService\n summary: CreateNotification\n description: CreateNotification creates a new notification channel.\n operationId: NotificationService_CreateNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/DeleteNotification:\n post:\n tags:\n - NotificationService\n summary: DeleteNotification\n description: DeleteNotification removes a notification channel.\n operationId: NotificationService_DeleteNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/GetNotification:\n get:\n tags:\n - NotificationService\n summary: GetNotification\n description: GetNotification retrieves a notification channel by ID.\n operationId: NotificationService_GetNotification.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'\n post:\n tags:\n - NotificationService\n summary: GetNotification\n description: GetNotification retrieves a notification channel by ID.\n operationId: NotificationService_GetNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/ListNotifications:\n get:\n tags:\n - NotificationService\n summary: ListNotifications\n description: ListNotifications returns a list of notification channels.\n operationId: NotificationService_ListNotifications.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'\n post:\n tags:\n - NotificationService\n summary: ListNotifications\n description: ListNotifications returns a list of notification channels.\n operationId: NotificationService_ListNotifications\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'\n /rpc/openstatus.notification.v1.NotificationService/SendTestNotification:\n post:\n tags:\n - NotificationService\n summary: SendTestNotification\n description: Sends a test notification to the specified provider to verify that the configuration is correct. This does not require an existing notification channel - just provide the provider type and its configuration data. Returns success status and an error message if the test failed.\n operationId: NotificationService_SendTestNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/UpdateNotification:\n post:\n tags:\n - NotificationService\n summary: UpdateNotification\n description: UpdateNotification updates an existing notification channel.\n operationId: NotificationService_UpdateNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/CreatePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: CreatePrivateLocation\n description: Creates a private location. The agent token is generated by the server and returned in the response - it cannot be supplied by the caller. Use the token to configure the agent so it can pull its monitors and report results.\n operationId: PrivateLocationService_CreatePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/DeletePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: DeletePrivateLocation\n description: DeletePrivateLocation removes a private location.\n operationId: PrivateLocationService_DeletePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/GetPrivateLocation:\n get:\n tags:\n - PrivateLocationService\n summary: GetPrivateLocation\n description: |-\n GetPrivateLocation retrieves a single private location by ID, including\n its agent token.\n operationId: PrivateLocationService_GetPrivateLocation.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'\n post:\n tags:\n - PrivateLocationService\n summary: GetPrivateLocation\n description: |-\n GetPrivateLocation retrieves a single private location by ID, including\n its agent token.\n operationId: PrivateLocationService_GetPrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/ListPrivateLocations:\n get:\n tags:\n - PrivateLocationService\n summary: ListPrivateLocations\n description: |-\n ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.\n operationId: PrivateLocationService_ListPrivateLocations.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'\n post:\n tags:\n - PrivateLocationService\n summary: ListPrivateLocations\n description: |-\n ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.\n operationId: PrivateLocationService_ListPrivateLocations\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/UpdatePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: UpdatePrivateLocation\n description: UpdatePrivateLocation updates a private location.\n operationId: PrivateLocationService_UpdatePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/AddMonitorComponent:\n post:\n tags:\n - StatusPageService\n summary: AddMonitorComponent\n description: AddMonitorComponent adds a monitor-based component to a status page.\n operationId: StatusPageService_AddMonitorComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/AddStaticComponent:\n post:\n tags:\n - StatusPageService\n summary: AddStaticComponent\n description: AddStaticComponent adds a static component to a status page.\n operationId: StatusPageService_AddStaticComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreateComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: CreateComponentGroup\n description: CreateComponentGroup creates a new component group.\n operationId: StatusPageService_CreateComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreatePageSubscription:\n post:\n tags:\n - StatusPageService\n summary: 'CreatePageSubscription: operator-added subscriber (email or webhook), no verification.'\n description: Operator-added subscriber (email or webhook) with no verification flow — the partner starts receiving notifications immediately. Supports Slack and Discord webhook URLs in addition to email. A management token is still generated so the subscriber can self-manage (update scope, unsubscribe) without operator involvement. Use this for vendor/partner integrations where consent is established out-of-band; use SubscribeToPage for subscriber-initiated signups that require double opt-in.\n operationId: StatusPageService_CreatePageSubscription\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreateStatusPage:\n post:\n tags:\n - StatusPageService\n summary: CreateStatusPage\n description: CreateStatusPage creates a new status page.\n operationId: StatusPageService_CreateStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/DeleteComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: DeleteComponentGroup\n description: DeleteComponentGroup removes a component group.\n operationId: StatusPageService_DeleteComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/DeleteStatusPage:\n post:\n tags:\n - StatusPageService\n summary: DeleteStatusPage\n description: DeleteStatusPage removes a status page.\n operationId: StatusPageService_DeleteStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetOverallStatus:\n get:\n tags:\n - StatusPageService\n summary: GetOverallStatus\n description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'\n operationId: StatusPageService_GetOverallStatus.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'\n post:\n tags:\n - StatusPageService\n summary: GetOverallStatus\n description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'\n operationId: StatusPageService_GetOverallStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetPageComponent:\n get:\n tags:\n - StatusPageService\n summary: GetPageComponent\n description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.\n operationId: StatusPageService_GetPageComponent.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'\n post:\n tags:\n - StatusPageService\n summary: GetPageComponent\n description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.\n operationId: StatusPageService_GetPageComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetPageComponentDailySummary:\n get:\n tags:\n - StatusPageService\n summary: GetPageComponentDailySummary\n description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetPageComponentDailySummary.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'\n post:\n tags:\n - StatusPageService\n summary: GetPageComponentDailySummary\n description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetPageComponentDailySummary\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPage:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPage\n description: GetStatusPage retrieves a specific status page by ID.\n operationId: StatusPageService_GetStatusPage.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPage\n description: GetStatusPage retrieves a specific status page by ID.\n operationId: StatusPageService_GetStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageContent:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPageContent\n description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetStatusPageContent.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPageContent\n description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetStatusPageContent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageOverview:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPageOverview\n description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'\n operationId: StatusPageService_GetStatusPageOverview.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPageOverview\n description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'\n operationId: StatusPageService_GetStatusPageOverview\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/ListStatusPages:\n get:\n tags:\n - StatusPageService\n summary: ListStatusPages\n description: ListStatusPages returns all status pages for the workspace.\n operationId: StatusPageService_ListStatusPages.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'\n post:\n tags:\n - StatusPageService\n summary: ListStatusPages\n description: ListStatusPages returns all status pages for the workspace.\n operationId: StatusPageService_ListStatusPages\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/ListSubscribers:\n get:\n tags:\n - StatusPageService\n summary: ListSubscribers\n description: ListSubscribers returns all subscribers for a status page.\n operationId: StatusPageService_ListSubscribers.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'\n post:\n tags:\n - StatusPageService\n summary: ListSubscribers\n description: ListSubscribers returns all subscribers for a status page.\n operationId: StatusPageService_ListSubscribers\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/RemoveComponent:\n post:\n tags:\n - StatusPageService\n summary: RemoveComponent\n description: RemoveComponent removes a component from a status page.\n operationId: StatusPageService_RemoveComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/SubscribeToPage:\n post:\n tags:\n - StatusPageService\n summary: 'SubscribeToPage: end-user email self-signup with double opt-in verification.'\n description: End-user email self-signup with double opt-in verification. A verification email is sent and the subscription activates only after the recipient confirms. If the email was previously unsubscribed, the existing row is reactivated instead of a duplicate being created. Use this for subscriber-initiated signups on the public status page; use CreatePageSubscription for operator-initiated (vendor) subscriptions that should skip verification.\n operationId: StatusPageService_SubscribeToPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UnsubscribeFromPage:\n post:\n tags:\n - StatusPageService\n summary: UnsubscribeFromPage\n description: UnsubscribeFromPage removes a subscription from a status page.\n operationId: StatusPageService_UnsubscribeFromPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateComponent:\n post:\n tags:\n - StatusPageService\n summary: UpdateComponent\n description: UpdateComponent updates an existing component.\n operationId: StatusPageService_UpdateComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: UpdateComponentGroup\n description: UpdateComponentGroup updates an existing component group.\n operationId: StatusPageService_UpdateComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateStatusPage:\n post:\n tags:\n - StatusPageService\n summary: UpdateStatusPage\n description: UpdateStatusPage updates an existing status page.\n operationId: StatusPageService_UpdateStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/AddStatusReportUpdate:\n post:\n tags:\n - StatusReportService\n summary: AddStatusReportUpdate\n description: 'Adds a new update entry to an existing status report and transitions the report to the specified status. Status reports follow a lifecycle: investigating -> identified -> monitoring -> resolved. If notify is true, subscribers of the associated page are notified by email about the update.'\n operationId: StatusReportService_AddStatusReportUpdate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/CreateStatusReport:\n post:\n tags:\n - StatusReportService\n summary: CreateStatusReport\n description: Creates a new status report with an initial update entry. The report is associated with a status page and optionally specific page components. An initial StatusReportUpdate is created automatically with the provided status, message, and date. If notify is true, subscribers of the associated page are notified by email.\n operationId: StatusReportService_CreateStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/DeleteStatusReport:\n post:\n tags:\n - StatusReportService\n summary: DeleteStatusReport\n description: DeleteStatusReport removes a status report and all its updates.\n operationId: StatusReportService_DeleteStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/GetStatusReport:\n get:\n tags:\n - StatusReportService\n summary: GetStatusReport\n description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).\n operationId: StatusReportService_GetStatusReport.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'\n post:\n tags:\n - StatusReportService\n summary: GetStatusReport\n description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).\n operationId: StatusReportService_GetStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/ListStatusReports:\n get:\n tags:\n - StatusReportService\n summary: ListStatusReports\n description: ListStatusReports returns all status reports for the workspace (metadata only).\n operationId: StatusReportService_ListStatusReports.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'\n post:\n tags:\n - StatusReportService\n summary: ListStatusReports\n description: ListStatusReports returns all status reports for the workspace (metadata only).\n operationId: StatusReportService_ListStatusReports\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/UpdateStatusReport:\n post:\n tags:\n - StatusReportService\n summary: UpdateStatusReport\n description: UpdateStatusReport updates the metadata of a status report (title, page components).\n operationId: StatusReportService_UpdateStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportRequest'\n required: true\n responses:\n \"429\":\n $ref: '#/components/responses/RateLimited'\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportResponse'\n";
diff --git a/apps/server/static/openapi.json b/apps/server/static/openapi.json
index 6ecbc28a3..af90039af 100644
--- a/apps/server/static/openapi.json
+++ b/apps/server/static/openapi.json
@@ -158,6 +158,50 @@
],
"description": "ServingStatus represents the health status of the service."
},
+ "openstatus.maintenance.v1.AddMaintenanceUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "maintenanceId": {
+ "type": "string",
+ "title": "maintenance_id",
+ "minLength": 1,
+ "description": "ID of the maintenance to update (required)."
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "minLength": 1,
+ "description": "Public update message (required)."
+ },
+ "date": {
+ "type": ["string", "null"],
+ "title": "date",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "Optional date for the update (RFC 3339 format). Defaults to current time."
+ },
+ "notify": {
+ "type": ["boolean", "null"],
+ "title": "notify",
+ "description": "Whether to notify subscribers about this update."
+ }
+ },
+ "title": "AddMaintenanceUpdateRequest",
+ "additionalProperties": false,
+ "description": "AddMaintenanceUpdateRequest is the request to append a maintenance update."
+ },
+ "openstatus.maintenance.v1.AddMaintenanceUpdateResponse": {
+ "type": "object",
+ "properties": {
+ "maintenanceUpdate": {
+ "title": "maintenance_update",
+ "description": "The created update.",
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate"
+ }
+ },
+ "title": "AddMaintenanceUpdateResponse",
+ "additionalProperties": false,
+ "description": "AddMaintenanceUpdateResponse is the response after appending an update."
+ },
"openstatus.maintenance.v1.CreateMaintenanceRequest": {
"type": "object",
"properties": {
@@ -173,7 +217,7 @@
"type": "string",
"title": "message",
"minLength": 1,
- "description": "Message describing the maintenance (required)."
+ "description": "Message describing the maintenance (required). Posted as the first\n maintenance update."
},
"from": {
"type": "string",
@@ -253,6 +297,33 @@
"additionalProperties": false,
"description": "DeleteMaintenanceResponse is the response after deleting a maintenance window."
},
+ "openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the update to remove (required)."
+ }
+ },
+ "title": "DeleteMaintenanceUpdateRequest",
+ "additionalProperties": false,
+ "description": "DeleteMaintenanceUpdateRequest is the request to remove an update."
+ },
+ "openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteMaintenanceUpdateResponse",
+ "additionalProperties": false,
+ "description": "DeleteMaintenanceUpdateResponse is the response after removing an update."
+ },
"openstatus.maintenance.v1.GetMaintenanceRequest": {
"type": "object",
"properties": {
@@ -346,7 +417,7 @@
"message": {
"type": "string",
"title": "message",
- "description": "Message describing the maintenance."
+ "description": "Message of the newest maintenance update."
},
"from": {
"type": "string",
@@ -380,6 +451,14 @@
"type": "string",
"title": "updated_at",
"description": "Timestamp when the maintenance was last updated (RFC 3339 format)."
+ },
+ "updates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate"
+ },
+ "title": "updates",
+ "description": "Full maintenance update timeline, newest first."
}
},
"title": "Maintenance",
@@ -402,7 +481,7 @@
"message": {
"type": "string",
"title": "message",
- "description": "Message describing the maintenance."
+ "description": "Message of the newest maintenance update."
},
"from": {
"type": "string",
@@ -442,6 +521,44 @@
"additionalProperties": false,
"description": "MaintenanceSummary represents metadata for a maintenance window (used in list responses)."
},
+ "openstatus.maintenance.v1.MaintenanceUpdate": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the update."
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "description": "Public update message."
+ },
+ "date": {
+ "type": "string",
+ "title": "date",
+ "description": "Date of the update (RFC 3339 format)."
+ },
+ "maintenanceId": {
+ "type": "string",
+ "title": "maintenance_id",
+ "description": "ID of the maintenance this update belongs to."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the update was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the update was last updated (RFC 3339 format)."
+ }
+ },
+ "title": "MaintenanceUpdate",
+ "additionalProperties": false,
+ "description": "MaintenanceUpdate represents a timeline entry for a maintenance window."
+ },
"openstatus.maintenance.v1.UpdateMaintenanceRequest": {
"type": "object",
"properties": {
@@ -461,7 +578,7 @@
"message": {
"type": ["string", "null"],
"title": "message",
- "description": "New message for the maintenance (optional)."
+ "description": "Replaces the message of the newest maintenance update (optional)."
},
"from": {
"type": ["string", "null"],
@@ -512,6 +629,45 @@
"additionalProperties": false,
"description": "UpdateMaintenanceResponse is the response after updating a maintenance window."
},
+ "openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the update to edit (required)."
+ },
+ "message": {
+ "type": ["string", "null"],
+ "title": "message",
+ "minLength": 1,
+ "description": "New public message."
+ },
+ "date": {
+ "type": ["string", "null"],
+ "title": "date",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "New update date (RFC 3339 format)."
+ }
+ },
+ "title": "UpdateMaintenanceUpdateRequest",
+ "additionalProperties": false,
+ "description": "UpdateMaintenanceUpdateRequest is the request to edit an update."
+ },
+ "openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse": {
+ "type": "object",
+ "properties": {
+ "maintenanceUpdate": {
+ "title": "maintenance_update",
+ "description": "The updated timeline entry.",
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate"
+ }
+ },
+ "title": "UpdateMaintenanceUpdateResponse",
+ "additionalProperties": false,
+ "description": "UpdateMaintenanceUpdateResponse is the response after editing an update."
+ },
"openstatus.monitor.v1.BodyAssertion": {
"type": "object",
"properties": {
@@ -6229,6 +6385,49 @@
}
}
},
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/AddMaintenanceUpdate": {
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "AddMaintenanceUpdate",
+ "description": "AddMaintenanceUpdate appends a public update to a maintenance timeline.",
+ "operationId": "MaintenanceService_AddMaintenanceUpdate",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateResponse"
+ }
+ }
+ }
+ },
+ "429": {
+ "$ref": "#/components/responses/RateLimited"
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance": {
"post": {
"tags": ["MaintenanceService"],
@@ -6315,6 +6514,49 @@
}
}
},
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenanceUpdate": {
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "DeleteMaintenanceUpdate",
+ "description": "DeleteMaintenanceUpdate removes an existing maintenance update.",
+ "operationId": "MaintenanceService_DeleteMaintenanceUpdate",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse"
+ }
+ }
+ }
+ },
+ "429": {
+ "$ref": "#/components/responses/RateLimited"
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance": {
"get": {
"tags": ["MaintenanceService"],
@@ -6532,6 +6774,49 @@
}
}
},
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenanceUpdate": {
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "UpdateMaintenanceUpdate",
+ "description": "UpdateMaintenanceUpdate edits an existing maintenance update.",
+ "operationId": "MaintenanceService_UpdateMaintenanceUpdate",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse"
+ }
+ }
+ }
+ },
+ "429": {
+ "$ref": "#/components/responses/RateLimited"
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor": {
"post": {
"tags": ["MonitorService"],
diff --git a/apps/server/static/openapi.yaml b/apps/server/static/openapi.yaml
index 6ae80571d..047485093 100644
--- a/apps/server/static/openapi.yaml
+++ b/apps/server/static/openapi.yaml
@@ -118,6 +118,45 @@ components:
- SERVING_STATUS_SERVING
- SERVING_STATUS_NOT_SERVING
description: ServingStatus represents the health status of the service.
+ openstatus.maintenance.v1.AddMaintenanceUpdateRequest:
+ type: object
+ properties:
+ maintenanceId:
+ type: string
+ title: maintenance_id
+ minLength: 1
+ description: ID of the maintenance to update (required).
+ message:
+ type: string
+ title: message
+ minLength: 1
+ description: Public update message (required).
+ date:
+ type:
+ - string
+ - "null"
+ title: date
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
+ description: Optional date for the update (RFC 3339 format). Defaults to current time.
+ notify:
+ type:
+ - boolean
+ - "null"
+ title: notify
+ description: Whether to notify subscribers about this update.
+ title: AddMaintenanceUpdateRequest
+ additionalProperties: false
+ description: AddMaintenanceUpdateRequest is the request to append a maintenance update.
+ openstatus.maintenance.v1.AddMaintenanceUpdateResponse:
+ type: object
+ properties:
+ maintenanceUpdate:
+ title: maintenance_update
+ description: The created update.
+ $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
+ title: AddMaintenanceUpdateResponse
+ additionalProperties: false
+ description: AddMaintenanceUpdateResponse is the response after appending an update.
openstatus.maintenance.v1.CreateMaintenanceRequest:
type: object
properties:
@@ -133,7 +172,9 @@ components:
type: string
title: message
minLength: 1
- description: Message describing the maintenance (required).
+ description: |-
+ Message describing the maintenance (required). Posted as the first
+ maintenance update.
from:
type: string
examples:
@@ -199,6 +240,27 @@ components:
title: DeleteMaintenanceResponse
additionalProperties: false
description: DeleteMaintenanceResponse is the response after deleting a maintenance window.
+ openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ title: id
+ minLength: 1
+ description: ID of the update to remove (required).
+ title: DeleteMaintenanceUpdateRequest
+ additionalProperties: false
+ description: DeleteMaintenanceUpdateRequest is the request to remove an update.
+ openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse:
+ type: object
+ properties:
+ success:
+ type: boolean
+ title: success
+ description: Whether the deletion was successful.
+ title: DeleteMaintenanceUpdateResponse
+ additionalProperties: false
+ description: DeleteMaintenanceUpdateResponse is the response after removing an update.
openstatus.maintenance.v1.GetMaintenanceRequest:
type: object
properties:
@@ -280,7 +342,7 @@ components:
message:
type: string
title: message
- description: Message describing the maintenance.
+ description: Message of the newest maintenance update.
from:
type: string
title: from
@@ -307,6 +369,12 @@ components:
type: string
title: updated_at
description: Timestamp when the maintenance was last updated (RFC 3339 format).
+ updates:
+ type: array
+ items:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
+ title: updates
+ description: Full maintenance update timeline, newest first.
title: Maintenance
additionalProperties: false
description: Maintenance represents a maintenance window with full details.
@@ -324,7 +392,7 @@ components:
message:
type: string
title: message
- description: Message describing the maintenance.
+ description: Message of the newest maintenance update.
from:
type: string
title: from
@@ -354,6 +422,36 @@ components:
title: MaintenanceSummary
additionalProperties: false
description: MaintenanceSummary represents metadata for a maintenance window (used in list responses).
+ openstatus.maintenance.v1.MaintenanceUpdate:
+ type: object
+ properties:
+ id:
+ type: string
+ title: id
+ description: Unique identifier for the update.
+ message:
+ type: string
+ title: message
+ description: Public update message.
+ date:
+ type: string
+ title: date
+ description: Date of the update (RFC 3339 format).
+ maintenanceId:
+ type: string
+ title: maintenance_id
+ description: ID of the maintenance this update belongs to.
+ createdAt:
+ type: string
+ title: created_at
+ description: Timestamp when the update was created (RFC 3339 format).
+ updatedAt:
+ type: string
+ title: updated_at
+ description: Timestamp when the update was last updated (RFC 3339 format).
+ title: MaintenanceUpdate
+ additionalProperties: false
+ description: MaintenanceUpdate represents a timeline entry for a maintenance window.
openstatus.maintenance.v1.UpdateMaintenanceRequest:
type: object
properties:
@@ -375,7 +473,7 @@ components:
- string
- "null"
title: message
- description: New message for the maintenance (optional).
+ description: Replaces the message of the newest maintenance update (optional).
from:
type:
- string
@@ -425,6 +523,41 @@ components:
title: UpdateMaintenanceResponse
additionalProperties: false
description: UpdateMaintenanceResponse is the response after updating a maintenance window.
+ openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ title: id
+ minLength: 1
+ description: ID of the update to edit (required).
+ message:
+ type:
+ - string
+ - "null"
+ title: message
+ minLength: 1
+ description: New public message.
+ date:
+ type:
+ - string
+ - "null"
+ title: date
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
+ description: New update date (RFC 3339 format).
+ title: UpdateMaintenanceUpdateRequest
+ additionalProperties: false
+ description: UpdateMaintenanceUpdateRequest is the request to edit an update.
+ openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse:
+ type: object
+ properties:
+ maintenanceUpdate:
+ title: maintenance_update
+ description: The updated timeline entry.
+ $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
+ title: UpdateMaintenanceUpdateResponse
+ additionalProperties: false
+ description: UpdateMaintenanceUpdateResponse is the response after editing an update.
openstatus.monitor.v1.BodyAssertion:
type: object
properties:
@@ -5205,6 +5338,34 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/openstatus.health.v1.CheckResponse'
+ /rpc/openstatus.maintenance.v1.MaintenanceService/AddMaintenanceUpdate:
+ post:
+ tags:
+ - MaintenanceService
+ summary: AddMaintenanceUpdate
+ description: AddMaintenanceUpdate appends a public update to a maintenance timeline.
+ operationId: MaintenanceService_AddMaintenanceUpdate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateRequest'
+ required: true
+ responses:
+ "429":
+ $ref: '#/components/responses/RateLimited'
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance:
post:
tags:
@@ -5261,6 +5422,34 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse'
+ /rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenanceUpdate:
+ post:
+ tags:
+ - MaintenanceService
+ summary: DeleteMaintenanceUpdate
+ description: DeleteMaintenanceUpdate removes an existing maintenance update.
+ operationId: MaintenanceService_DeleteMaintenanceUpdate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest'
+ required: true
+ responses:
+ "429":
+ $ref: '#/components/responses/RateLimited'
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance:
get:
tags:
@@ -5401,6 +5590,34 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse'
+ /rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenanceUpdate:
+ post:
+ tags:
+ - MaintenanceService
+ summary: UpdateMaintenanceUpdate
+ description: UpdateMaintenanceUpdate edits an existing maintenance update.
+ operationId: MaintenanceService_UpdateMaintenanceUpdate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest'
+ required: true
+ responses:
+ "429":
+ $ref: '#/components/responses/RateLimited'
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor:
post:
tags:
diff --git a/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/client.tsx b/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/client.tsx
index fe96f103d..5d80fbcb2 100644
--- a/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/client.tsx
+++ b/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/client.tsx
@@ -253,6 +253,14 @@ export function Client() {
(maintenance) => maintenance.id === e.id,
);
if (!maintenance) return null;
+ // banner shows only the newest update; the block renders a
+ // single update as the body under the title
+ const lastUpdate = [
+ ...(maintenance.maintenanceUpdates ?? []),
+ ].sort(
+ (a, b) =>
+ b.date.getTime() - a.date.getTime() || b.id - a.id,
+ )[0];
return (
<StatusBannerTabsContent
value={`${e.type}-${e.id}`}
@@ -266,7 +274,12 @@ export function Client() {
<StatusBannerContainer status={e.status}>
<StatusBannerContent>
<StatusEventTimelineMaintenance
- maintenance={maintenance}
+ maintenance={{
+ ...maintenance,
+ maintenanceUpdates: lastUpdate
+ ? [lastUpdate]
+ : [],
+ }}
withDot={false}
/>
{maintenance.maintenancesToPageComponents.length >
diff --git a/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/[type]/route.ts b/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/[type]/route.ts
index 8010bbb80..a683e3688 100644
--- a/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/[type]/route.ts
+++ b/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/[type]/route.ts
@@ -84,11 +84,19 @@ export async function GET(
for (const maintenance of page.maintenances ?? []) {
const maintenanceUrl = `${baseUrl}/events/maintenance/${maintenance.id}`;
+ const updates = [...(maintenance.maintenanceUpdates ?? [])].sort(
+ (a, b) => b.date.getTime() - a.date.getTime() || b.id - a.id,
+ );
+ const description = updates.length
+ ? updates
+ .map((update) => `${update.date.toISOString()}: ${update.message}`)
+ .join("\n\n")
+ : maintenance.message;
feed.addItem({
id: maintenanceUrl,
title: `${statusLabel("maintenance")} - ${maintenance.title}`,
link: maintenanceUrl,
- description: maintenance.message,
+ description,
date: maintenance.updatedAt ?? maintenance.createdAt ?? new Date(),
});
}
diff --git a/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/json/route.ts b/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/json/route.ts
index 0584a2532..8ca010ae7 100644
--- a/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/json/route.ts
+++ b/apps/status-page/src/app/(status-page)/[domain]/[locale]/(public)/feed/json/route.ts
@@ -74,22 +74,34 @@ export async function GET(
id: group.id,
name: group.name,
})),
- maintenances: page.maintenances.map((maintenance) => ({
- id: maintenance.id,
- name: maintenance.title,
- message: maintenance.message,
- from: maintenance.from,
- to: maintenance.to,
- updatedAt: maintenance.updatedAt,
- // @deprecated Use components instead - returning monitor IDs for backwards compatibility
- monitors: maintenance.maintenancesToPageComponents
- .map((item) => item.pageComponent.monitorId)
- .filter((id): id is number => id !== null),
- // New field - references page component IDs
- pageComponents: maintenance.maintenancesToPageComponents.map(
- (item) => item.pageComponentId,
- ),
- })),
+ maintenances: page.maintenances.map((maintenance) => {
+ const updates = [...(maintenance.maintenanceUpdates ?? [])].sort(
+ (a, b) => b.date.getTime() - a.date.getTime() || b.id - a.id,
+ );
+ return {
+ id: maintenance.id,
+ name: maintenance.title,
+ // @deprecated Use maintenanceUpdates instead - returning the newest update's message for backwards compatibility
+ message: updates[0]?.message ?? maintenance.message,
+ maintenanceUpdates: updates.map((update) => ({
+ id: update.id,
+ message: update.message,
+ date: update.date,
+ updatedAt: update.updatedAt,
+ })),
+ from: maintenance.from,
+ to: maintenance.to,
+ updatedAt: maintenance.updatedAt,
+ // @deprecated Use components instead - returning monitor IDs for backwards compatibility
+ monitors: maintenance.maintenancesToPageComponents
+ .map((item) => item.pageComponent.monitorId)
+ .filter((id): id is number => id !== null),
+ // New field - references page component IDs
+ pageComponents: maintenance.maintenancesToPageComponents.map(
+ (item) => item.pageComponentId,
+ ),
+ };
+ }),
statusReports: page.statusReports.map((report) => ({
id: report.id,
title: report.title,
diff --git a/apps/status-page/src/content/markdown/generators.test.ts b/apps/status-page/src/content/markdown/generators.test.ts
index 06399bfcb..bef405019 100644
--- a/apps/status-page/src/content/markdown/generators.test.ts
+++ b/apps/status-page/src/content/markdown/generators.test.ts
@@ -539,6 +539,29 @@ describe("generateMaintenance", () => {
expect(withUrls).toContain('contact_url: "mailto:[email protected]"');
});
+ test("renders updates newest-first instead of the deprecated message", () => {
+ const withUpdates = {
+ ...maintenance,
+ maintenanceUpdates: [
+ {
+ date: new Date("2026-06-20T00:15:00.000Z"),
+ message: "Work started.",
+ },
+ {
+ date: new Date("2026-06-20T00:45:00.000Z"),
+ message: "Work completed.",
+ },
+ ],
+ } as unknown as MaintenanceDetail;
+ const out = generateMaintenance(withUpdates, BASE);
+ expect(out).not.toContain("## Details");
+ expect(out).not.toContain("Brief downtime.");
+ expect(out).toContain("## Updates");
+ expect(out.indexOf("Work completed.")).toBeLessThan(
+ out.indexOf("Work started."),
+ );
+ });
+
test("null `to` renders 'ongoing', not a bogus duration", () => {
const openEnded = {
...maintenance,
diff --git a/apps/status-page/src/content/markdown/generators.ts b/apps/status-page/src/content/markdown/generators.ts
index 101c3e838..57e2d00c2 100644
--- a/apps/status-page/src/content/markdown/generators.ts
+++ b/apps/status-page/src/content/markdown/generators.ts
@@ -52,6 +52,17 @@ function avg(values: number[]): number | null {
return values.reduce((a, b) => a + b, 0) / values.length;
}
+// Dates have second precision, so the id breaks ties.
+function newestMaintenanceUpdates<
+ T extends { date: Date | string | number; id?: number },
+>(updates: T[] | undefined): T[] {
+ return [...(updates ?? [])].sort(
+ (a, b) =>
+ new Date(b.date).getTime() - new Date(a.date).getTime() ||
+ (b.id ?? 0) - (a.id ?? 0),
+ );
+}
+
export function generateOverview(
page: OverviewPage,
components: UptimeComponent[],
@@ -144,7 +155,11 @@ export function generateOverview(
mdUrl(`events/maintenance/${m.id}`),
].filter(Boolean);
out.push(head.join(" · "));
- if (m.message) out.push(` ${m.message}`);
+ const updates = newestMaintenanceUpdates(m.maintenanceUpdates);
+ if (updates.length === 0 && m.message) out.push(` ${m.message}`);
+ for (const update of updates) {
+ out.push(` - ${formatDayTime(update.date)} — ${update.message}`);
+ }
}
out.push("");
}
@@ -339,6 +354,15 @@ export function generateEventsList(
ref: `maintenance/${m.id}`,
title: m.title,
});
+ for (const update of newestMaintenanceUpdates(m.maintenanceUpdates)) {
+ logRows.push({
+ timestamp: update.date,
+ label: "MAINTENANCE",
+ glyph: statusGlyph("info"),
+ ref: `maintenance/${m.id}`,
+ title: m.title,
+ });
+ }
// Only log a COMPLETED entry once the window has actually ended. (`m.to`
// is non-null per schema; the truthy check is just defensive.)
if (m.to && new Date(m.to).getTime() <= now) {
@@ -436,6 +460,13 @@ export function generateEventsList(
`### [${escapeLinkLabel(m.title)}](${mdUrl(`events/maintenance/${m.id}`)})`,
);
out.push(meta.join(" · "));
+ const updates = newestMaintenanceUpdates(m.maintenanceUpdates);
+ if (updates.length === 0 && m.message) out.push(m.message);
+ for (const update of updates) {
+ // indent continuation lines so a blank line does not end the item
+ const message = update.message.replace(/\n/g, "\n ");
+ out.push(`- ${formatDayTime(update.date)} — ${message}`);
+ }
out.push("");
}
}
@@ -561,8 +592,19 @@ export function generateMaintenance(
out.push(`**Affected components:** ${components.join(", ")}\n`);
}
- out.push("## Details\n");
- out.push(`${maintenance.message}\n`);
+ // the oldest update is the announcement; `message` only serves rows that
+ // predate the timeline
+ const updates = newestMaintenanceUpdates(maintenance.maintenanceUpdates);
+ if (updates.length > 0) {
+ out.push("## Updates\n");
+ for (const update of updates) {
+ out.push(`### ${formatDayTime(update.date)}\n`);
+ out.push(`${update.message}\n`);
+ }
+ } else {
+ out.push("## Details\n");
+ out.push(`${maintenance.message}\n`);
+ }
return `${out.join("\n").trimEnd()}\n`;
}
diff --git a/apps/status-page/src/content/status-json.test.ts b/apps/status-page/src/content/status-json.test.ts
index d0fe2da19..37931027d 100644
--- a/apps/status-page/src/content/status-json.test.ts
+++ b/apps/status-page/src/content/status-json.test.ts
@@ -96,6 +96,12 @@ const page = {
title: "DB upgrade",
from: new Date("2026-06-20T00:00:00.000Z"),
to: new Date("2026-06-20T01:00:00.000Z"),
+ maintenanceUpdates: [
+ {
+ message: "Upgrade scheduled.",
+ date: new Date("2026-06-19T12:00:00.000Z"),
+ },
+ ],
},
],
} as unknown as Page;
@@ -143,6 +149,12 @@ describe("toSummary", () => {
status: "scheduled",
scheduled_for: "2026-06-20T00:00:00.000Z",
});
+ expect(summary.scheduled_maintenances[0].maintenance_updates).toEqual([
+ {
+ body: "Upgrade scheduled.",
+ created_at: "2026-06-19T12:00:00.000Z",
+ },
+ ]);
});
});
diff --git a/apps/status-page/src/content/status-json.ts b/apps/status-page/src/content/status-json.ts
index 62f325cbb..4a8dceced 100644
--- a/apps/status-page/src/content/status-json.ts
+++ b/apps/status-page/src/content/status-json.ts
@@ -84,6 +84,12 @@ function scheduledMaintenances(page: Page, now: number) {
status: maintenanceState(m.from, now),
scheduled_for: isoOrNull(m.from),
scheduled_until: isoOrNull(m.to),
+ maintenance_updates: [...(m.maintenanceUpdates ?? [])]
+ .sort((a, b) => b.date.getTime() - a.date.getTime() || b.id - a.id)
+ .map((update) => ({
+ body: update.message,
+ created_at: isoOrNull(update.date),
+ })),
}));
}
diff --git a/apps/web/src/content/pages/docs/reference/maintenance.mdx b/apps/web/src/content/pages/docs/reference/maintenance.mdx
index f8dc84bc5..6b6ce53bd 100644
--- a/apps/web/src/content/pages/docs/reference/maintenance.mdx
+++ b/apps/web/src/content/pages/docs/reference/maintenance.mdx
@@ -35,7 +35,7 @@ A short, human-readable name for the maintenance window.
**Type:** String (required)
-A description of the maintenance shown to users, explaining what is happening and the expected impact.
+The text shown to users, explaining what is happening and the expected impact. On create it is posted as the first [update](#updates); on read it is the message of the newest update; on update it rewrites the newest update. New timeline entries are added through the update endpoints, not through this field.
**Example:** `"Upgrading our database to improve performance. Brief interruptions may occur."`
@@ -77,6 +77,16 @@ A one-time flag evaluated at creation time — it is **not** stored on the maint
The v1 REST API does not expose this flag; it notifies subscribers automatically when a maintenance is created on a page whose workspace has subscribers enabled.
+## Updates
+
+A maintenance is a timeline of dated notes. The first one is the announcement written at creation, later ones track progress, for example "Work started", "Taking longer than expected" or "Completed early". Each update has:
+
+- **Message** — String (required). The note shown on the status page.
+- **Date** — Datetime (optional). When the note applies. Defaults to the time it is posted.
+- **Notify** — Boolean (optional, write-only). Sends the note to status page subscribers.
+
+A maintenance always keeps at least one update: deleting the last one is rejected, delete the maintenance instead. Reads return them newest-first under `updates` (RPC, agent tools) or `maintenanceUpdates` (status page JSON). The public status page, feeds and Markdown render the updates in order, oldest first on the page.
+
## Relationships
- **Status page** — a maintenance is tied to a single page. Deleting the page deletes its maintenance windows.
diff --git a/apps/web/src/content/pages/docs/reference/mcp-server.mdx b/apps/web/src/content/pages/docs/reference/mcp-server.mdx
index e3e1ec2bc..6152d8e08 100644
--- a/apps/web/src/content/pages/docs/reference/mcp-server.mdx
+++ b/apps/web/src/content/pages/docs/reference/mcp-server.mdx
@@ -62,7 +62,7 @@ For AI agents that should only observe state — health summaries, paging on-cal
## Tools
-The server exposes 23 tools (21 on plans without the `audit-log` feature), grouped by resource: 19 scoped to the workspace tied to your credential, plus 4 public content tools that read openstatus.dev pages on any credential and any scope (see [Content](#content)). Workspaces with incident management enabled get 10 more (see [Incidents](#incidents)). Mutations write to the audit log with `actor_type = "mcp"` (see [Audit log](#audit-log)).
+The server exposes 26 tools (24 on plans without the `audit-log` feature), grouped by resource: 22 scoped to the workspace tied to your credential, plus 4 public content tools that read openstatus.dev pages on any credential and any scope (see [Content](#content)). Workspaces with incident management enabled get 10 more (see [Incidents](#incidents)). Mutations write to the audit log with `actor_type = "mcp"` (see [Audit log](#audit-log)).
### Pages
@@ -87,6 +87,9 @@ The server exposes 23 tools (21 on plans without the `audit-log` feature), group
|----------------------|----------|---------|
| `list_maintenances` | read | List maintenance windows newest-first. Paginated via `page` (1-indexed) and `perPage`; response carries a `pagination` object with `page`, `perPage`, `totalSize`, and `totalPages`. |
| `create_maintenance` | mutation | Schedule a maintenance window (`from` / `to` are ISO 8601 strings). |
+| `add_maintenance_update` | mutation | Post a dated progress note on a maintenance window (`date` optional, defaults to now). |
+| `update_maintenance_update` | mutation | Edit the message or date of an existing note. |
+| `delete_maintenance_update` | mutation | Remove a note. The window and its announcement stay. |
### Incidents
@@ -167,7 +170,7 @@ the read returns a short pointer back to the same URI rather than a blank body.
### Notifying subscribers
-Every publishing tool — `create_status_report`, `add_status_report_update`, `resolve_status_report`, `create_maintenance` — has a **required** `notify: boolean` field, with no default. The tool's input schema rejects calls that omit it, which forces the LLM to make an explicit choice (and therefore ask the user) before firing. `update_status_report` edits metadata only and carries no `notify` field at all.
+Every publishing tool — `create_status_report`, `add_status_report_update`, `resolve_status_report`, `create_maintenance`, `add_maintenance_update` — has a **required** `notify: boolean` field, with no default. The tool's input schema rejects calls that omit it, which forces the LLM to make an explicit choice (and therefore ask the user) before firing. `update_status_report` edits metadata only and carries no `notify` field at all.
This required-field behaviour is specific to MCP. The dashboard AI assistant and the Slack agent wrap these same tools in an approval step that strips `notify` from the model-facing schema and injects it from a human toggle defaulting to `false`. MCP exposes the raw schema, so the caller must supply `notify` explicitly.
@@ -175,7 +178,7 @@ Notifications dispatch as part of the same call. There is no separate notify too
The mutation and the notify dispatch are sequential, not transactional. The mutation persists first; if the notify step then throws (transient provider issue, partial outage of an integration), the response carries `notified: false` and the row stays.
-`notified: true` means the dispatch call returned without throwing — **not** that every subscriber received a message. If the workspace plan doesn't include subscriber notifications, the service is a silent no-op and the response will still report `notified: true`. Treat the field as "the dispatch ran cleanly," not as a delivery receipt.
+`notified: true` means the dispatch call returned without throwing — **not** that every subscriber received a message. If the workspace plan doesn't include subscriber notifications, the service is a no-op: the maintenance tools report `notified: false`, the status report tools still report `notified: true`. Treat the field as "the dispatch ran cleanly," not as a delivery receipt.
| Tool | What `notify: true` sends |
|----------------------------|---------------------------|
@@ -183,6 +186,7 @@ The mutation and the notify dispatch are sequential, not transactional. The muta
| `add_status_report_update` | Notification for the new update |
| `resolve_status_report` | Resolution notification |
| `create_maintenance` | Maintenance scheduled notification |
+| `add_maintenance_update` | Notification for the new note |
| `update_status_report` | n/a — metadata-only edit, never has a notify path |
The required `notify` field, combined with the mandatory draft-and-confirm workflow in each tool's description, encodes the contract that LLMs must:
diff --git a/deno.lock b/deno.lock
index 212bdcce3..c4704b002 100644
--- a/deno.lock
+++ b/deno.lock
@@ -58,264 +58,6 @@
"dependencies": [
]
- },
- "members": {
- "apps/dashboard": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "apps/server": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "apps/status-page": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "apps/web": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/ai": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/api": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/db": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/emails": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/header-analysis": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/importers": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/base": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/bird-whatsapp": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/discord": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/google-chat": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/grafana-oncall": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/ms-teams": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/ntfy": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/opsgenie": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/pagerduty": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/slack": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/telegram": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/twillio-sms": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/notifications/webhook": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/services": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/status-fetcher": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/subscriptions": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/test-utils": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/theme-store": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/tinybird": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/tracker": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/upstash": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- },
- "packages/utils": {
- "packageJson": {
- "dependencies": [
- "npm:@jsr/std__expect@^1.0.19",
- "npm:@jsr/std__testing@^1.0.19"
- ]
- }
- }
}
}
}
diff --git a/packages/analytics/src/events.ts b/packages/analytics/src/events.ts
index a9cae7bb6..32e577799 100644
--- a/packages/analytics/src/events.ts
+++ b/packages/analytics/src/events.ts
@@ -120,6 +120,18 @@ export const Events = {
name: "maintenance_deleted",
channel: "maintenance",
},
+ CreateMaintenanceUpdate: {
+ name: "maintenance_update_created",
+ channel: "maintenance",
+ },
+ UpdateMaintenanceUpdate: {
+ name: "maintenance_update_updated",
+ channel: "maintenance",
+ },
+ DeleteMaintenanceUpdate: {
+ name: "maintenance_update_deleted",
+ channel: "maintenance",
+ },
NotifyMaintenance: {
name: "maintenance_notified",
channel: "maintenance",
diff --git a/packages/api/src/router/maintenance.test.ts b/packages/api/src/router/maintenance.test.ts
index 4917f6fd1..52b5ffa79 100644
--- a/packages/api/src/router/maintenance.test.ts
+++ b/packages/api/src/router/maintenance.test.ts
@@ -1,6 +1,7 @@
import { db, eq } from "@openstatus/db";
import {
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
page,
pageComponent,
@@ -24,6 +25,7 @@ let otherWorkspaceComponentId: number;
// inherit its actor attribution. See packages/services/AGENTS.md.
const createdMaintenanceIds: number[] = [];
const updatedMaintenanceIds: number[] = [];
+const createdMaintenanceUpdateIds: number[] = [];
beforeAll(async () => {
const p = await db
@@ -105,6 +107,12 @@ afterAll(async () => {
entityIds: updatedMaintenanceIds,
});
}
+ if (createdMaintenanceUpdateIds.length > 0) {
+ await clearAuditLogFor({
+ entityType: "maintenance_update",
+ entityIds: createdMaintenanceUpdateIds,
+ });
+ }
});
test("maintenance.update rejects maintenance from another workspace", async () => {
@@ -120,7 +128,6 @@ test("maintenance.update rejects maintenance from another workspace", async () =
await caller.maintenance.update({
id: otherWorkspaceMaintenanceId,
title: "Unauthorized Modification",
- message: "Should not work",
startDate: new Date(),
endDate: new Date(Date.now() + 3_600_000),
pageComponents: [],
@@ -154,7 +161,6 @@ test("maintenance.update succeeds for own workspace maintenance", async () => {
await caller.maintenance.update({
id: 1,
title: "Updated Maintenance Title",
- message: "Updated message",
startDate: new Date(),
endDate: new Date(Date.now() + 7_200_000),
pageComponents: [1],
@@ -219,3 +225,61 @@ test("maintenance.new succeeds for own workspace page", async () => {
.where(eq(maintenancesToPageComponents.maintenanceId, result.id));
await db.delete(maintenance).where(eq(maintenance.id, result.id));
});
+
+test("maintenance update procedures provide full CRUD", async () => {
+ const ctx = createInnerTRPCContext({
+ req: undefined,
+ session: { user: { id: "1" } },
+ // @ts-expect-error - minimal workspace for test
+ workspace: { id: 1 },
+ });
+ const caller = edgeRouter.createCaller(ctx);
+ const created = await caller.maintenance.new({
+ title: "Maintenance update CRUD",
+ message: "Initial update",
+ pageId: 1,
+ startDate: new Date(),
+ endDate: new Date(Date.now() + 3_600_000),
+ pageComponents: [1],
+ });
+ createdMaintenanceIds.push(created.id);
+
+ const added = await caller.maintenance.createUpdate({
+ maintenanceId: created.id,
+ message: "Second update",
+ date: new Date(),
+ notifySubscribers: true,
+ });
+ createdMaintenanceUpdateIds.push(added.id);
+ expect(added.notifySubscribers).toBe(true);
+
+ const edited = await caller.maintenance.updateUpdate({
+ id: added.id,
+ message: "Edited update",
+ });
+ expect(edited.message).toBe("Edited update");
+
+ const found = await caller.maintenance.get({ id: created.id });
+ expect(found.updates.map((u) => u.message)).toEqual([
+ "Edited update",
+ "Initial update",
+ ]);
+ // `message` is the newest update
+ expect(found.message).toBe("Edited update");
+
+ await caller.maintenance.deleteUpdate({ id: added.id });
+ const deleted = await db.query.maintenanceUpdate.findFirst({
+ where: eq(maintenanceUpdate.id, added.id),
+ });
+ expect(deleted).toBeUndefined();
+
+ try {
+ await caller.maintenance.deleteUpdate({ id: added.id });
+ throw new Error("Should have thrown");
+ } catch (error) {
+ expect(error).toBeInstanceOf(TRPCError);
+ expect((error as TRPCError).code).toBe("NOT_FOUND");
+ }
+
+ await caller.maintenance.delete({ id: created.id });
+});
diff --git a/packages/api/src/router/maintenance.ts b/packages/api/src/router/maintenance.ts
index d04e9424c..54d73ea3f 100644
--- a/packages/api/src/router/maintenance.ts
+++ b/packages/api/src/router/maintenance.ts
@@ -1,11 +1,14 @@
import { Events } from "@openstatus/analytics";
import { NotFoundError } from "@openstatus/services";
import {
+ addMaintenanceUpdate,
createMaintenance,
deleteMaintenance,
+ deleteMaintenanceUpdate,
getMaintenance,
listMaintenances,
updateMaintenance,
+ updateMaintenanceUpdate,
} from "@openstatus/services/maintenance";
import { z } from "zod";
@@ -14,6 +17,32 @@ import { createTRPCRouter, protectedProcedure } from "../trpc";
import { periods } from "./utils";
export const maintenanceRouter = createTRPCRouter({
+ createUpdate: protectedProcedure
+ .meta({ track: Events.CreateMaintenanceUpdate })
+ .input(
+ z.object({
+ maintenanceId: z.number(),
+ message: z.string().min(1),
+ date: z.date().optional(),
+ notifySubscribers: z.boolean().nullish(),
+ }),
+ )
+ .mutation(async ({ ctx, input }) => {
+ try {
+ const update = await addMaintenanceUpdate({
+ ctx: toServiceCtx(ctx),
+ input: {
+ maintenanceId: input.maintenanceId,
+ message: input.message,
+ date: input.date,
+ },
+ });
+ return { ...update, notifySubscribers: input.notifySubscribers };
+ } catch (err) {
+ toTRPCError(err);
+ }
+ }),
+
delete: protectedProcedure
.meta({ track: Events.DeleteMaintenance })
.input(z.object({ id: z.number() }))
@@ -36,6 +65,20 @@ export const maintenanceRouter = createTRPCRouter({
}
}),
+ deleteUpdate: protectedProcedure
+ .meta({ track: Events.DeleteMaintenanceUpdate })
+ .input(z.object({ id: z.number() }))
+ .mutation(async ({ ctx, input }) => {
+ try {
+ await deleteMaintenanceUpdate({
+ ctx: toServiceCtx(ctx),
+ input: { id: input.id },
+ });
+ } catch (err) {
+ toTRPCError(err);
+ }
+ }),
+
get: protectedProcedure
.input(z.object({ id: z.number() }))
.query(async ({ ctx, input }) => {
@@ -94,7 +137,7 @@ export const maintenanceRouter = createTRPCRouter({
)
.mutation(async ({ ctx, input }) => {
try {
- const record = await createMaintenance({
+ const { maintenance, initialUpdate } = await createMaintenance({
ctx: toServiceCtx(ctx),
input: {
title: input.title,
@@ -105,7 +148,12 @@ export const maintenanceRouter = createTRPCRouter({
pageComponentIds: input.pageComponents ?? [],
},
});
- return { ...record, notifySubscribers: input.notifySubscribers };
+ // subscriberNotification.maintenance is keyed by update id
+ return {
+ ...maintenance,
+ initialUpdateId: initialUpdate.id,
+ notifySubscribers: input.notifySubscribers,
+ };
} catch (err) {
toTRPCError(err);
}
@@ -117,7 +165,6 @@ export const maintenanceRouter = createTRPCRouter({
z.object({
id: z.number(),
title: z.string(),
- message: z.string(),
startDate: z.coerce.date(),
endDate: z.coerce.date(),
pageComponents: z.array(z.number()).optional(),
@@ -130,7 +177,6 @@ export const maintenanceRouter = createTRPCRouter({
input: {
id: input.id,
title: input.title,
- message: input.message,
from: input.startDate,
to: input.endDate,
pageComponentIds: input.pageComponents,
@@ -140,4 +186,29 @@ export const maintenanceRouter = createTRPCRouter({
toTRPCError(err);
}
}),
+
+ updateUpdate: protectedProcedure
+ .meta({ track: Events.UpdateMaintenanceUpdate })
+ .input(
+ z
+ .object({
+ id: z.number(),
+ message: z.string().min(1).optional(),
+ date: z.date().optional(),
+ })
+ .refine(
+ (input) => input.message !== undefined || input.date !== undefined,
+ { message: "At least one field must be provided." },
+ ),
+ )
+ .mutation(async ({ ctx, input }) => {
+ try {
+ return await updateMaintenanceUpdate({
+ ctx: toServiceCtx(ctx),
+ input,
+ });
+ } catch (err) {
+ toTRPCError(err);
+ }
+ }),
});
diff --git a/packages/api/src/router/statusPage.ts b/packages/api/src/router/statusPage.ts
index 237281e93..2b91ee49b 100644
--- a/packages/api/src/router/statusPage.ts
+++ b/packages/api/src/router/statusPage.ts
@@ -112,6 +112,12 @@ export const statusPageRouter = createTRPCRouter({
},
maintenances: {
with: {
+ maintenanceUpdates: {
+ orderBy: (updates, { desc }) => [
+ desc(updates.date),
+ desc(updates.id),
+ ],
+ },
maintenancesToPageComponents: { with: { pageComponent: true } },
},
orderBy: (maintenances, { desc }) => desc(maintenances.from),
@@ -551,6 +557,12 @@ export const statusPageRouter = createTRPCRouter({
},
maintenances: {
with: {
+ maintenanceUpdates: {
+ orderBy: (updates, { desc }) => [
+ desc(updates.date),
+ desc(updates.id),
+ ],
+ },
maintenancesToPageComponents: { with: { pageComponent: true } },
},
orderBy: (maintenances, { desc }) => desc(maintenances.from),
@@ -690,6 +702,12 @@ export const statusPageRouter = createTRPCRouter({
eq(maintenance.pageId, _page.id),
),
with: {
+ maintenanceUpdates: {
+ orderBy: (updates, { desc }) => [
+ desc(updates.date),
+ desc(updates.id),
+ ],
+ },
maintenancesToPageComponents: {
with: { pageComponent: { with: { monitor: true } } },
},
diff --git a/packages/api/src/router/subscriber-notification.ts b/packages/api/src/router/subscriber-notification.ts
index 7b1eb7a2e..a69a4aa1a 100644
--- a/packages/api/src/router/subscriber-notification.ts
+++ b/packages/api/src/router/subscriber-notification.ts
@@ -40,7 +40,7 @@ export const subscriberNotificationRouter = createTRPCRouter({
try {
await notifyMaintenance({
ctx: toServiceCtx(ctx),
- input: { maintenanceId: input.id },
+ input: { maintenanceUpdateId: input.id },
});
return { success: true };
} catch (err) {
diff --git a/packages/db/drizzle/0092_yielding_banshee.sql b/packages/db/drizzle/0092_yielding_banshee.sql
new file mode 100644
index 000000000..4b25c4a2a
--- /dev/null
+++ b/packages/db/drizzle/0092_yielding_banshee.sql
@@ -0,0 +1,20 @@
+CREATE TABLE `maintenance_update` (
+ `id` integer PRIMARY KEY NOT NULL,
+ `message` text NOT NULL,
+ `date` integer NOT NULL,
+ `maintenance_id` integer NOT NULL,
+ `created_by` integer,
+ `updated_by` integer,
+ `created_at` integer DEFAULT (strftime('%s', 'now')),
+ `updated_at` integer DEFAULT (strftime('%s', 'now')),
+ FOREIGN KEY (`maintenance_id`) REFERENCES `maintenance`(`id`) ON UPDATE no action ON DELETE cascade,
+ FOREIGN KEY (`created_by`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE no action,
+ FOREIGN KEY (`updated_by`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE no action
+);
+--> statement-breakpoint
+CREATE INDEX `maintenance_update_maintenance_id_idx` ON `maintenance_update` (`maintenance_id`);
+--> statement-breakpoint
+INSERT INTO `maintenance_update` (`maintenance_id`, `message`, `date`, `created_by`, `updated_by`)
+SELECT `id`, `message`, COALESCE(`created_at`, `from`), `created_by`, COALESCE(`updated_by`, `created_by`)
+FROM `maintenance`
+WHERE `message` <> '';
diff --git a/packages/db/drizzle/meta/0092_snapshot.json b/packages/db/drizzle/meta/0092_snapshot.json
new file mode 100644
index 000000000..d5e9b02c6
--- /dev/null
+++ b/packages/db/drizzle/meta/0092_snapshot.json
@@ -0,0 +1,6892 @@
+{
+ "version": "6",
+ "dialect": "sqlite",
+ "id": "94dd2640-d257-4088-ac88-7cb99df6d1b7",
+ "prevId": "2dde5587-d4ea-4734-973a-bb75b6a23940",
+ "tables": {
+ "workspace": {
+ "name": "workspace",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "slug": {
+ "name": "slug",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "stripe_id": {
+ "name": "stripe_id",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "subscription_id": {
+ "name": "subscription_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "plan": {
+ "name": "plan",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "ends_at": {
+ "name": "ends_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "paid_until": {
+ "name": "paid_until",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "trial_ends_at": {
+ "name": "trial_ends_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "limits": {
+ "name": "limits",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{}'"
+ },
+ "workos_organization_id": {
+ "name": "workos_organization_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "sso_enabled": {
+ "name": "sso_enabled",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "dsn": {
+ "name": "dsn",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "workspace_slug_unique": {
+ "name": "workspace_slug_unique",
+ "columns": [
+ "slug"
+ ],
+ "isUnique": true
+ },
+ "workspace_stripe_id_unique": {
+ "name": "workspace_stripe_id_unique",
+ "columns": [
+ "stripe_id"
+ ],
+ "isUnique": true
+ },
+ "workspace_workos_organization_id_unique": {
+ "name": "workspace_workos_organization_id_unique",
+ "columns": [
+ "workos_organization_id"
+ ],
+ "isUnique": true
+ },
+ "workspace_id_dsn_unique": {
+ "name": "workspace_id_dsn_unique",
+ "columns": [
+ "id",
+ "dsn"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "workspace_sso_domain": {
+ "name": "workspace_sso_domain",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "domain": {
+ "name": "domain",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "verified_at": {
+ "name": "verified_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "workspace_sso_domain_domain_unique": {
+ "name": "workspace_sso_domain_domain_unique",
+ "columns": [
+ "domain"
+ ],
+ "isUnique": true
+ },
+ "workspace_sso_domain_workspace_id_idx": {
+ "name": "workspace_sso_domain_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "workspace_sso_domain_workspace_id_workspace_id_fk": {
+ "name": "workspace_sso_domain_workspace_id_workspace_id_fk",
+ "tableFrom": "workspace_sso_domain",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "account": {
+ "name": "account",
+ "columns": {
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider_account_id": {
+ "name": "provider_account_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "account_user_id_user_id_fk": {
+ "name": "account_user_id_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_provider_account_id_pk": {
+ "columns": [
+ "provider",
+ "provider_account_id"
+ ],
+ "name": "account_provider_provider_account_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "session_token": {
+ "name": "session_token",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "session_user_id_idx": {
+ "name": "session_user_id_idx",
+ "columns": [
+ "user_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_user_id_user_id_fk": {
+ "name": "session_user_id_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "tenant_id": {
+ "name": "tenant_id",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "first_name": {
+ "name": "first_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "last_name": {
+ "name": "last_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "photo_url": {
+ "name": "photo_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "deleted_at": {
+ "name": "deleted_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_tenant_id_unique": {
+ "name": "user_tenant_id_unique",
+ "columns": [
+ "tenant_id"
+ ],
+ "isUnique": true
+ },
+ "user_email_idx": {
+ "name": "user_email_idx",
+ "columns": [
+ "email"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "users_to_workspaces": {
+ "name": "users_to_workspaces",
+ "columns": {
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "role": {
+ "name": "role",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'member'"
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "users_to_workspaces_workspace_id_idx": {
+ "name": "users_to_workspaces_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "users_to_workspaces_user_id_user_id_fk": {
+ "name": "users_to_workspaces_user_id_user_id_fk",
+ "tableFrom": "users_to_workspaces",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "users_to_workspaces_workspace_id_workspace_id_fk": {
+ "name": "users_to_workspaces_workspace_id_workspace_id_fk",
+ "tableFrom": "users_to_workspaces",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "users_to_workspaces_user_id_workspace_id_pk": {
+ "columns": [
+ "user_id",
+ "workspace_id"
+ ],
+ "name": "users_to_workspaces_user_id_workspace_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "verification_token": {
+ "name": "verification_token",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verification_token_identifier_token_pk": {
+ "columns": [
+ "identifier",
+ "token"
+ ],
+ "name": "verification_token_identifier_token_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "status_report": {
+ "name": "status_report",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "title": {
+ "name": "title",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_id": {
+ "name": "page_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_by": {
+ "name": "created_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "updated_by": {
+ "name": "updated_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "status_report_workspace_created_idx": {
+ "name": "status_report_workspace_created_idx",
+ "columns": [
+ "workspace_id",
+ "created_at"
+ ],
+ "isUnique": false
+ },
+ "status_report_page_id_idx": {
+ "name": "status_report_page_id_idx",
+ "columns": [
+ "page_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "status_report_workspace_id_workspace_id_fk": {
+ "name": "status_report_workspace_id_workspace_id_fk",
+ "tableFrom": "status_report",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "status_report_page_id_page_id_fk": {
+ "name": "status_report_page_id_page_id_fk",
+ "tableFrom": "status_report",
+ "tableTo": "page",
+ "columnsFrom": [
+ "page_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "status_report_created_by_user_id_fk": {
+ "name": "status_report_created_by_user_id_fk",
+ "tableFrom": "status_report",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "status_report_updated_by_user_id_fk": {
+ "name": "status_report_updated_by_user_id_fk",
+ "tableFrom": "status_report",
+ "tableTo": "user",
+ "columnsFrom": [
+ "updated_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "status_report_update": {
+ "name": "status_report_update",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "date": {
+ "name": "date",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "message": {
+ "name": "message",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status_report_id": {
+ "name": "status_report_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_by": {
+ "name": "created_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "updated_by": {
+ "name": "updated_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "status_report_update_status_report_id_idx": {
+ "name": "status_report_update_status_report_id_idx",
+ "columns": [
+ "status_report_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "status_report_update_status_report_id_status_report_id_fk": {
+ "name": "status_report_update_status_report_id_status_report_id_fk",
+ "tableFrom": "status_report_update",
+ "tableTo": "status_report",
+ "columnsFrom": [
+ "status_report_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "status_report_update_created_by_user_id_fk": {
+ "name": "status_report_update_created_by_user_id_fk",
+ "tableFrom": "status_report_update",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "status_report_update_updated_by_user_id_fk": {
+ "name": "status_report_update_updated_by_user_id_fk",
+ "tableFrom": "status_report_update",
+ "tableTo": "user",
+ "columnsFrom": [
+ "updated_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "credential": {
+ "name": "credential",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "external_id": {
+ "name": "external_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "data": {
+ "name": "data",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_workspace_id_idx": {
+ "name": "integration_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integration_workspace_id_workspace_id_fk": {
+ "name": "integration_workspace_id_workspace_id_fk",
+ "tableFrom": "integration",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "page": {
+ "name": "page",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "title": {
+ "name": "title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon": {
+ "name": "icon",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "slug": {
+ "name": "slug",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "custom_domain": {
+ "name": "custom_domain",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "published": {
+ "name": "published",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": false
+ },
+ "force_theme": {
+ "name": "force_theme",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'system'"
+ },
+ "custom_theme": {
+ "name": "custom_theme",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password_protected": {
+ "name": "password_protected",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": false
+ },
+ "access_type": {
+ "name": "access_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "'public'"
+ },
+ "auth_email_domains": {
+ "name": "auth_email_domains",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "allowed_ip_ranges": {
+ "name": "allowed_ip_ranges",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homepage_url": {
+ "name": "homepage_url",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "contact_url": {
+ "name": "contact_url",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "default_locale": {
+ "name": "default_locale",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'en'"
+ },
+ "locales": {
+ "name": "locales",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "legacy_page": {
+ "name": "legacy_page",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": true
+ },
+ "configuration": {
+ "name": "configuration",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "allow_index": {
+ "name": "allow_index",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": true
+ },
+ "show_monitor_values": {
+ "name": "show_monitor_values",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": true
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "page_slug_unique": {
+ "name": "page_slug_unique",
+ "columns": [
+ "slug"
+ ],
+ "isUnique": true
+ },
+ "page_lower_slug_idx": {
+ "name": "page_lower_slug_idx",
+ "columns": [
+ "LOWER(\"slug\")"
+ ],
+ "isUnique": false
+ },
+ "page_lower_custom_domain_idx": {
+ "name": "page_lower_custom_domain_idx",
+ "columns": [
+ "LOWER(\"custom_domain\")"
+ ],
+ "isUnique": false
+ },
+ "page_workspace_id_idx": {
+ "name": "page_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "page_workspace_id_workspace_id_fk": {
+ "name": "page_workspace_id_workspace_id_fk",
+ "tableFrom": "page",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor": {
+ "name": "monitor",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "job_type": {
+ "name": "job_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'http'"
+ },
+ "periodicity": {
+ "name": "periodicity",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'other'"
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'active'"
+ },
+ "active": {
+ "name": "active",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": false
+ },
+ "regions": {
+ "name": "regions",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "url": {
+ "name": "url",
+ "type": "text(2048)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "external_name": {
+ "name": "external_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "headers": {
+ "name": "headers",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "body": {
+ "name": "body",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "method": {
+ "name": "method",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "'GET'"
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "timeout": {
+ "name": "timeout",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 45000
+ },
+ "degraded_after": {
+ "name": "degraded_after",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "assertions": {
+ "name": "assertions",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "otel_endpoint": {
+ "name": "otel_endpoint",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "otel_headers": {
+ "name": "otel_headers",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "public": {
+ "name": "public",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": false
+ },
+ "retry": {
+ "name": "retry",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": 3
+ },
+ "follow_redirects": {
+ "name": "follow_redirects",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": true
+ },
+ "grpc_service": {
+ "name": "grpc_service",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "grpc_tls": {
+ "name": "grpc_tls",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "'tls'"
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "deleted_at": {
+ "name": "deleted_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "monitor_workspace_id_active_idx": {
+ "name": "monitor_workspace_id_active_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false,
+ "where": "\"monitor\".\"deleted_at\" IS NULL"
+ }
+ },
+ "foreignKeys": {
+ "monitor_workspace_id_workspace_id_fk": {
+ "name": "monitor_workspace_id_workspace_id_fk",
+ "tableFrom": "monitor",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "page_subscriber": {
+ "name": "page_subscriber",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_id": {
+ "name": "page_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "channel_type": {
+ "name": "channel_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'email'"
+ },
+ "webhook_url": {
+ "name": "webhook_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "channel_config": {
+ "name": "channel_config",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "slack_channel_id": {
+ "name": "slack_channel_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "source": {
+ "name": "source",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'self_signup'"
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "accepted_at": {
+ "name": "accepted_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "unsubscribed_at": {
+ "name": "unsubscribed_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "page_subscriber_page_id_idx": {
+ "name": "page_subscriber_page_id_idx",
+ "columns": [
+ "page_id"
+ ],
+ "isUnique": false
+ },
+ "idx_page_subscriber_email_page_active": {
+ "name": "idx_page_subscriber_email_page_active",
+ "columns": [
+ "LOWER(\"email\")",
+ "page_id"
+ ],
+ "isUnique": true,
+ "where": "\"page_subscriber\".\"unsubscribed_at\" IS NULL AND \"page_subscriber\".\"channel_type\" = 'email'"
+ },
+ "idx_page_subscriber_webhook_page_active": {
+ "name": "idx_page_subscriber_webhook_page_active",
+ "columns": [
+ "LOWER(\"webhook_url\")",
+ "page_id"
+ ],
+ "isUnique": true,
+ "where": "\"page_subscriber\".\"unsubscribed_at\" IS NULL AND \"page_subscriber\".\"channel_type\" = 'webhook'"
+ },
+ "idx_page_subscriber_slack_channel_page_active": {
+ "name": "idx_page_subscriber_slack_channel_page_active",
+ "columns": [
+ "slack_channel_id",
+ "page_id"
+ ],
+ "isUnique": true,
+ "where": "\"page_subscriber\".\"unsubscribed_at\" IS NULL AND \"page_subscriber\".\"channel_type\" = 'slack'"
+ }
+ },
+ "foreignKeys": {
+ "page_subscriber_page_id_page_id_fk": {
+ "name": "page_subscriber_page_id_page_id_fk",
+ "tableFrom": "page_subscriber",
+ "tableTo": "page",
+ "columnsFrom": [
+ "page_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {
+ "page_subscriber_channel_check": {
+ "name": "page_subscriber_channel_check",
+ "value": "(\"page_subscriber\".\"channel_type\" = 'email' AND \"page_subscriber\".\"email\" IS NOT NULL AND \"page_subscriber\".\"webhook_url\" IS NULL) OR (\"page_subscriber\".\"channel_type\" = 'webhook' AND \"page_subscriber\".\"webhook_url\" IS NOT NULL AND \"page_subscriber\".\"email\" IS NULL) OR (\"page_subscriber\".\"channel_type\" = 'slack' AND \"page_subscriber\".\"slack_channel_id\" IS NOT NULL AND \"page_subscriber\".\"email\" IS NULL AND \"page_subscriber\".\"webhook_url\" IS NULL)"
+ }
+ }
+ },
+ "page_subscriber_to_page_component": {
+ "name": "page_subscriber_to_page_component",
+ "columns": {
+ "page_subscriber_id": {
+ "name": "page_subscriber_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_component_id": {
+ "name": "page_component_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "page_subscriber_to_page_component_page_subscriber_id_page_subscriber_id_fk": {
+ "name": "page_subscriber_to_page_component_page_subscriber_id_page_subscriber_id_fk",
+ "tableFrom": "page_subscriber_to_page_component",
+ "tableTo": "page_subscriber",
+ "columnsFrom": [
+ "page_subscriber_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "page_subscriber_to_page_component_page_component_id_page_component_id_fk": {
+ "name": "page_subscriber_to_page_component_page_component_id_page_component_id_fk",
+ "tableFrom": "page_subscriber_to_page_component",
+ "tableTo": "page_component",
+ "columnsFrom": [
+ "page_component_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "page_subscriber_to_page_component_page_subscriber_id_page_component_id_pk": {
+ "columns": [
+ "page_subscriber_id",
+ "page_component_id"
+ ],
+ "name": "page_subscriber_to_page_component_page_subscriber_id_page_component_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "notification": {
+ "name": "notification",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "data": {
+ "name": "data",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "'{}'"
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "notification_workspace_id_idx": {
+ "name": "notification_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "notification_workspace_id_workspace_id_fk": {
+ "name": "notification_workspace_id_workspace_id_fk",
+ "tableFrom": "notification",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "notification_trigger": {
+ "name": "notification_trigger",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "notification_id": {
+ "name": "notification_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "cron_timestamp": {
+ "name": "cron_timestamp",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "notification_id_monitor_id_crontimestampe": {
+ "name": "notification_id_monitor_id_crontimestampe",
+ "columns": [
+ "notification_id",
+ "monitor_id",
+ "cron_timestamp"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "notification_trigger_monitor_id_monitor_id_fk": {
+ "name": "notification_trigger_monitor_id_monitor_id_fk",
+ "tableFrom": "notification_trigger",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "notification_trigger_notification_id_notification_id_fk": {
+ "name": "notification_trigger_notification_id_notification_id_fk",
+ "tableFrom": "notification_trigger",
+ "tableTo": "notification",
+ "columnsFrom": [
+ "notification_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "notifications_to_monitors": {
+ "name": "notifications_to_monitors",
+ "columns": {
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "notification_id": {
+ "name": "notification_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "notifications_to_monitors_notification_id_idx": {
+ "name": "notifications_to_monitors_notification_id_idx",
+ "columns": [
+ "notification_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "notifications_to_monitors_monitor_id_monitor_id_fk": {
+ "name": "notifications_to_monitors_monitor_id_monitor_id_fk",
+ "tableFrom": "notifications_to_monitors",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "notifications_to_monitors_notification_id_notification_id_fk": {
+ "name": "notifications_to_monitors_notification_id_notification_id_fk",
+ "tableFrom": "notifications_to_monitors",
+ "tableTo": "notification",
+ "columnsFrom": [
+ "notification_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "notifications_to_monitors_monitor_id_notification_id_pk": {
+ "columns": [
+ "monitor_id",
+ "notification_id"
+ ],
+ "name": "notifications_to_monitors_monitor_id_notification_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "notification_dead_letter": {
+ "name": "notification_dead_letter",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "outbox_id": {
+ "name": "outbox_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "dedup_key": {
+ "name": "dedup_key",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "notification_id": {
+ "name": "notification_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "event_type": {
+ "name": "event_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "from_status": {
+ "name": "from_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "to_status": {
+ "name": "to_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "cron_timestamp": {
+ "name": "cron_timestamp",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "incident_id": {
+ "name": "incident_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "payload": {
+ "name": "payload",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "attempts": {
+ "name": "attempts",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "final_error": {
+ "name": "final_error",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "died_at": {
+ "name": "died_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "notification_dead_letter_dedup_key_idx": {
+ "name": "notification_dead_letter_dedup_key_idx",
+ "columns": [
+ "dedup_key"
+ ],
+ "isUnique": true
+ },
+ "notification_dead_letter_workspace_id_died_at_idx": {
+ "name": "notification_dead_letter_workspace_id_died_at_idx",
+ "columns": [
+ "workspace_id",
+ "died_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "notification_dead_letter_monitor_id_monitor_id_fk": {
+ "name": "notification_dead_letter_monitor_id_monitor_id_fk",
+ "tableFrom": "notification_dead_letter",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "notification_dead_letter_workspace_id_workspace_id_fk": {
+ "name": "notification_dead_letter_workspace_id_workspace_id_fk",
+ "tableFrom": "notification_dead_letter",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "notification_outbox": {
+ "name": "notification_outbox",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "dedup_key": {
+ "name": "dedup_key",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "notification_id": {
+ "name": "notification_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "event_type": {
+ "name": "event_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "from_status": {
+ "name": "from_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "to_status": {
+ "name": "to_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "cron_timestamp": {
+ "name": "cron_timestamp",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "incident_id": {
+ "name": "incident_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "payload": {
+ "name": "payload",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "delivery_status": {
+ "name": "delivery_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'pending'"
+ },
+ "outcome": {
+ "name": "outcome",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "attempts": {
+ "name": "attempts",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 0
+ },
+ "next_attempt_at": {
+ "name": "next_attempt_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "deadline_at": {
+ "name": "deadline_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "locked_by": {
+ "name": "locked_by",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "locked_until": {
+ "name": "locked_until",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "delivered_at": {
+ "name": "delivered_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "last_error": {
+ "name": "last_error",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "notification_outbox_dedup_key_idx": {
+ "name": "notification_outbox_dedup_key_idx",
+ "columns": [
+ "dedup_key"
+ ],
+ "isUnique": true
+ },
+ "notification_outbox_claim_idx": {
+ "name": "notification_outbox_claim_idx",
+ "columns": [
+ "next_attempt_at"
+ ],
+ "isUnique": false,
+ "where": "\"notification_outbox\".\"delivery_status\" = 'pending'"
+ },
+ "notification_outbox_notification_id_cron_timestamp_idx": {
+ "name": "notification_outbox_notification_id_cron_timestamp_idx",
+ "columns": [
+ "notification_id",
+ "cron_timestamp"
+ ],
+ "isUnique": false
+ },
+ "notification_outbox_channel_idx": {
+ "name": "notification_outbox_channel_idx",
+ "columns": [
+ "monitor_id",
+ "notification_id"
+ ],
+ "isUnique": false,
+ "where": "\"notification_outbox\".\"delivery_status\" = 'pending'"
+ }
+ },
+ "foreignKeys": {
+ "notification_outbox_monitor_id_monitor_id_fk": {
+ "name": "notification_outbox_monitor_id_monitor_id_fk",
+ "tableFrom": "notification_outbox",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "notification_outbox_workspace_id_workspace_id_fk": {
+ "name": "notification_outbox_workspace_id_workspace_id_fk",
+ "tableFrom": "notification_outbox",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "notification_outbox_notification_id_notification_id_fk": {
+ "name": "notification_outbox_notification_id_notification_id_fk",
+ "tableFrom": "notification_outbox",
+ "tableTo": "notification",
+ "columnsFrom": [
+ "notification_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "notification_outbox_incident_id_monitor_incident_id_fk": {
+ "name": "notification_outbox_incident_id_monitor_incident_id_fk",
+ "tableFrom": "notification_outbox",
+ "tableTo": "monitor_incident",
+ "columnsFrom": [
+ "incident_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_status": {
+ "name": "monitor_status",
+ "columns": {
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "region": {
+ "name": "region",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'active'"
+ },
+ "cron_timestamp": {
+ "name": "cron_timestamp",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 0
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "monitor_status_idx": {
+ "name": "monitor_status_idx",
+ "columns": [
+ "monitor_id",
+ "region"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "monitor_status_monitor_id_monitor_id_fk": {
+ "name": "monitor_status_monitor_id_monitor_id_fk",
+ "tableFrom": "monitor_status",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "monitor_status_monitor_id_region_pk": {
+ "columns": [
+ "monitor_id",
+ "region"
+ ],
+ "name": "monitor_status_monitor_id_region_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "invitation": {
+ "name": "invitation",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "role": {
+ "name": "role",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'member'"
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "accepted_at": {
+ "name": "accepted_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "invitation_workspace_id_idx": {
+ "name": "invitation_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_incident": {
+ "name": "monitor_incident",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "title": {
+ "name": "title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "summary": {
+ "name": "summary",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'triage'"
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "started_at": {
+ "name": "started_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "acknowledged_at": {
+ "name": "acknowledged_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "acknowledged_by": {
+ "name": "acknowledged_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "resolved_at": {
+ "name": "resolved_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "resolved_by": {
+ "name": "resolved_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "incident_screenshot_url": {
+ "name": "incident_screenshot_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "recovery_screenshot_url": {
+ "name": "recovery_screenshot_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "auto_resolved": {
+ "name": "auto_resolved",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "monitor_incident_workspace_id_started_at_idx": {
+ "name": "monitor_incident_workspace_id_started_at_idx",
+ "columns": [
+ "workspace_id",
+ "started_at"
+ ],
+ "isUnique": false
+ },
+ "monitor_incident_open_idx": {
+ "name": "monitor_incident_open_idx",
+ "columns": [
+ "monitor_id"
+ ],
+ "isUnique": true,
+ "where": "\"monitor_incident\".\"resolved_at\" IS NULL"
+ },
+ "monitor_incident_monitor_id_started_at_unique": {
+ "name": "monitor_incident_monitor_id_started_at_unique",
+ "columns": [
+ "monitor_id",
+ "started_at"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "monitor_incident_monitor_id_monitor_id_fk": {
+ "name": "monitor_incident_monitor_id_monitor_id_fk",
+ "tableFrom": "monitor_incident",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "set default",
+ "onUpdate": "no action"
+ },
+ "monitor_incident_workspace_id_workspace_id_fk": {
+ "name": "monitor_incident_workspace_id_workspace_id_fk",
+ "tableFrom": "monitor_incident",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "monitor_incident_acknowledged_by_user_id_fk": {
+ "name": "monitor_incident_acknowledged_by_user_id_fk",
+ "tableFrom": "monitor_incident",
+ "tableTo": "user",
+ "columnsFrom": [
+ "acknowledged_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "monitor_incident_resolved_by_user_id_fk": {
+ "name": "monitor_incident_resolved_by_user_id_fk",
+ "tableFrom": "monitor_incident",
+ "tableTo": "user",
+ "columnsFrom": [
+ "resolved_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_tag": {
+ "name": "monitor_tag",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "color": {
+ "name": "color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "monitor_tag_workspace_id_idx": {
+ "name": "monitor_tag_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "monitor_tag_workspace_id_workspace_id_fk": {
+ "name": "monitor_tag_workspace_id_workspace_id_fk",
+ "tableFrom": "monitor_tag",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_tag_to_monitor": {
+ "name": "monitor_tag_to_monitor",
+ "columns": {
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "monitor_tag_id": {
+ "name": "monitor_tag_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "monitor_tag_to_monitor_monitor_tag_id_idx": {
+ "name": "monitor_tag_to_monitor_monitor_tag_id_idx",
+ "columns": [
+ "monitor_tag_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "monitor_tag_to_monitor_monitor_id_monitor_id_fk": {
+ "name": "monitor_tag_to_monitor_monitor_id_monitor_id_fk",
+ "tableFrom": "monitor_tag_to_monitor",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "monitor_tag_to_monitor_monitor_tag_id_monitor_tag_id_fk": {
+ "name": "monitor_tag_to_monitor_monitor_tag_id_monitor_tag_id_fk",
+ "tableFrom": "monitor_tag_to_monitor",
+ "tableTo": "monitor_tag",
+ "columnsFrom": [
+ "monitor_tag_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "monitor_tag_to_monitor_monitor_id_monitor_tag_id_pk": {
+ "columns": [
+ "monitor_id",
+ "monitor_tag_id"
+ ],
+ "name": "monitor_tag_to_monitor_monitor_id_monitor_tag_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "application": {
+ "name": "application",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "dsn": {
+ "name": "dsn",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "application_dsn_unique": {
+ "name": "application_dsn_unique",
+ "columns": [
+ "dsn"
+ ],
+ "isUnique": true
+ },
+ "application_workspace_id_idx": {
+ "name": "application_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "application_workspace_id_workspace_id_fk": {
+ "name": "application_workspace_id_workspace_id_fk",
+ "tableFrom": "application",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "maintenance": {
+ "name": "maintenance",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "title": {
+ "name": "title",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "message": {
+ "name": "message",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "from": {
+ "name": "from",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "to": {
+ "name": "to",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_id": {
+ "name": "page_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_by": {
+ "name": "created_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "updated_by": {
+ "name": "updated_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "maintenance_page_id_idx": {
+ "name": "maintenance_page_id_idx",
+ "columns": [
+ "page_id"
+ ],
+ "isUnique": false
+ },
+ "maintenance_workspace_id_idx": {
+ "name": "maintenance_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "maintenance_workspace_id_workspace_id_fk": {
+ "name": "maintenance_workspace_id_workspace_id_fk",
+ "tableFrom": "maintenance",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "maintenance_page_id_page_id_fk": {
+ "name": "maintenance_page_id_page_id_fk",
+ "tableFrom": "maintenance",
+ "tableTo": "page",
+ "columnsFrom": [
+ "page_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "maintenance_created_by_user_id_fk": {
+ "name": "maintenance_created_by_user_id_fk",
+ "tableFrom": "maintenance",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "maintenance_updated_by_user_id_fk": {
+ "name": "maintenance_updated_by_user_id_fk",
+ "tableFrom": "maintenance",
+ "tableTo": "user",
+ "columnsFrom": [
+ "updated_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "maintenance_update": {
+ "name": "maintenance_update",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "message": {
+ "name": "message",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "date": {
+ "name": "date",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "maintenance_id": {
+ "name": "maintenance_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_by": {
+ "name": "created_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "updated_by": {
+ "name": "updated_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "maintenance_update_maintenance_id_idx": {
+ "name": "maintenance_update_maintenance_id_idx",
+ "columns": [
+ "maintenance_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "maintenance_update_maintenance_id_maintenance_id_fk": {
+ "name": "maintenance_update_maintenance_id_maintenance_id_fk",
+ "tableFrom": "maintenance_update",
+ "tableTo": "maintenance",
+ "columnsFrom": [
+ "maintenance_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "maintenance_update_created_by_user_id_fk": {
+ "name": "maintenance_update_created_by_user_id_fk",
+ "tableFrom": "maintenance_update",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "maintenance_update_updated_by_user_id_fk": {
+ "name": "maintenance_update_updated_by_user_id_fk",
+ "tableFrom": "maintenance_update",
+ "tableTo": "user",
+ "columnsFrom": [
+ "updated_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "check": {
+ "name": "check",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "regions": {
+ "name": "regions",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "url": {
+ "name": "url",
+ "type": "text(4096)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "headers": {
+ "name": "headers",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "body": {
+ "name": "body",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "method": {
+ "name": "method",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "'GET'"
+ },
+ "count_requests": {
+ "name": "count_requests",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": 1
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "check_workspace_id_idx": {
+ "name": "check_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "check_workspace_id_workspace_id_fk": {
+ "name": "check_workspace_id_workspace_id_fk",
+ "tableFrom": "check",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_run": {
+ "name": "monitor_run",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "runned_at": {
+ "name": "runned_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "monitor_run_workspace_id_created_at_idx": {
+ "name": "monitor_run_workspace_id_created_at_idx",
+ "columns": [
+ "workspace_id",
+ "created_at"
+ ],
+ "isUnique": false
+ },
+ "monitor_run_monitor_id_idx": {
+ "name": "monitor_run_monitor_id_idx",
+ "columns": [
+ "monitor_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "monitor_run_workspace_id_workspace_id_fk": {
+ "name": "monitor_run_workspace_id_workspace_id_fk",
+ "tableFrom": "monitor_run",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "monitor_run_monitor_id_monitor_id_fk": {
+ "name": "monitor_run_monitor_id_monitor_id_fk",
+ "tableFrom": "monitor_run",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "private_location_monitor_status": {
+ "name": "private_location_monitor_status",
+ "columns": {
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "private_location_id": {
+ "name": "private_location_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'active'"
+ },
+ "cron_timestamp": {
+ "name": "cron_timestamp",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "private_location_monitor_status_pl_id_idx": {
+ "name": "private_location_monitor_status_pl_id_idx",
+ "columns": [
+ "private_location_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "private_location_monitor_status_monitor_id_monitor_id_fk": {
+ "name": "private_location_monitor_status_monitor_id_monitor_id_fk",
+ "tableFrom": "private_location_monitor_status",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "private_location_monitor_status_private_location_id_private_location_id_fk": {
+ "name": "private_location_monitor_status_private_location_id_private_location_id_fk",
+ "tableFrom": "private_location_monitor_status",
+ "tableTo": "private_location",
+ "columnsFrom": [
+ "private_location_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "private_location_monitor_status_monitor_id_private_location_id_pk": {
+ "columns": [
+ "monitor_id",
+ "private_location_id"
+ ],
+ "name": "private_location_monitor_status_monitor_id_private_location_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "private_location": {
+ "name": "private_location",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'error'"
+ },
+ "metadata": {
+ "name": "metadata",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "last_seen_at": {
+ "name": "last_seen_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "private_location_workspace_id_idx": {
+ "name": "private_location_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "private_location_workspace_id_workspace_id_fk": {
+ "name": "private_location_workspace_id_workspace_id_fk",
+ "tableFrom": "private_location",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "private_location_to_monitor": {
+ "name": "private_location_to_monitor",
+ "columns": {
+ "private_location_id": {
+ "name": "private_location_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "deleted_at": {
+ "name": "deleted_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "private_location_to_monitor_private_location_id_idx": {
+ "name": "private_location_to_monitor_private_location_id_idx",
+ "columns": [
+ "private_location_id"
+ ],
+ "isUnique": false
+ },
+ "private_location_to_monitor_monitor_id_idx": {
+ "name": "private_location_to_monitor_monitor_id_idx",
+ "columns": [
+ "monitor_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "private_location_to_monitor_private_location_id_private_location_id_fk": {
+ "name": "private_location_to_monitor_private_location_id_private_location_id_fk",
+ "tableFrom": "private_location_to_monitor",
+ "tableTo": "private_location",
+ "columnsFrom": [
+ "private_location_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "private_location_to_monitor_monitor_id_monitor_id_fk": {
+ "name": "private_location_to_monitor_monitor_id_monitor_id_fk",
+ "tableFrom": "private_location_to_monitor",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_group": {
+ "name": "monitor_group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_id": {
+ "name": "page_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "monitor_group_workspace_id_idx": {
+ "name": "monitor_group_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ },
+ "monitor_group_page_id_idx": {
+ "name": "monitor_group_page_id_idx",
+ "columns": [
+ "page_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "monitor_group_workspace_id_workspace_id_fk": {
+ "name": "monitor_group_workspace_id_workspace_id_fk",
+ "tableFrom": "monitor_group",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "monitor_group_page_id_page_id_fk": {
+ "name": "monitor_group_page_id_page_id_fk",
+ "tableFrom": "monitor_group",
+ "tableTo": "page",
+ "columnsFrom": [
+ "page_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "viewer": {
+ "name": "viewer",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "viewer_email_unique": {
+ "name": "viewer_email_unique",
+ "columns": [
+ "email"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "viewer_accounts": {
+ "name": "viewer_accounts",
+ "columns": {
+ "user_id": {
+ "name": "user_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "viewer_accounts_user_id_viewer_id_fk": {
+ "name": "viewer_accounts_user_id_viewer_id_fk",
+ "tableFrom": "viewer_accounts",
+ "tableTo": "viewer",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "viewer_accounts_provider_providerAccountId_pk": {
+ "columns": [
+ "provider",
+ "providerAccountId"
+ ],
+ "name": "viewer_accounts_provider_providerAccountId_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "viewer_session": {
+ "name": "viewer_session",
+ "columns": {
+ "session_token": {
+ "name": "session_token",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "viewer_session_user_id_viewer_id_fk": {
+ "name": "viewer_session_user_id_viewer_id_fk",
+ "tableFrom": "viewer_session",
+ "tableTo": "viewer",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "api_key": {
+ "name": "api_key",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "prefix": {
+ "name": "prefix",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "hashed_token": {
+ "name": "hashed_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_by_id": {
+ "name": "created_by_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "scopes": {
+ "name": "scopes",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'[\"write\"]'"
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "last_used_at": {
+ "name": "last_used_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "api_key_prefix_unique": {
+ "name": "api_key_prefix_unique",
+ "columns": [
+ "prefix"
+ ],
+ "isUnique": true
+ },
+ "api_key_hashed_token_unique": {
+ "name": "api_key_hashed_token_unique",
+ "columns": [
+ "hashed_token"
+ ],
+ "isUnique": true
+ },
+ "api_key_prefix_idx": {
+ "name": "api_key_prefix_idx",
+ "columns": [
+ "prefix"
+ ],
+ "isUnique": false
+ },
+ "api_key_workspace_id_idx": {
+ "name": "api_key_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "api_key_workspace_id_workspace_id_fk": {
+ "name": "api_key_workspace_id_workspace_id_fk",
+ "tableFrom": "api_key",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "api_key_created_by_id_user_id_fk": {
+ "name": "api_key_created_by_id_user_id_fk",
+ "tableFrom": "api_key",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "maintenance_to_page_component": {
+ "name": "maintenance_to_page_component",
+ "columns": {
+ "maintenance_id": {
+ "name": "maintenance_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_component_id": {
+ "name": "page_component_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "maintenance_to_page_component_page_component_id_idx": {
+ "name": "maintenance_to_page_component_page_component_id_idx",
+ "columns": [
+ "page_component_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "maintenance_to_page_component_maintenance_id_maintenance_id_fk": {
+ "name": "maintenance_to_page_component_maintenance_id_maintenance_id_fk",
+ "tableFrom": "maintenance_to_page_component",
+ "tableTo": "maintenance",
+ "columnsFrom": [
+ "maintenance_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "maintenance_to_page_component_page_component_id_page_component_id_fk": {
+ "name": "maintenance_to_page_component_page_component_id_page_component_id_fk",
+ "tableFrom": "maintenance_to_page_component",
+ "tableTo": "page_component",
+ "columnsFrom": [
+ "page_component_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "maintenance_to_page_component_maintenance_id_page_component_id_pk": {
+ "columns": [
+ "maintenance_id",
+ "page_component_id"
+ ],
+ "name": "maintenance_to_page_component_maintenance_id_page_component_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "page_component": {
+ "name": "page_component",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_id": {
+ "name": "page_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'monitor'"
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "order": {
+ "name": "order",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": 0
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "group_order": {
+ "name": "group_order",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": 0
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "page_component_workspace_id_idx": {
+ "name": "page_component_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ },
+ "page_component_page_id_monitor_id_unique": {
+ "name": "page_component_page_id_monitor_id_unique",
+ "columns": [
+ "page_id",
+ "monitor_id"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "page_component_workspace_id_workspace_id_fk": {
+ "name": "page_component_workspace_id_workspace_id_fk",
+ "tableFrom": "page_component",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "page_component_page_id_page_id_fk": {
+ "name": "page_component_page_id_page_id_fk",
+ "tableFrom": "page_component",
+ "tableTo": "page",
+ "columnsFrom": [
+ "page_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "page_component_monitor_id_monitor_id_fk": {
+ "name": "page_component_monitor_id_monitor_id_fk",
+ "tableFrom": "page_component",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "page_component_group_id_page_component_groups_id_fk": {
+ "name": "page_component_group_id_page_component_groups_id_fk",
+ "tableFrom": "page_component",
+ "tableTo": "page_component_groups",
+ "columnsFrom": [
+ "group_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {
+ "page_component_type_check": {
+ "name": "page_component_type_check",
+ "value": "\"page_component\".\"type\" = 'monitor' AND \"page_component\".\"monitor_id\" IS NOT NULL OR \"page_component\".\"type\" = 'static' AND \"page_component\".\"monitor_id\" IS NULL"
+ }
+ }
+ },
+ "status_report_update_to_page_component": {
+ "name": "status_report_update_to_page_component",
+ "columns": {
+ "status_report_update_id": {
+ "name": "status_report_update_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_component_id": {
+ "name": "page_component_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "impact": {
+ "name": "impact",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "status_report_update_to_page_component_page_component_id_idx": {
+ "name": "status_report_update_to_page_component_page_component_id_idx",
+ "columns": [
+ "page_component_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "status_report_update_to_page_component_status_report_update_id_status_report_update_id_fk": {
+ "name": "status_report_update_to_page_component_status_report_update_id_status_report_update_id_fk",
+ "tableFrom": "status_report_update_to_page_component",
+ "tableTo": "status_report_update",
+ "columnsFrom": [
+ "status_report_update_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "status_report_update_to_page_component_page_component_id_page_component_id_fk": {
+ "name": "status_report_update_to_page_component_page_component_id_page_component_id_fk",
+ "tableFrom": "status_report_update_to_page_component",
+ "tableTo": "page_component",
+ "columnsFrom": [
+ "page_component_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "status_report_update_to_page_component_status_report_update_id_page_component_id_pk": {
+ "columns": [
+ "status_report_update_id",
+ "page_component_id"
+ ],
+ "name": "status_report_update_to_page_component_status_report_update_id_page_component_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "status_report_to_page_component": {
+ "name": "status_report_to_page_component",
+ "columns": {
+ "status_report_id": {
+ "name": "status_report_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_component_id": {
+ "name": "page_component_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "status_report_to_page_component_page_component_id_idx": {
+ "name": "status_report_to_page_component_page_component_id_idx",
+ "columns": [
+ "page_component_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "status_report_to_page_component_status_report_id_status_report_id_fk": {
+ "name": "status_report_to_page_component_status_report_id_status_report_id_fk",
+ "tableFrom": "status_report_to_page_component",
+ "tableTo": "status_report",
+ "columnsFrom": [
+ "status_report_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "status_report_to_page_component_page_component_id_page_component_id_fk": {
+ "name": "status_report_to_page_component_page_component_id_page_component_id_fk",
+ "tableFrom": "status_report_to_page_component",
+ "tableTo": "page_component",
+ "columnsFrom": [
+ "page_component_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "status_report_to_page_component_status_report_id_page_component_id_pk": {
+ "columns": [
+ "status_report_id",
+ "page_component_id"
+ ],
+ "name": "status_report_to_page_component_status_report_id_page_component_id_pk"
+ }
+ },
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "page_component_groups": {
+ "name": "page_component_groups",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "page_id": {
+ "name": "page_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "default_open": {
+ "name": "default_open",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "page_component_groups_page_id_idx": {
+ "name": "page_component_groups_page_id_idx",
+ "columns": [
+ "page_id"
+ ],
+ "isUnique": false
+ },
+ "page_component_groups_workspace_id_idx": {
+ "name": "page_component_groups_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "page_component_groups_workspace_id_workspace_id_fk": {
+ "name": "page_component_groups_workspace_id_workspace_id_fk",
+ "tableFrom": "page_component_groups",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "page_component_groups_page_id_page_id_fk": {
+ "name": "page_component_groups_page_id_page_id_fk",
+ "tableFrom": "page_component_groups",
+ "tableTo": "page",
+ "columnsFrom": [
+ "page_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "feedback": {
+ "name": "feedback",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "source": {
+ "name": "source",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "message": {
+ "name": "message",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "blocker": {
+ "name": "blocker",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "path": {
+ "name": "path",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "metadata": {
+ "name": "metadata",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "feedback_workspace_id_idx": {
+ "name": "feedback_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "feedback_workspace_id_workspace_id_fk": {
+ "name": "feedback_workspace_id_workspace_id_fk",
+ "tableFrom": "feedback",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "feedback_user_id_user_id_fk": {
+ "name": "feedback_user_id_user_id_fk",
+ "tableFrom": "feedback",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "audit_log": {
+ "name": "audit_log",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "actor_type": {
+ "name": "actor_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "actor_id": {
+ "name": "actor_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "actor_user_id": {
+ "name": "actor_user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "action": {
+ "name": "action",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "entity_type": {
+ "name": "entity_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "entity_id": {
+ "name": "entity_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "before": {
+ "name": "before",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "after": {
+ "name": "after",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "metadata": {
+ "name": "metadata",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "changed_fields": {
+ "name": "changed_fields",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "audit_log_workspace_created_idx": {
+ "name": "audit_log_workspace_created_idx",
+ "columns": [
+ "workspace_id",
+ "created_at"
+ ],
+ "isUnique": false
+ },
+ "audit_log_entity_idx": {
+ "name": "audit_log_entity_idx",
+ "columns": [
+ "workspace_id",
+ "entity_type",
+ "entity_id",
+ "created_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "external_service": {
+ "name": "external_service",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "slug": {
+ "name": "slug",
+ "type": "text(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "aliases": {
+ "name": "aliases",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(json_array())"
+ },
+ "name": {
+ "name": "name",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status_page_url": {
+ "name": "status_page_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "industry": {
+ "name": "industry",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "api_config": {
+ "name": "api_config",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "deleted_at": {
+ "name": "deleted_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "external_service_slug_unique": {
+ "name": "external_service_slug_unique",
+ "columns": [
+ "slug"
+ ],
+ "isUnique": true
+ },
+ "external_service_deleted_at_idx": {
+ "name": "external_service_deleted_at_idx",
+ "columns": [
+ "deleted_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "external_service_component": {
+ "name": "external_service_component",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "external_service_id": {
+ "name": "external_service_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "upstream_component_id": {
+ "name": "upstream_component_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "slug": {
+ "name": "slug",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "aliases": {
+ "name": "aliases",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(json_array())"
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "group_name": {
+ "name": "group_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 0
+ },
+ "indicator": {
+ "name": "indicator",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "first_seen_at": {
+ "name": "first_seen_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "external_service_component_unique_idx": {
+ "name": "external_service_component_unique_idx",
+ "columns": [
+ "external_service_id",
+ "upstream_component_id"
+ ],
+ "isUnique": true
+ },
+ "external_service_component_slug_unique_idx": {
+ "name": "external_service_component_slug_unique_idx",
+ "columns": [
+ "external_service_id",
+ "slug"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "external_service_component_external_service_id_external_service_id_fk": {
+ "name": "external_service_component_external_service_id_external_service_id_fk",
+ "tableFrom": "external_service_component",
+ "tableTo": "external_service",
+ "columnsFrom": [
+ "external_service_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "external_service_incident": {
+ "name": "external_service_incident",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "external_service_id": {
+ "name": "external_service_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider_incident_id": {
+ "name": "provider_incident_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "impact": {
+ "name": "impact",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "shortlink": {
+ "name": "shortlink",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "started_at": {
+ "name": "started_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "resolved_at": {
+ "name": "resolved_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "affected_component_ids": {
+ "name": "affected_component_ids",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'[]'"
+ },
+ "raw_payload": {
+ "name": "raw_payload",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "raw_payload_purged_at": {
+ "name": "raw_payload_purged_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "first_seen_at": {
+ "name": "first_seen_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "external_service_incident_unique_idx": {
+ "name": "external_service_incident_unique_idx",
+ "columns": [
+ "external_service_id",
+ "provider_incident_id"
+ ],
+ "isUnique": true
+ },
+ "external_service_incident_started_at_idx": {
+ "name": "external_service_incident_started_at_idx",
+ "columns": [
+ "external_service_id",
+ "started_at"
+ ],
+ "isUnique": false
+ },
+ "external_service_incident_resolved_at_idx": {
+ "name": "external_service_incident_resolved_at_idx",
+ "columns": [
+ "resolved_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "external_service_incident_external_service_id_external_service_id_fk": {
+ "name": "external_service_incident_external_service_id_external_service_id_fk",
+ "tableFrom": "external_service_incident",
+ "tableTo": "external_service",
+ "columnsFrom": [
+ "external_service_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "external_service_report": {
+ "name": "external_service_report",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "external_service_id": {
+ "name": "external_service_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "external_service_component_id": {
+ "name": "external_service_component_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "reporter_hash": {
+ "name": "reporter_hash",
+ "type": "text(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "country": {
+ "name": "country",
+ "type": "text(2)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "''"
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "external_service_report_service_idx": {
+ "name": "external_service_report_service_idx",
+ "columns": [
+ "external_service_id",
+ "created_at"
+ ],
+ "isUnique": false
+ },
+ "external_service_report_component_idx": {
+ "name": "external_service_report_component_idx",
+ "columns": [
+ "external_service_component_id",
+ "created_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "external_service_report_external_service_id_external_service_id_fk": {
+ "name": "external_service_report_external_service_id_external_service_id_fk",
+ "tableFrom": "external_service_report",
+ "tableTo": "external_service",
+ "columnsFrom": [
+ "external_service_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "external_service_report_external_service_component_id_external_service_component_id_fk": {
+ "name": "external_service_report_external_service_component_id_external_service_component_id_fk",
+ "tableFrom": "external_service_report",
+ "tableTo": "external_service_component",
+ "columnsFrom": [
+ "external_service_component_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "chat_session": {
+ "name": "chat_session",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "title": {
+ "name": "title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "messages": {
+ "name": "messages",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "chat_session_workspace_user_updated_idx": {
+ "name": "chat_session_workspace_user_updated_idx",
+ "columns": [
+ "workspace_id",
+ "user_id",
+ "updated_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "chat_session_workspace_id_workspace_id_fk": {
+ "name": "chat_session_workspace_id_workspace_id_fk",
+ "tableFrom": "chat_session",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "chat_session_user_id_user_id_fk": {
+ "name": "chat_session_user_id_user_id_fk",
+ "tableFrom": "chat_session",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "frozen_monitor_uptime": {
+ "name": "frozen_monitor_uptime",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "month": {
+ "name": "month",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "days": {
+ "name": "days",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "frozen_monitor_uptime_workspace_id_idx": {
+ "name": "frozen_monitor_uptime_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ },
+ "frozen_monitor_uptime_monitor_id_month_unique": {
+ "name": "frozen_monitor_uptime_monitor_id_month_unique",
+ "columns": [
+ "monitor_id",
+ "month"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "frozen_monitor_uptime_workspace_id_workspace_id_fk": {
+ "name": "frozen_monitor_uptime_workspace_id_workspace_id_fk",
+ "tableFrom": "frozen_monitor_uptime",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "frozen_monitor_uptime_monitor_id_monitor_id_fk": {
+ "name": "frozen_monitor_uptime_monitor_id_monitor_id_fk",
+ "tableFrom": "frozen_monitor_uptime",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "monitor_transition": {
+ "name": "monitor_transition",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "monitor_id": {
+ "name": "monitor_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "region": {
+ "name": "region",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "cron_timestamp": {
+ "name": "cron_timestamp",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "from_status": {
+ "name": "from_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "to_status": {
+ "name": "to_status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "quorum_count": {
+ "name": "quorum_count",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "region_count": {
+ "name": "region_count",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "transitioned": {
+ "name": "transitioned",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "outbox_rows": {
+ "name": "outbox_rows",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 0
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "monitor_transition_monitor_id_cron_timestamp_idx": {
+ "name": "monitor_transition_monitor_id_cron_timestamp_idx",
+ "columns": [
+ "monitor_id",
+ "cron_timestamp"
+ ],
+ "isUnique": false
+ },
+ "monitor_transition_created_at_idx": {
+ "name": "monitor_transition_created_at_idx",
+ "columns": [
+ "created_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "monitor_transition_monitor_id_monitor_id_fk": {
+ "name": "monitor_transition_monitor_id_monitor_id_fk",
+ "tableFrom": "monitor_transition",
+ "tableTo": "monitor",
+ "columnsFrom": [
+ "monitor_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "oauth_client": {
+ "name": "oauth_client",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "client_id": {
+ "name": "client_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'MCP Client'"
+ },
+ "redirect_uris": {
+ "name": "redirect_uris",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "revoked_at": {
+ "name": "revoked_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "oauth_client_client_id_unique": {
+ "name": "oauth_client_client_id_unique",
+ "columns": [
+ "client_id"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "oauth_session": {
+ "name": "oauth_session",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "client_id": {
+ "name": "client_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "redirect_uri": {
+ "name": "redirect_uri",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "state": {
+ "name": "state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "resource": {
+ "name": "resource",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "code_challenge": {
+ "name": "code_challenge",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "code_challenge_method": {
+ "name": "code_challenge_method",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'S256'"
+ },
+ "decided_at": {
+ "name": "decided_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "oauth_session_client_id_idx": {
+ "name": "oauth_session_client_id_idx",
+ "columns": [
+ "client_id"
+ ],
+ "isUnique": false
+ },
+ "oauth_session_expires_at_idx": {
+ "name": "oauth_session_expires_at_idx",
+ "columns": [
+ "expires_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "oauth_session_client_id_oauth_client_client_id_fk": {
+ "name": "oauth_session_client_id_oauth_client_client_id_fk",
+ "tableFrom": "oauth_session",
+ "tableTo": "oauth_client",
+ "columnsFrom": [
+ "client_id"
+ ],
+ "columnsTo": [
+ "client_id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "oauth_authorization_code": {
+ "name": "oauth_authorization_code",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "hash": {
+ "name": "hash",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "client_id": {
+ "name": "client_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "redirect_uri": {
+ "name": "redirect_uri",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "code_challenge": {
+ "name": "code_challenge",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "consumed_at": {
+ "name": "consumed_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "grant_id": {
+ "name": "grant_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "oauth_authorization_code_hash_unique": {
+ "name": "oauth_authorization_code_hash_unique",
+ "columns": [
+ "hash"
+ ],
+ "isUnique": true
+ },
+ "oauth_authorization_code_expires_at_idx": {
+ "name": "oauth_authorization_code_expires_at_idx",
+ "columns": [
+ "expires_at"
+ ],
+ "isUnique": false
+ },
+ "oauth_authorization_code_client_id_idx": {
+ "name": "oauth_authorization_code_client_id_idx",
+ "columns": [
+ "client_id"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "oauth_authorization_code_client_id_oauth_client_client_id_fk": {
+ "name": "oauth_authorization_code_client_id_oauth_client_client_id_fk",
+ "tableFrom": "oauth_authorization_code",
+ "tableTo": "oauth_client",
+ "columnsFrom": [
+ "client_id"
+ ],
+ "columnsTo": [
+ "client_id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "oauth_authorization_code_user_id_user_id_fk": {
+ "name": "oauth_authorization_code_user_id_user_id_fk",
+ "tableFrom": "oauth_authorization_code",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "oauth_authorization_code_workspace_id_workspace_id_fk": {
+ "name": "oauth_authorization_code_workspace_id_workspace_id_fk",
+ "tableFrom": "oauth_authorization_code",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "oauth_authorization_code_grant_id_oauth_grant_id_fk": {
+ "name": "oauth_authorization_code_grant_id_oauth_grant_id_fk",
+ "tableFrom": "oauth_authorization_code",
+ "tableTo": "oauth_grant",
+ "columnsFrom": [
+ "grant_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "oauth_grant": {
+ "name": "oauth_grant",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "client_id": {
+ "name": "client_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "access_token_hash": {
+ "name": "access_token_hash",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "access_token_expires_at": {
+ "name": "access_token_expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token_hash": {
+ "name": "refresh_token_hash",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token_expires_at": {
+ "name": "refresh_token_expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "previous_refresh_token_hash": {
+ "name": "previous_refresh_token_hash",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "rotated_at": {
+ "name": "rotated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "last_used_at": {
+ "name": "last_used_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "revoked_at": {
+ "name": "revoked_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "oauth_grant_access_token_hash_unique": {
+ "name": "oauth_grant_access_token_hash_unique",
+ "columns": [
+ "access_token_hash"
+ ],
+ "isUnique": true
+ },
+ "oauth_grant_refresh_token_hash_unique": {
+ "name": "oauth_grant_refresh_token_hash_unique",
+ "columns": [
+ "refresh_token_hash"
+ ],
+ "isUnique": true
+ },
+ "oauth_grant_workspace_id_idx": {
+ "name": "oauth_grant_workspace_id_idx",
+ "columns": [
+ "workspace_id"
+ ],
+ "isUnique": false
+ },
+ "oauth_grant_client_id_user_id_idx": {
+ "name": "oauth_grant_client_id_user_id_idx",
+ "columns": [
+ "client_id",
+ "user_id"
+ ],
+ "isUnique": false
+ },
+ "oauth_grant_user_id_idx": {
+ "name": "oauth_grant_user_id_idx",
+ "columns": [
+ "user_id"
+ ],
+ "isUnique": false
+ },
+ "oauth_grant_previous_refresh_token_hash_idx": {
+ "name": "oauth_grant_previous_refresh_token_hash_idx",
+ "columns": [
+ "previous_refresh_token_hash"
+ ],
+ "isUnique": false
+ },
+ "oauth_grant_refresh_token_expires_at_idx": {
+ "name": "oauth_grant_refresh_token_expires_at_idx",
+ "columns": [
+ "refresh_token_expires_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "oauth_grant_client_id_oauth_client_client_id_fk": {
+ "name": "oauth_grant_client_id_oauth_client_client_id_fk",
+ "tableFrom": "oauth_grant",
+ "tableTo": "oauth_client",
+ "columnsFrom": [
+ "client_id"
+ ],
+ "columnsTo": [
+ "client_id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "oauth_grant_user_id_user_id_fk": {
+ "name": "oauth_grant_user_id_user_id_fk",
+ "tableFrom": "oauth_grant",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "oauth_grant_workspace_id_workspace_id_fk": {
+ "name": "oauth_grant_workspace_id_workspace_id_fk",
+ "tableFrom": "oauth_grant",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "incident": {
+ "name": "incident",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "title": {
+ "name": "title",
+ "type": "text(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "severity": {
+ "name": "severity",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'open'"
+ },
+ "summary": {
+ "name": "summary",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "commander_id": {
+ "name": "commander_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "declared_by": {
+ "name": "declared_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "declared_at": {
+ "name": "declared_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "started_at": {
+ "name": "started_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "mitigated_at": {
+ "name": "mitigated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "resolved_at": {
+ "name": "resolved_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "resolved_by": {
+ "name": "resolved_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "closed_at": {
+ "name": "closed_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "status_report_id": {
+ "name": "status_report_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "slack_team_id": {
+ "name": "slack_team_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "slack_channel_id": {
+ "name": "slack_channel_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "incident_workspace_id_status_idx": {
+ "name": "incident_workspace_id_status_idx",
+ "columns": [
+ "workspace_id",
+ "status"
+ ],
+ "isUnique": false
+ },
+ "incident_workspace_id_declared_at_idx": {
+ "name": "incident_workspace_id_declared_at_idx",
+ "columns": [
+ "workspace_id",
+ "declared_at"
+ ],
+ "isUnique": false
+ },
+ "incident_slack_channel_idx": {
+ "name": "incident_slack_channel_idx",
+ "columns": [
+ "slack_team_id",
+ "slack_channel_id"
+ ],
+ "isUnique": true,
+ "where": "\"incident\".\"slack_channel_id\" IS NOT NULL"
+ },
+ "incident_status_report_id_idx": {
+ "name": "incident_status_report_id_idx",
+ "columns": [
+ "status_report_id"
+ ],
+ "isUnique": true,
+ "where": "\"incident\".\"status_report_id\" IS NOT NULL"
+ }
+ },
+ "foreignKeys": {
+ "incident_workspace_id_workspace_id_fk": {
+ "name": "incident_workspace_id_workspace_id_fk",
+ "tableFrom": "incident",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "incident_commander_id_user_id_fk": {
+ "name": "incident_commander_id_user_id_fk",
+ "tableFrom": "incident",
+ "tableTo": "user",
+ "columnsFrom": [
+ "commander_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "incident_declared_by_user_id_fk": {
+ "name": "incident_declared_by_user_id_fk",
+ "tableFrom": "incident",
+ "tableTo": "user",
+ "columnsFrom": [
+ "declared_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "incident_resolved_by_user_id_fk": {
+ "name": "incident_resolved_by_user_id_fk",
+ "tableFrom": "incident",
+ "tableTo": "user",
+ "columnsFrom": [
+ "resolved_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "incident_status_report_id_status_report_id_fk": {
+ "name": "incident_status_report_id_status_report_id_fk",
+ "tableFrom": "incident",
+ "tableTo": "status_report",
+ "columnsFrom": [
+ "status_report_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "incident_event": {
+ "name": "incident_event",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "incident_id": {
+ "name": "incident_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "message": {
+ "name": "message",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_by": {
+ "name": "created_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "incident_event_incident_id_created_at_idx": {
+ "name": "incident_event_incident_id_created_at_idx",
+ "columns": [
+ "incident_id",
+ "created_at"
+ ],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "incident_event_incident_id_incident_id_fk": {
+ "name": "incident_event_incident_id_incident_id_fk",
+ "tableFrom": "incident_event",
+ "tableTo": "incident",
+ "columnsFrom": [
+ "incident_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "incident_event_created_by_user_id_fk": {
+ "name": "incident_event_created_by_user_id_fk",
+ "tableFrom": "incident_event",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "incident_postmortem": {
+ "name": "incident_postmortem",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "incident_id": {
+ "name": "incident_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "status": {
+ "name": "status",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'draft'"
+ },
+ "content": {
+ "name": "content",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "source_transcript": {
+ "name": "source_transcript",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "drafted_by": {
+ "name": "drafted_by",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_by": {
+ "name": "created_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "updated_by": {
+ "name": "updated_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "approved_by": {
+ "name": "approved_by",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "approved_at": {
+ "name": "approved_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "published_at": {
+ "name": "published_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "incident_postmortem_incident_id_unique": {
+ "name": "incident_postmortem_incident_id_unique",
+ "columns": [
+ "incident_id"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "incident_postmortem_incident_id_incident_id_fk": {
+ "name": "incident_postmortem_incident_id_incident_id_fk",
+ "tableFrom": "incident_postmortem",
+ "tableTo": "incident",
+ "columnsFrom": [
+ "incident_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "incident_postmortem_created_by_user_id_fk": {
+ "name": "incident_postmortem_created_by_user_id_fk",
+ "tableFrom": "incident_postmortem",
+ "tableTo": "user",
+ "columnsFrom": [
+ "created_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "incident_postmortem_updated_by_user_id_fk": {
+ "name": "incident_postmortem_updated_by_user_id_fk",
+ "tableFrom": "incident_postmortem",
+ "tableTo": "user",
+ "columnsFrom": [
+ "updated_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ },
+ "incident_postmortem_approved_by_user_id_fk": {
+ "name": "incident_postmortem_approved_by_user_id_fk",
+ "tableFrom": "incident_postmortem",
+ "tableTo": "user",
+ "columnsFrom": [
+ "approved_by"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ },
+ "slack_user": {
+ "name": "slack_user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "integer",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": true
+ },
+ "workspace_id": {
+ "name": "workspace_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "slack_team_id": {
+ "name": "slack_team_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "slack_user_id": {
+ "name": "slack_user_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "created_at": {
+ "name": "created_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "(strftime('%s', 'now'))"
+ }
+ },
+ "indexes": {
+ "slack_user_user_id_idx": {
+ "name": "slack_user_user_id_idx",
+ "columns": [
+ "user_id"
+ ],
+ "isUnique": false
+ },
+ "slack_user_workspace_id_slack_team_id_slack_user_id_unique": {
+ "name": "slack_user_workspace_id_slack_team_id_slack_user_id_unique",
+ "columns": [
+ "workspace_id",
+ "slack_team_id",
+ "slack_user_id"
+ ],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "slack_user_workspace_id_workspace_id_fk": {
+ "name": "slack_user_workspace_id_workspace_id_fk",
+ "tableFrom": "slack_user",
+ "tableTo": "workspace",
+ "columnsFrom": [
+ "workspace_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "slack_user_user_id_user_id_fk": {
+ "name": "slack_user_user_id_user_id_fk",
+ "tableFrom": "slack_user",
+ "tableTo": "user",
+ "columnsFrom": [
+ "user_id"
+ ],
+ "columnsTo": [
+ "id"
+ ],
+ "onDelete": "no action",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {},
+ "checkConstraints": {}
+ }
+ },
+ "views": {},
+ "enums": {},
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ },
+ "internal": {
+ "indexes": {
+ "page_lower_slug_idx": {
+ "columns": {
+ "LOWER(\"slug\")": {
+ "isExpression": true
+ }
+ }
+ },
+ "page_lower_custom_domain_idx": {
+ "columns": {
+ "LOWER(\"custom_domain\")": {
+ "isExpression": true
+ }
+ }
+ },
+ "idx_page_subscriber_email_page_active": {
+ "columns": {
+ "LOWER(\"email\")": {
+ "isExpression": true
+ }
+ }
+ },
+ "idx_page_subscriber_webhook_page_active": {
+ "columns": {
+ "LOWER(\"webhook_url\")": {
+ "isExpression": true
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/packages/db/drizzle/meta/_journal.json b/packages/db/drizzle/meta/_journal.json
index 8e21a5033..c6a0a9957 100644
--- a/packages/db/drizzle/meta/_journal.json
+++ b/packages/db/drizzle/meta/_journal.json
@@ -645,6 +645,13 @@
"when": 1790864737627,
"tag": "0091_amused_wrecker",
"breakpoints": true
+ },
+ {
+ "idx": 92,
+ "version": "6",
+ "when": 1791455221245,
+ "tag": "0092_yielding_banshee",
+ "breakpoints": true
}
]
}
\ No newline at end of file
diff --git a/packages/db/src/schema/audit_logs/validation.ts b/packages/db/src/schema/audit_logs/validation.ts
index 3b9ccf93e..573840487 100644
--- a/packages/db/src/schema/audit_logs/validation.ts
+++ b/packages/db/src/schema/audit_logs/validation.ts
@@ -121,6 +121,18 @@ const maintenanceActions = [
action("maintenance.delete", "maintenance", intId),
] as const;
+const maintenanceUpdateActions = [
+ action("maintenance_update.create", "maintenance_update", intId, {
+ optionalMetadata: true,
+ }),
+ action("maintenance_update.update", "maintenance_update", intId, {
+ optionalMetadata: true,
+ }),
+ action("maintenance_update.delete", "maintenance_update", intId, {
+ optionalMetadata: true,
+ }),
+] as const;
+
const monitorIncidentActions = [
action("monitor_incident.update", "monitor_incident", intId),
action("monitor_incident.delete", "monitor_incident", intId),
@@ -249,6 +261,7 @@ export const auditActionSchema = z.discriminatedUnion("action", [
...userActions,
...workspaceActions,
...maintenanceActions,
+ ...maintenanceUpdateActions,
...monitorIncidentActions,
...incidentActions,
...incidentEventActions,
diff --git a/packages/db/src/schema/maintenances/maintenance.ts b/packages/db/src/schema/maintenances/maintenance.ts
index f7ea93240..77429a263 100644
--- a/packages/db/src/schema/maintenances/maintenance.ts
+++ b/packages/db/src/schema/maintenances/maintenance.ts
@@ -11,6 +11,8 @@ export const maintenance = sqliteTable(
{
id: integer("id").primaryKey(),
title: text("title", { length: 256 }).notNull(),
+ // deprecated: mirror of the first `maintenance_update` (backfilled in
+ // migration 0092); dropped in a follow-up
message: text("message").notNull(),
from: integer("from", { mode: "timestamp" }).notNull(),
@@ -37,8 +39,32 @@ export const maintenance = sqliteTable(
],
);
+export const maintenanceUpdate = sqliteTable(
+ "maintenance_update",
+ {
+ id: integer("id").primaryKey(),
+ message: text("message").notNull(),
+ date: integer("date", { mode: "timestamp" }).notNull(),
+ maintenanceId: integer("maintenance_id")
+ .references(() => maintenance.id, { onDelete: "cascade" })
+ .notNull(),
+
+ createdBy: integer("created_by").references(() => user.id),
+ updatedBy: integer("updated_by").references(() => user.id),
+
+ createdAt: integer("created_at", { mode: "timestamp" }).default(
+ sql`(strftime('%s', 'now'))`,
+ ),
+ updatedAt: integer("updated_at", { mode: "timestamp" }).default(
+ sql`(strftime('%s', 'now'))`,
+ ),
+ },
+ (t) => [index("maintenance_update_maintenance_id_idx").on(t.maintenanceId)],
+);
+
export const maintenanceRelations = relations(maintenance, ({ one, many }) => ({
maintenancesToPageComponents: many(maintenancesToPageComponents),
+ maintenanceUpdates: many(maintenanceUpdate),
page: one(page, {
fields: [maintenance.pageId],
references: [page.id],
@@ -58,3 +84,23 @@ export const maintenanceRelations = relations(maintenance, ({ one, many }) => ({
relationName: "maintenanceUpdatedBy",
}),
}));
+
+export const maintenanceUpdateRelations = relations(
+ maintenanceUpdate,
+ ({ one }) => ({
+ maintenance: one(maintenance, {
+ fields: [maintenanceUpdate.maintenanceId],
+ references: [maintenance.id],
+ }),
+ createdByUser: one(user, {
+ fields: [maintenanceUpdate.createdBy],
+ references: [user.id],
+ relationName: "maintenanceUpdateCreatedBy",
+ }),
+ updatedByUser: one(user, {
+ fields: [maintenanceUpdate.updatedBy],
+ references: [user.id],
+ relationName: "maintenanceUpdateUpdatedBy",
+ }),
+ }),
+);
diff --git a/packages/db/src/schema/maintenances/validation.ts b/packages/db/src/schema/maintenances/validation.ts
index 62ab02861..7c51199f0 100644
--- a/packages/db/src/schema/maintenances/validation.ts
+++ b/packages/db/src/schema/maintenances/validation.ts
@@ -1,7 +1,7 @@
import { createInsertSchema, createSelectSchema } from "drizzle-zod";
import { z } from "zod";
-import { maintenance } from "./maintenance";
+import { maintenance, maintenanceUpdate } from "./maintenance";
export const insertMaintenanceSchema = createInsertSchema(maintenance)
.extend({
@@ -25,5 +25,19 @@ export const selectMaintenanceSchema = createSelectSchema(maintenance).extend({
monitors: z.number().array().prefault([]).optional(),
});
+export const insertMaintenanceUpdateSchema = createInsertSchema(
+ maintenanceUpdate,
+).extend({
+ message: z.string().min(1),
+ date: z.coerce.date(),
+});
+
+export const selectMaintenanceUpdateSchema =
+ createSelectSchema(maintenanceUpdate);
+
export type InsertMaintenance = z.infer<typeof insertMaintenanceSchema>;
export type Maintenance = z.infer<typeof selectMaintenanceSchema>;
+export type InsertMaintenanceUpdate = z.infer<
+ typeof insertMaintenanceUpdateSchema
+>;
+export type MaintenanceUpdate = z.infer<typeof selectMaintenanceUpdateSchema>;
diff --git a/packages/db/src/schema/shared.ts b/packages/db/src/schema/shared.ts
index 8d16dc989..394ec71b7 100644
--- a/packages/db/src/schema/shared.ts
+++ b/packages/db/src/schema/shared.ts
@@ -1,6 +1,9 @@
import { z } from "zod";
-import { selectMaintenanceSchema } from "./maintenances";
+import {
+ selectMaintenanceSchema,
+ selectMaintenanceUpdateSchema,
+} from "./maintenances";
import { selectMonitorGroupSchema } from "./monitor_groups";
import { selectMonitorIncidentSchema } from "./monitor_incidents/validation";
import { selectMonitorSchema } from "./monitors";
@@ -62,6 +65,9 @@ export const selectStatusReportPageSchema = selectStatusReportSchema
export const selectMaintenancePageSchema = selectMaintenanceSchema
.omit(authorColumns)
.extend({
+ maintenanceUpdates: z
+ .array(selectMaintenanceUpdateSchema.omit(authorColumns))
+ .prefault([]),
maintenancesToPageComponents: z
.array(
z.object({
diff --git a/packages/db/src/seed.mts b/packages/db/src/seed.mts
index b000fe463..4a17e08de 100644
--- a/packages/db/src/seed.mts
+++ b/packages/db/src/seed.mts
@@ -8,6 +8,7 @@ import {
incidentEvent,
monitorIncidentTable,
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
monitor,
notification,
@@ -405,6 +406,34 @@ async function main() {
.onConflictDoNothing()
.run();
+ // the first update is the announcement; later ones are the timeline
+ await db
+ .insert(maintenanceUpdate)
+ .values([
+ {
+ id: 1,
+ maintenanceId: 1,
+ message:
+ "We will be performing database maintenance to improve performance. Some queries may be slower during this window.",
+ date: twentyDaysAgo,
+ },
+ {
+ id: 2,
+ maintenanceId: 1,
+ message: "Maintenance completed. All queries are back to full speed.",
+ date: twentyDaysAgoPlus2Hours,
+ },
+ {
+ id: 3,
+ maintenanceId: 2,
+ message:
+ "We will be upgrading our monitoring infrastructure to the latest version. Expect brief interruptions in data collection.",
+ date: new Date(),
+ },
+ ])
+ .onConflictDoNothing()
+ .run();
+
// Link status reports to page components
await db
.insert(statusReportsToPageComponents)
diff --git a/packages/proto/api/openstatus/maintenance/v1/maintenance.proto b/packages/proto/api/openstatus/maintenance/v1/maintenance.proto
index 131ed7870..48307a19d 100644
--- a/packages/proto/api/openstatus/maintenance/v1/maintenance.proto
+++ b/packages/proto/api/openstatus/maintenance/v1/maintenance.proto
@@ -4,6 +4,27 @@ package openstatus.maintenance.v1;
option go_package = "github.com/openstatushq/openstatus/packages/proto/openstatus/maintenance/v1;maintenancev1";
+// MaintenanceUpdate represents a timeline entry for a maintenance window.
+message MaintenanceUpdate {
+ // Unique identifier for the update.
+ string id = 1;
+
+ // Public update message.
+ string message = 2;
+
+ // Date of the update (RFC 3339 format).
+ string date = 3;
+
+ // ID of the maintenance this update belongs to.
+ string maintenance_id = 4;
+
+ // Timestamp when the update was created (RFC 3339 format).
+ string created_at = 5;
+
+ // Timestamp when the update was last updated (RFC 3339 format).
+ string updated_at = 6;
+}
+
// MaintenanceSummary represents metadata for a maintenance window (used in list responses).
message MaintenanceSummary {
// Unique identifier for the maintenance.
@@ -12,7 +33,7 @@ message MaintenanceSummary {
// Title of the maintenance.
string title = 2;
- // Message describing the maintenance.
+ // Message of the newest maintenance update.
string message = 3;
// Start time of the maintenance window (RFC 3339 format).
@@ -32,6 +53,7 @@ message MaintenanceSummary {
// Timestamp when the maintenance was last updated (RFC 3339 format).
string updated_at = 9;
+
}
// Maintenance represents a maintenance window with full details.
@@ -42,7 +64,7 @@ message Maintenance {
// Title of the maintenance.
string title = 2;
- // Message describing the maintenance.
+ // Message of the newest maintenance update.
string message = 3;
// Start time of the maintenance window (RFC 3339 format).
@@ -62,4 +84,7 @@ message Maintenance {
// Timestamp when the maintenance was last updated (RFC 3339 format).
string updated_at = 9;
+
+ // Full maintenance update timeline, newest first.
+ repeated MaintenanceUpdate updates = 10;
}
diff --git a/packages/proto/api/openstatus/maintenance/v1/service.proto b/packages/proto/api/openstatus/maintenance/v1/service.proto
index ba6e40cfe..f5fd47536 100644
--- a/packages/proto/api/openstatus/maintenance/v1/service.proto
+++ b/packages/proto/api/openstatus/maintenance/v1/service.proto
@@ -28,6 +28,15 @@ service MaintenanceService {
// DeleteMaintenance removes a maintenance window.
rpc DeleteMaintenance(DeleteMaintenanceRequest) returns (DeleteMaintenanceResponse);
+
+ // AddMaintenanceUpdate appends a public update to a maintenance timeline.
+ rpc AddMaintenanceUpdate(AddMaintenanceUpdateRequest) returns (AddMaintenanceUpdateResponse);
+
+ // UpdateMaintenanceUpdate edits an existing maintenance update.
+ rpc UpdateMaintenanceUpdate(UpdateMaintenanceUpdateRequest) returns (UpdateMaintenanceUpdateResponse);
+
+ // DeleteMaintenanceUpdate removes an existing maintenance update.
+ rpc DeleteMaintenanceUpdate(DeleteMaintenanceUpdateRequest) returns (DeleteMaintenanceUpdateResponse);
}
// CreateMaintenanceRequest is the request to create a new maintenance window.
@@ -41,7 +50,8 @@ message CreateMaintenanceRequest {
(gnostic.openapi.v3.property) = {example: {yaml: "Database Migration"}}
];
- // Message describing the maintenance (required).
+ // Message describing the maintenance (required). Posted as the first
+ // maintenance update.
string message = 2 [(buf.validate.field).string.min_len = 1];
// Start time of the maintenance window (RFC 3339 format, required).
@@ -119,7 +129,7 @@ message UpdateMaintenanceRequest {
max_len: 256
}];
- // New message for the maintenance (optional).
+ // Replaces the message of the newest maintenance update (optional).
optional string message = 3;
// New start time (RFC 3339 format, optional).
@@ -157,3 +167,54 @@ message DeleteMaintenanceResponse {
// Whether the deletion was successful.
bool success = 1;
}
+
+// AddMaintenanceUpdateRequest is the request to append a maintenance update.
+message AddMaintenanceUpdateRequest {
+ // ID of the maintenance to update (required).
+ string maintenance_id = 1 [(buf.validate.field).string.min_len = 1];
+
+ // Public update message (required).
+ string message = 2 [(buf.validate.field).string.min_len = 1];
+
+ // Optional date for the update (RFC 3339 format). Defaults to current time.
+ optional string date = 3 [(buf.validate.field).string.pattern = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$"];
+
+ // Whether to notify subscribers about this update.
+ optional bool notify = 4;
+}
+
+// AddMaintenanceUpdateResponse is the response after appending an update.
+message AddMaintenanceUpdateResponse {
+ // The created update.
+ MaintenanceUpdate maintenance_update = 1;
+}
+
+// UpdateMaintenanceUpdateRequest is the request to edit an update.
+message UpdateMaintenanceUpdateRequest {
+ // ID of the update to edit (required).
+ string id = 1 [(buf.validate.field).string.min_len = 1];
+
+ // New public message.
+ optional string message = 2 [(buf.validate.field).string.min_len = 1];
+
+ // New update date (RFC 3339 format).
+ optional string date = 3 [(buf.validate.field).string.pattern = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$"];
+}
+
+// UpdateMaintenanceUpdateResponse is the response after editing an update.
+message UpdateMaintenanceUpdateResponse {
+ // The updated timeline entry.
+ MaintenanceUpdate maintenance_update = 1;
+}
+
+// DeleteMaintenanceUpdateRequest is the request to remove an update.
+message DeleteMaintenanceUpdateRequest {
+ // ID of the update to remove (required).
+ string id = 1 [(buf.validate.field).string.min_len = 1];
+}
+
+// DeleteMaintenanceUpdateResponse is the response after removing an update.
+message DeleteMaintenanceUpdateResponse {
+ // Whether the deletion was successful.
+ bool success = 1;
+}
diff --git a/packages/proto/gen/openapi.yaml b/packages/proto/gen/openapi.yaml
index 6ae80571d..047485093 100644
--- a/packages/proto/gen/openapi.yaml
+++ b/packages/proto/gen/openapi.yaml
@@ -118,6 +118,45 @@ components:
- SERVING_STATUS_SERVING
- SERVING_STATUS_NOT_SERVING
description: ServingStatus represents the health status of the service.
+ openstatus.maintenance.v1.AddMaintenanceUpdateRequest:
+ type: object
+ properties:
+ maintenanceId:
+ type: string
+ title: maintenance_id
+ minLength: 1
+ description: ID of the maintenance to update (required).
+ message:
+ type: string
+ title: message
+ minLength: 1
+ description: Public update message (required).
+ date:
+ type:
+ - string
+ - "null"
+ title: date
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
+ description: Optional date for the update (RFC 3339 format). Defaults to current time.
+ notify:
+ type:
+ - boolean
+ - "null"
+ title: notify
+ description: Whether to notify subscribers about this update.
+ title: AddMaintenanceUpdateRequest
+ additionalProperties: false
+ description: AddMaintenanceUpdateRequest is the request to append a maintenance update.
+ openstatus.maintenance.v1.AddMaintenanceUpdateResponse:
+ type: object
+ properties:
+ maintenanceUpdate:
+ title: maintenance_update
+ description: The created update.
+ $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
+ title: AddMaintenanceUpdateResponse
+ additionalProperties: false
+ description: AddMaintenanceUpdateResponse is the response after appending an update.
openstatus.maintenance.v1.CreateMaintenanceRequest:
type: object
properties:
@@ -133,7 +172,9 @@ components:
type: string
title: message
minLength: 1
- description: Message describing the maintenance (required).
+ description: |-
+ Message describing the maintenance (required). Posted as the first
+ maintenance update.
from:
type: string
examples:
@@ -199,6 +240,27 @@ components:
title: DeleteMaintenanceResponse
additionalProperties: false
description: DeleteMaintenanceResponse is the response after deleting a maintenance window.
+ openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ title: id
+ minLength: 1
+ description: ID of the update to remove (required).
+ title: DeleteMaintenanceUpdateRequest
+ additionalProperties: false
+ description: DeleteMaintenanceUpdateRequest is the request to remove an update.
+ openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse:
+ type: object
+ properties:
+ success:
+ type: boolean
+ title: success
+ description: Whether the deletion was successful.
+ title: DeleteMaintenanceUpdateResponse
+ additionalProperties: false
+ description: DeleteMaintenanceUpdateResponse is the response after removing an update.
openstatus.maintenance.v1.GetMaintenanceRequest:
type: object
properties:
@@ -280,7 +342,7 @@ components:
message:
type: string
title: message
- description: Message describing the maintenance.
+ description: Message of the newest maintenance update.
from:
type: string
title: from
@@ -307,6 +369,12 @@ components:
type: string
title: updated_at
description: Timestamp when the maintenance was last updated (RFC 3339 format).
+ updates:
+ type: array
+ items:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
+ title: updates
+ description: Full maintenance update timeline, newest first.
title: Maintenance
additionalProperties: false
description: Maintenance represents a maintenance window with full details.
@@ -324,7 +392,7 @@ components:
message:
type: string
title: message
- description: Message describing the maintenance.
+ description: Message of the newest maintenance update.
from:
type: string
title: from
@@ -354,6 +422,36 @@ components:
title: MaintenanceSummary
additionalProperties: false
description: MaintenanceSummary represents metadata for a maintenance window (used in list responses).
+ openstatus.maintenance.v1.MaintenanceUpdate:
+ type: object
+ properties:
+ id:
+ type: string
+ title: id
+ description: Unique identifier for the update.
+ message:
+ type: string
+ title: message
+ description: Public update message.
+ date:
+ type: string
+ title: date
+ description: Date of the update (RFC 3339 format).
+ maintenanceId:
+ type: string
+ title: maintenance_id
+ description: ID of the maintenance this update belongs to.
+ createdAt:
+ type: string
+ title: created_at
+ description: Timestamp when the update was created (RFC 3339 format).
+ updatedAt:
+ type: string
+ title: updated_at
+ description: Timestamp when the update was last updated (RFC 3339 format).
+ title: MaintenanceUpdate
+ additionalProperties: false
+ description: MaintenanceUpdate represents a timeline entry for a maintenance window.
openstatus.maintenance.v1.UpdateMaintenanceRequest:
type: object
properties:
@@ -375,7 +473,7 @@ components:
- string
- "null"
title: message
- description: New message for the maintenance (optional).
+ description: Replaces the message of the newest maintenance update (optional).
from:
type:
- string
@@ -425,6 +523,41 @@ components:
title: UpdateMaintenanceResponse
additionalProperties: false
description: UpdateMaintenanceResponse is the response after updating a maintenance window.
+ openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ title: id
+ minLength: 1
+ description: ID of the update to edit (required).
+ message:
+ type:
+ - string
+ - "null"
+ title: message
+ minLength: 1
+ description: New public message.
+ date:
+ type:
+ - string
+ - "null"
+ title: date
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$
+ description: New update date (RFC 3339 format).
+ title: UpdateMaintenanceUpdateRequest
+ additionalProperties: false
+ description: UpdateMaintenanceUpdateRequest is the request to edit an update.
+ openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse:
+ type: object
+ properties:
+ maintenanceUpdate:
+ title: maintenance_update
+ description: The updated timeline entry.
+ $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceUpdate'
+ title: UpdateMaintenanceUpdateResponse
+ additionalProperties: false
+ description: UpdateMaintenanceUpdateResponse is the response after editing an update.
openstatus.monitor.v1.BodyAssertion:
type: object
properties:
@@ -5205,6 +5338,34 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/openstatus.health.v1.CheckResponse'
+ /rpc/openstatus.maintenance.v1.MaintenanceService/AddMaintenanceUpdate:
+ post:
+ tags:
+ - MaintenanceService
+ summary: AddMaintenanceUpdate
+ description: AddMaintenanceUpdate appends a public update to a maintenance timeline.
+ operationId: MaintenanceService_AddMaintenanceUpdate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateRequest'
+ required: true
+ responses:
+ "429":
+ $ref: '#/components/responses/RateLimited'
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.AddMaintenanceUpdateResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance:
post:
tags:
@@ -5261,6 +5422,34 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse'
+ /rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenanceUpdate:
+ post:
+ tags:
+ - MaintenanceService
+ summary: DeleteMaintenanceUpdate
+ description: DeleteMaintenanceUpdate removes an existing maintenance update.
+ operationId: MaintenanceService_DeleteMaintenanceUpdate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest'
+ required: true
+ responses:
+ "429":
+ $ref: '#/components/responses/RateLimited'
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse'
/rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance:
get:
tags:
@@ -5401,6 +5590,34 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse'
+ /rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenanceUpdate:
+ post:
+ tags:
+ - MaintenanceService
+ summary: UpdateMaintenanceUpdate
+ description: UpdateMaintenanceUpdate edits an existing maintenance update.
+ operationId: MaintenanceService_UpdateMaintenanceUpdate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest'
+ required: true
+ responses:
+ "429":
+ $ref: '#/components/responses/RateLimited'
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse'
/rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor:
post:
tags:
diff --git a/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts b/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts
index 5f4d0fa3b..1942a1f04 100644
--- a/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts
+++ b/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts
@@ -10,7 +10,63 @@ import type { Message } from "@bufbuild/protobuf";
* Describes the file openstatus/maintenance/v1/maintenance.proto.
*/
export const file_openstatus_maintenance_v1_maintenance: GenFile = /*@__PURE__*/
- fileDesc("CitvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL21haW50ZW5hbmNlLnByb3RvEhlvcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxIq8BChJNYWludGVuYW5jZVN1bW1hcnkSCgoCaWQYASABKAkSDQoFdGl0bGUYAiABKAkSDwoHbWVzc2FnZRgDIAEoCRIMCgRmcm9tGAQgASgJEgoKAnRvGAUgASgJEg8KB3BhZ2VfaWQYBiABKAkSGgoScGFnZV9jb21wb25lbnRfaWRzGAcgAygJEhIKCmNyZWF0ZWRfYXQYCCABKAkSEgoKdXBkYXRlZF9hdBgJIAEoCSKoAQoLTWFpbnRlbmFuY2USCgoCaWQYASABKAkSDQoFdGl0bGUYAiABKAkSDwoHbWVzc2FnZRgDIAEoCRIMCgRmcm9tGAQgASgJEgoKAnRvGAUgASgJEg8KB3BhZ2VfaWQYBiABKAkSGgoScGFnZV9jb21wb25lbnRfaWRzGAcgAygJEhIKCmNyZWF0ZWRfYXQYCCABKAkSEgoKdXBkYXRlZF9hdBgJIAEoCUJbWllnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvbWFpbnRlbmFuY2UvdjE7bWFpbnRlbmFuY2V2MWIGcHJvdG8z");
+ fileDesc("CitvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL21haW50ZW5hbmNlLnByb3RvEhlvcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxIn4KEU1haW50ZW5hbmNlVXBkYXRlEgoKAmlkGAEgASgJEg8KB21lc3NhZ2UYAiABKAkSDAoEZGF0ZRgDIAEoCRIWCg5tYWludGVuYW5jZV9pZBgEIAEoCRISCgpjcmVhdGVkX2F0GAUgASgJEhIKCnVwZGF0ZWRfYXQYBiABKAkirwEKEk1haW50ZW5hbmNlU3VtbWFyeRIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRIPCgdtZXNzYWdlGAMgASgJEgwKBGZyb20YBCABKAkSCgoCdG8YBSABKAkSDwoHcGFnZV9pZBgGIAEoCRIaChJwYWdlX2NvbXBvbmVudF9pZHMYByADKAkSEgoKY3JlYXRlZF9hdBgIIAEoCRISCgp1cGRhdGVkX2F0GAkgASgJIucBCgtNYWludGVuYW5jZRIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRIPCgdtZXNzYWdlGAMgASgJEgwKBGZyb20YBCABKAkSCgoCdG8YBSABKAkSDwoHcGFnZV9pZBgGIAEoCRIaChJwYWdlX2NvbXBvbmVudF9pZHMYByADKAkSEgoKY3JlYXRlZF9hdBgIIAEoCRISCgp1cGRhdGVkX2F0GAkgASgJEj0KB3VwZGF0ZXMYCiADKAsyLC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLk1haW50ZW5hbmNlVXBkYXRlQltaWWdpdGh1Yi5jb20vb3BlbnN0YXR1c2hxL29wZW5zdGF0dXMvcGFja2FnZXMvcHJvdG8vb3BlbnN0YXR1cy9tYWludGVuYW5jZS92MTttYWludGVuYW5jZXYxYgZwcm90bzM");
+
+/**
+ * MaintenanceUpdate represents a timeline entry for a maintenance window.
+ *
+ * @generated from message openstatus.maintenance.v1.MaintenanceUpdate
+ */
+export type MaintenanceUpdate = Message<"openstatus.maintenance.v1.MaintenanceUpdate"> & {
+ /**
+ * Unique identifier for the update.
+ *
+ * @generated from field: string id = 1;
+ */
+ id: string;
+
+ /**
+ * Public update message.
+ *
+ * @generated from field: string message = 2;
+ */
+ message: string;
+
+ /**
+ * Date of the update (RFC 3339 format).
+ *
+ * @generated from field: string date = 3;
+ */
+ date: string;
+
+ /**
+ * ID of the maintenance this update belongs to.
+ *
+ * @generated from field: string maintenance_id = 4;
+ */
+ maintenanceId: string;
+
+ /**
+ * Timestamp when the update was created (RFC 3339 format).
+ *
+ * @generated from field: string created_at = 5;
+ */
+ createdAt: string;
+
+ /**
+ * Timestamp when the update was last updated (RFC 3339 format).
+ *
+ * @generated from field: string updated_at = 6;
+ */
+ updatedAt: string;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.MaintenanceUpdate.
+ * Use `create(MaintenanceUpdateSchema)` to create a new message.
+ */
+export const MaintenanceUpdateSchema: GenMessage<MaintenanceUpdate> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_maintenance, 0);
/**
* MaintenanceSummary represents metadata for a maintenance window (used in list responses).
@@ -33,7 +89,7 @@ export type MaintenanceSummary = Message<"openstatus.maintenance.v1.MaintenanceS
title: string;
/**
- * Message describing the maintenance.
+ * Message of the newest maintenance update.
*
* @generated from field: string message = 3;
*/
@@ -87,7 +143,7 @@ export type MaintenanceSummary = Message<"openstatus.maintenance.v1.MaintenanceS
* Use `create(MaintenanceSummarySchema)` to create a new message.
*/
export const MaintenanceSummarySchema: GenMessage<MaintenanceSummary> = /*@__PURE__*/
- messageDesc(file_openstatus_maintenance_v1_maintenance, 0);
+ messageDesc(file_openstatus_maintenance_v1_maintenance, 1);
/**
* Maintenance represents a maintenance window with full details.
@@ -110,7 +166,7 @@ export type Maintenance = Message<"openstatus.maintenance.v1.Maintenance"> & {
title: string;
/**
- * Message describing the maintenance.
+ * Message of the newest maintenance update.
*
* @generated from field: string message = 3;
*/
@@ -157,6 +213,13 @@ export type Maintenance = Message<"openstatus.maintenance.v1.Maintenance"> & {
* @generated from field: string updated_at = 9;
*/
updatedAt: string;
+
+ /**
+ * Full maintenance update timeline, newest first.
+ *
+ * @generated from field: repeated openstatus.maintenance.v1.MaintenanceUpdate updates = 10;
+ */
+ updates: MaintenanceUpdate[];
};
/**
@@ -164,5 +227,5 @@ export type Maintenance = Message<"openstatus.maintenance.v1.Maintenance"> & {
* Use `create(MaintenanceSchema)` to create a new message.
*/
export const MaintenanceSchema: GenMessage<Maintenance> = /*@__PURE__*/
- messageDesc(file_openstatus_maintenance_v1_maintenance, 1);
+ messageDesc(file_openstatus_maintenance_v1_maintenance, 2);
diff --git a/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts b/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts
index 534798e82..045c9d254 100644
--- a/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts
+++ b/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts
@@ -6,7 +6,7 @@ import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegen
import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
import { file_buf_validate_validate } from "../../../buf/validate/validate_pb.ts";
import { file_gnostic_openapi_v3_annotations } from "../../../gnostic/openapi/v3/annotations_pb.ts";
-import type { Maintenance, MaintenanceSummary } from "./maintenance_pb.ts";
+import type { Maintenance, MaintenanceSummary, MaintenanceUpdate } from "./maintenance_pb.ts";
import { file_openstatus_maintenance_v1_maintenance } from "./maintenance_pb.ts";
import type { Message } from "@bufbuild/protobuf";
@@ -14,7 +14,7 @@ import type { Message } from "@bufbuild/protobuf";
* Describes the file openstatus/maintenance/v1/service.proto.
*/
export const file_openstatus_maintenance_v1_service: GenFile = /*@__PURE__*/
- fileDesc("CidvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL3NlcnZpY2UucHJvdG8SGW9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEirAMKGENyZWF0ZU1haW50ZW5hbmNlUmVxdWVzdBIyCgV0aXRsZRgBIAEoCUIjukcWOhQSEkRhdGFiYXNlIE1pZ3JhdGlvbrpIB3IFEAEYgAISGAoHbWVzc2FnZRgCIAEoCUIHukgEcgIQARJ2CgRmcm9tGAMgASgJQmi6Rxo6GBIWIjIwMjQtMDMtMDFUMDI6MDA6MDBaIrpISHJGMkReXGR7NH0tXGR7Mn0tXGR7Mn1UXGR7Mn06XGR7Mn06XGR7Mn0oXC5cZHsxLDl9KT8oWnxbKy1dXGR7Mn06XGR7Mn0pJBJ0CgJ0bxgEIAEoCUJoukcaOhgSFiIyMDI0LTAzLTAxVDA2OjAwOjAwWiK6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSQSGAoHcGFnZV9pZBgFIAEoCUIHukgEcgIQARIaChJwYWdlX2NvbXBvbmVudF9pZHMYBiADKAkSEwoGbm90aWZ5GAcgASgISACIAQFCCQoHX25vdGlmeSJYChlDcmVhdGVNYWludGVuYW5jZVJlc3BvbnNlEjsKC21haW50ZW5hbmNlGAEgASgLMiYub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5NYWludGVuYW5jZSIsChVHZXRNYWludGVuYW5jZVJlcXVlc3QSEwoCaWQYASABKAlCB7pIBHICEAEiVQoWR2V0TWFpbnRlbmFuY2VSZXNwb25zZRI7CgttYWludGVuYW5jZRgBIAEoCzImLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2UijQEKF0xpc3RNYWludGVuYW5jZXNSZXF1ZXN0Eh0KBWxpbWl0GAEgASgFQgm6SAYaBBhkKAFIAIgBARIcCgZvZmZzZXQYAiABKAVCB7pIBBoCKABIAYgBARIUCgdwYWdlX2lkGAMgASgJSAKIAQFCCAoGX2xpbWl0QgkKB19vZmZzZXRCCgoIX3BhZ2VfaWQicwoYTGlzdE1haW50ZW5hbmNlc1Jlc3BvbnNlEkMKDG1haW50ZW5hbmNlcxgBIAMoCzItLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2VTdW1tYXJ5EhIKCnRvdGFsX3NpemUYAiABKAUi0QMKGFVwZGF0ZU1haW50ZW5hbmNlUmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQARIeCgV0aXRsZRgCIAEoCUIKukgHcgUQARiAAkgAiAEBEhQKB21lc3NhZ2UYAyABKAlIAYgBARJeCgRmcm9tGAQgASgJQku6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSRIAogBARJcCgJ0bxgFIAEoCUJLukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkSAOIAQESGAoHcGFnZV9pZBgGIAEoCUICGAFIBIgBARIaChJwYWdlX2NvbXBvbmVudF9pZHMYByADKAkSJgoZdXBkYXRlX3BhZ2VfY29tcG9uZW50X2lkcxgIIAEoCEgFiAEBQggKBl90aXRsZUIKCghfbWVzc2FnZUIHCgVfZnJvbUIFCgNfdG9CCgoIX3BhZ2VfaWRCHAoaX3VwZGF0ZV9wYWdlX2NvbXBvbmVudF9pZHMiWAoZVXBkYXRlTWFpbnRlbmFuY2VSZXNwb25zZRI7CgttYWludGVuYW5jZRgBIAEoCzImLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2UiLwoYRGVsZXRlTWFpbnRlbmFuY2VSZXF1ZXN0EhMKAmlkGAEgASgJQge6SARyAhABIiwKGURlbGV0ZU1haW50ZW5hbmNlUmVzcG9uc2USDwoHc3VjY2VzcxgBIAEoCDKTBQoSTWFpbnRlbmFuY2VTZXJ2aWNlEn4KEUNyZWF0ZU1haW50ZW5hbmNlEjMub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5DcmVhdGVNYWludGVuYW5jZVJlcXVlc3QaNC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkNyZWF0ZU1haW50ZW5hbmNlUmVzcG9uc2USegoOR2V0TWFpbnRlbmFuY2USMC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkdldE1haW50ZW5hbmNlUmVxdWVzdBoxLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuR2V0TWFpbnRlbmFuY2VSZXNwb25zZSIDkAIBEoABChBMaXN0TWFpbnRlbmFuY2VzEjIub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5MaXN0TWFpbnRlbmFuY2VzUmVxdWVzdBozLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTGlzdE1haW50ZW5hbmNlc1Jlc3BvbnNlIgOQAgESfgoRVXBkYXRlTWFpbnRlbmFuY2USMy5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLlVwZGF0ZU1haW50ZW5hbmNlUmVxdWVzdBo0Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuVXBkYXRlTWFpbnRlbmFuY2VSZXNwb25zZRJ+ChFEZWxldGVNYWludGVuYW5jZRIzLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuRGVsZXRlTWFpbnRlbmFuY2VSZXF1ZXN0GjQub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5EZWxldGVNYWludGVuYW5jZVJlc3BvbnNlQltaWWdpdGh1Yi5jb20vb3BlbnN0YXR1c2hxL29wZW5zdGF0dXMvcGFja2FnZXMvcHJvdG8vb3BlbnN0YXR1cy9tYWludGVuYW5jZS92MTttYWludGVuYW5jZXYxYgZwcm90bzM", [file_buf_validate_validate, file_gnostic_openapi_v3_annotations, file_openstatus_maintenance_v1_maintenance]);
+ fileDesc("CidvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL3NlcnZpY2UucHJvdG8SGW9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEirAMKGENyZWF0ZU1haW50ZW5hbmNlUmVxdWVzdBIyCgV0aXRsZRgBIAEoCUIjukcWOhQSEkRhdGFiYXNlIE1pZ3JhdGlvbrpIB3IFEAEYgAISGAoHbWVzc2FnZRgCIAEoCUIHukgEcgIQARJ2CgRmcm9tGAMgASgJQmi6Rxo6GBIWIjIwMjQtMDMtMDFUMDI6MDA6MDBaIrpISHJGMkReXGR7NH0tXGR7Mn0tXGR7Mn1UXGR7Mn06XGR7Mn06XGR7Mn0oXC5cZHsxLDl9KT8oWnxbKy1dXGR7Mn06XGR7Mn0pJBJ0CgJ0bxgEIAEoCUJoukcaOhgSFiIyMDI0LTAzLTAxVDA2OjAwOjAwWiK6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSQSGAoHcGFnZV9pZBgFIAEoCUIHukgEcgIQARIaChJwYWdlX2NvbXBvbmVudF9pZHMYBiADKAkSEwoGbm90aWZ5GAcgASgISACIAQFCCQoHX25vdGlmeSJYChlDcmVhdGVNYWludGVuYW5jZVJlc3BvbnNlEjsKC21haW50ZW5hbmNlGAEgASgLMiYub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5NYWludGVuYW5jZSIsChVHZXRNYWludGVuYW5jZVJlcXVlc3QSEwoCaWQYASABKAlCB7pIBHICEAEiVQoWR2V0TWFpbnRlbmFuY2VSZXNwb25zZRI7CgttYWludGVuYW5jZRgBIAEoCzImLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2UijQEKF0xpc3RNYWludGVuYW5jZXNSZXF1ZXN0Eh0KBWxpbWl0GAEgASgFQgm6SAYaBBhkKAFIAIgBARIcCgZvZmZzZXQYAiABKAVCB7pIBBoCKABIAYgBARIUCgdwYWdlX2lkGAMgASgJSAKIAQFCCAoGX2xpbWl0QgkKB19vZmZzZXRCCgoIX3BhZ2VfaWQicwoYTGlzdE1haW50ZW5hbmNlc1Jlc3BvbnNlEkMKDG1haW50ZW5hbmNlcxgBIAMoCzItLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2VTdW1tYXJ5EhIKCnRvdGFsX3NpemUYAiABKAUi0QMKGFVwZGF0ZU1haW50ZW5hbmNlUmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQARIeCgV0aXRsZRgCIAEoCUIKukgHcgUQARiAAkgAiAEBEhQKB21lc3NhZ2UYAyABKAlIAYgBARJeCgRmcm9tGAQgASgJQku6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSRIAogBARJcCgJ0bxgFIAEoCUJLukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkSAOIAQESGAoHcGFnZV9pZBgGIAEoCUICGAFIBIgBARIaChJwYWdlX2NvbXBvbmVudF9pZHMYByADKAkSJgoZdXBkYXRlX3BhZ2VfY29tcG9uZW50X2lkcxgIIAEoCEgFiAEBQggKBl90aXRsZUIKCghfbWVzc2FnZUIHCgVfZnJvbUIFCgNfdG9CCgoIX3BhZ2VfaWRCHAoaX3VwZGF0ZV9wYWdlX2NvbXBvbmVudF9pZHMiWAoZVXBkYXRlTWFpbnRlbmFuY2VSZXNwb25zZRI7CgttYWludGVuYW5jZRgBIAEoCzImLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2UiLwoYRGVsZXRlTWFpbnRlbmFuY2VSZXF1ZXN0EhMKAmlkGAEgASgJQge6SARyAhABIiwKGURlbGV0ZU1haW50ZW5hbmNlUmVzcG9uc2USDwoHc3VjY2VzcxgBIAEoCCLhAQobQWRkTWFpbnRlbmFuY2VVcGRhdGVSZXF1ZXN0Eh8KDm1haW50ZW5hbmNlX2lkGAEgASgJQge6SARyAhABEhgKB21lc3NhZ2UYAiABKAlCB7pIBHICEAESXgoEZGF0ZRgDIAEoCUJLukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkSACIAQESEwoGbm90aWZ5GAQgASgISAGIAQFCBwoFX2RhdGVCCQoHX25vdGlmeSJoChxBZGRNYWludGVuYW5jZVVwZGF0ZVJlc3BvbnNlEkgKEm1haW50ZW5hbmNlX3VwZGF0ZRgBIAEoCzIsLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2VVcGRhdGUiyQEKHlVwZGF0ZU1haW50ZW5hbmNlVXBkYXRlUmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQARIdCgdtZXNzYWdlGAIgASgJQge6SARyAhABSACIAQESXgoEZGF0ZRgDIAEoCUJLukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkSAGIAQFCCgoIX21lc3NhZ2VCBwoFX2RhdGUiawofVXBkYXRlTWFpbnRlbmFuY2VVcGRhdGVSZXNwb25zZRJIChJtYWludGVuYW5jZV91cGRhdGUYASABKAsyLC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLk1haW50ZW5hbmNlVXBkYXRlIjUKHkRlbGV0ZU1haW50ZW5hbmNlVXBkYXRlUmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQASIyCh9EZWxldGVNYWludGVuYW5jZVVwZGF0ZVJlc3BvbnNlEg8KB3N1Y2Nlc3MYASABKAgywwgKEk1haW50ZW5hbmNlU2VydmljZRJ+ChFDcmVhdGVNYWludGVuYW5jZRIzLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuQ3JlYXRlTWFpbnRlbmFuY2VSZXF1ZXN0GjQub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5DcmVhdGVNYWludGVuYW5jZVJlc3BvbnNlEnoKDkdldE1haW50ZW5hbmNlEjAub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5HZXRNYWludGVuYW5jZVJlcXVlc3QaMS5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkdldE1haW50ZW5hbmNlUmVzcG9uc2UiA5ACARKAAQoQTGlzdE1haW50ZW5hbmNlcxIyLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTGlzdE1haW50ZW5hbmNlc1JlcXVlc3QaMy5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkxpc3RNYWludGVuYW5jZXNSZXNwb25zZSIDkAIBEn4KEVVwZGF0ZU1haW50ZW5hbmNlEjMub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5VcGRhdGVNYWludGVuYW5jZVJlcXVlc3QaNC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLlVwZGF0ZU1haW50ZW5hbmNlUmVzcG9uc2USfgoRRGVsZXRlTWFpbnRlbmFuY2USMy5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkRlbGV0ZU1haW50ZW5hbmNlUmVxdWVzdBo0Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuRGVsZXRlTWFpbnRlbmFuY2VSZXNwb25zZRKHAQoUQWRkTWFpbnRlbmFuY2VVcGRhdGUSNi5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkFkZE1haW50ZW5hbmNlVXBkYXRlUmVxdWVzdBo3Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuQWRkTWFpbnRlbmFuY2VVcGRhdGVSZXNwb25zZRKQAQoXVXBkYXRlTWFpbnRlbmFuY2VVcGRhdGUSOS5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLlVwZGF0ZU1haW50ZW5hbmNlVXBkYXRlUmVxdWVzdBo6Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuVXBkYXRlTWFpbnRlbmFuY2VVcGRhdGVSZXNwb25zZRKQAQoXRGVsZXRlTWFpbnRlbmFuY2VVcGRhdGUSOS5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkRlbGV0ZU1haW50ZW5hbmNlVXBkYXRlUmVxdWVzdBo6Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuRGVsZXRlTWFpbnRlbmFuY2VVcGRhdGVSZXNwb25zZUJbWllnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvbWFpbnRlbmFuY2UvdjE7bWFpbnRlbmFuY2V2MWIGcHJvdG8z", [file_buf_validate_validate, file_gnostic_openapi_v3_annotations, file_openstatus_maintenance_v1_maintenance]);
/**
* CreateMaintenanceRequest is the request to create a new maintenance window.
@@ -30,7 +30,8 @@ export type CreateMaintenanceRequest = Message<"openstatus.maintenance.v1.Create
title: string;
/**
- * Message describing the maintenance (required).
+ * Message describing the maintenance (required). Posted as the first
+ * maintenance update.
*
* @generated from field: string message = 2;
*/
@@ -226,7 +227,7 @@ export type UpdateMaintenanceRequest = Message<"openstatus.maintenance.v1.Update
title?: string | undefined;
/**
- * New message for the maintenance (optional).
+ * Replaces the message of the newest maintenance update (optional).
*
* @generated from field: optional string message = 3;
*/
@@ -341,6 +342,167 @@ export type DeleteMaintenanceResponse = Message<"openstatus.maintenance.v1.Delet
export const DeleteMaintenanceResponseSchema: GenMessage<DeleteMaintenanceResponse> = /*@__PURE__*/
messageDesc(file_openstatus_maintenance_v1_service, 9);
+/**
+ * AddMaintenanceUpdateRequest is the request to append a maintenance update.
+ *
+ * @generated from message openstatus.maintenance.v1.AddMaintenanceUpdateRequest
+ */
+export type AddMaintenanceUpdateRequest = Message<"openstatus.maintenance.v1.AddMaintenanceUpdateRequest"> & {
+ /**
+ * ID of the maintenance to update (required).
+ *
+ * @generated from field: string maintenance_id = 1;
+ */
+ maintenanceId: string;
+
+ /**
+ * Public update message (required).
+ *
+ * @generated from field: string message = 2;
+ */
+ message: string;
+
+ /**
+ * Optional date for the update (RFC 3339 format). Defaults to current time.
+ *
+ * @generated from field: optional string date = 3;
+ */
+ date?: string | undefined;
+
+ /**
+ * Whether to notify subscribers about this update.
+ *
+ * @generated from field: optional bool notify = 4;
+ */
+ notify?: boolean | undefined;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.AddMaintenanceUpdateRequest.
+ * Use `create(AddMaintenanceUpdateRequestSchema)` to create a new message.
+ */
+export const AddMaintenanceUpdateRequestSchema: GenMessage<AddMaintenanceUpdateRequest> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_service, 10);
+
+/**
+ * AddMaintenanceUpdateResponse is the response after appending an update.
+ *
+ * @generated from message openstatus.maintenance.v1.AddMaintenanceUpdateResponse
+ */
+export type AddMaintenanceUpdateResponse = Message<"openstatus.maintenance.v1.AddMaintenanceUpdateResponse"> & {
+ /**
+ * The created update.
+ *
+ * @generated from field: openstatus.maintenance.v1.MaintenanceUpdate maintenance_update = 1;
+ */
+ maintenanceUpdate?: MaintenanceUpdate | undefined;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.AddMaintenanceUpdateResponse.
+ * Use `create(AddMaintenanceUpdateResponseSchema)` to create a new message.
+ */
+export const AddMaintenanceUpdateResponseSchema: GenMessage<AddMaintenanceUpdateResponse> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_service, 11);
+
+/**
+ * UpdateMaintenanceUpdateRequest is the request to edit an update.
+ *
+ * @generated from message openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest
+ */
+export type UpdateMaintenanceUpdateRequest = Message<"openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest"> & {
+ /**
+ * ID of the update to edit (required).
+ *
+ * @generated from field: string id = 1;
+ */
+ id: string;
+
+ /**
+ * New public message.
+ *
+ * @generated from field: optional string message = 2;
+ */
+ message?: string | undefined;
+
+ /**
+ * New update date (RFC 3339 format).
+ *
+ * @generated from field: optional string date = 3;
+ */
+ date?: string | undefined;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.UpdateMaintenanceUpdateRequest.
+ * Use `create(UpdateMaintenanceUpdateRequestSchema)` to create a new message.
+ */
+export const UpdateMaintenanceUpdateRequestSchema: GenMessage<UpdateMaintenanceUpdateRequest> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_service, 12);
+
+/**
+ * UpdateMaintenanceUpdateResponse is the response after editing an update.
+ *
+ * @generated from message openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse
+ */
+export type UpdateMaintenanceUpdateResponse = Message<"openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse"> & {
+ /**
+ * The updated timeline entry.
+ *
+ * @generated from field: openstatus.maintenance.v1.MaintenanceUpdate maintenance_update = 1;
+ */
+ maintenanceUpdate?: MaintenanceUpdate | undefined;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.UpdateMaintenanceUpdateResponse.
+ * Use `create(UpdateMaintenanceUpdateResponseSchema)` to create a new message.
+ */
+export const UpdateMaintenanceUpdateResponseSchema: GenMessage<UpdateMaintenanceUpdateResponse> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_service, 13);
+
+/**
+ * DeleteMaintenanceUpdateRequest is the request to remove an update.
+ *
+ * @generated from message openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest
+ */
+export type DeleteMaintenanceUpdateRequest = Message<"openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest"> & {
+ /**
+ * ID of the update to remove (required).
+ *
+ * @generated from field: string id = 1;
+ */
+ id: string;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.DeleteMaintenanceUpdateRequest.
+ * Use `create(DeleteMaintenanceUpdateRequestSchema)` to create a new message.
+ */
+export const DeleteMaintenanceUpdateRequestSchema: GenMessage<DeleteMaintenanceUpdateRequest> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_service, 14);
+
+/**
+ * DeleteMaintenanceUpdateResponse is the response after removing an update.
+ *
+ * @generated from message openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse
+ */
+export type DeleteMaintenanceUpdateResponse = Message<"openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse"> & {
+ /**
+ * Whether the deletion was successful.
+ *
+ * @generated from field: bool success = 1;
+ */
+ success: boolean;
+};
+
+/**
+ * Describes the message openstatus.maintenance.v1.DeleteMaintenanceUpdateResponse.
+ * Use `create(DeleteMaintenanceUpdateResponseSchema)` to create a new message.
+ */
+export const DeleteMaintenanceUpdateResponseSchema: GenMessage<DeleteMaintenanceUpdateResponse> = /*@__PURE__*/
+ messageDesc(file_openstatus_maintenance_v1_service, 15);
+
/**
* MaintenanceService provides CRUD operations for maintenance windows.
*
@@ -397,6 +559,36 @@ export const MaintenanceService: GenService<{
input: typeof DeleteMaintenanceRequestSchema;
output: typeof DeleteMaintenanceResponseSchema;
},
+ /**
+ * AddMaintenanceUpdate appends a public update to a maintenance timeline.
+ *
+ * @generated from rpc openstatus.maintenance.v1.MaintenanceService.AddMaintenanceUpdate
+ */
+ addMaintenanceUpdate: {
+ methodKind: "unary";
+ input: typeof AddMaintenanceUpdateRequestSchema;
+ output: typeof AddMaintenanceUpdateResponseSchema;
+ },
+ /**
+ * UpdateMaintenanceUpdate edits an existing maintenance update.
+ *
+ * @generated from rpc openstatus.maintenance.v1.MaintenanceService.UpdateMaintenanceUpdate
+ */
+ updateMaintenanceUpdate: {
+ methodKind: "unary";
+ input: typeof UpdateMaintenanceUpdateRequestSchema;
+ output: typeof UpdateMaintenanceUpdateResponseSchema;
+ },
+ /**
+ * DeleteMaintenanceUpdate removes an existing maintenance update.
+ *
+ * @generated from rpc openstatus.maintenance.v1.MaintenanceService.DeleteMaintenanceUpdate
+ */
+ deleteMaintenanceUpdate: {
+ methodKind: "unary";
+ input: typeof DeleteMaintenanceUpdateRequestSchema;
+ output: typeof DeleteMaintenanceUpdateResponseSchema;
+ },
}> = /*@__PURE__*/
serviceDesc(file_openstatus_maintenance_v1_service, 0);
diff --git a/packages/services/src/agent-tools/__tests__/maintenance-updates.test.ts b/packages/services/src/agent-tools/__tests__/maintenance-updates.test.ts
new file mode 100644
index 000000000..7687bdecf
--- /dev/null
+++ b/packages/services/src/agent-tools/__tests__/maintenance-updates.test.ts
@@ -0,0 +1,52 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+
+import { agentTools, buildAgentSystemPrompt } from "../index";
+
+describe("maintenance update agent tools", () => {
+ test("registers write-scoped CRUD tools", () => {
+ expect(agentTools.add_maintenance_update.scope).toBe("write");
+ expect(agentTools.update_maintenance_update.scope).toBe("write");
+ expect(agentTools.delete_maintenance_update.scope).toBe("write");
+ });
+
+ test("rejects id-only update payloads", () => {
+ expect(
+ agentTools.update_maintenance_update.inputSchema.safeParse({
+ id: 1,
+ }).success,
+ ).toBe(false);
+ expect(
+ agentTools.update_maintenance_update.inputSchema.safeParse({
+ id: 1,
+ message: "corrected",
+ }).success,
+ ).toBe(true);
+ });
+
+ test("requires an explicit notify decision when adding an update", () => {
+ expect(
+ agentTools.add_maintenance_update.inputSchema.safeParse({
+ maintenanceId: 1,
+ message: "Update",
+ }).success,
+ ).toBe(false);
+ expect(
+ agentTools.add_maintenance_update.inputSchema.safeParse({
+ maintenanceId: 1,
+ message: "Update",
+ notify: false,
+ }).success,
+ ).toBe(true);
+ });
+
+ test("includes maintenance updates in notification guidance", () => {
+ const prompt = buildAgentSystemPrompt({
+ workspaceName: "Test",
+ surface: "dashboard",
+ canNotifySubscribers: true,
+ });
+ expect(prompt).toContain("add_maintenance_update");
+ expect(prompt).toContain("Should I notify subscribers? yes/no");
+ });
+});
diff --git a/packages/services/src/agent-tools/index.ts b/packages/services/src/agent-tools/index.ts
index 89503aafc..23ad177b6 100644
--- a/packages/services/src/agent-tools/index.ts
+++ b/packages/services/src/agent-tools/index.ts
@@ -17,7 +17,13 @@ import {
setIncidentStatusTool,
updateIncidentTool,
} from "./incident";
-import { createMaintenanceTool, listMaintenancesTool } from "./maintenance";
+import {
+ addMaintenanceUpdateTool,
+ createMaintenanceTool,
+ deleteMaintenanceUpdateTool,
+ listMaintenancesTool,
+ updateMaintenanceUpdateTool,
+} from "./maintenance";
import {
getMonitorStatusTool,
getMonitorSummaryTool,
@@ -54,7 +60,13 @@ export {
setIncidentStatusTool,
updateIncidentTool,
} from "./incident";
-export { createMaintenanceTool, listMaintenancesTool } from "./maintenance";
+export {
+ addMaintenanceUpdateTool,
+ createMaintenanceTool,
+ deleteMaintenanceUpdateTool,
+ listMaintenancesTool,
+ updateMaintenanceUpdateTool,
+} from "./maintenance";
export {
getMonitorStatusTool,
getMonitorSummaryTool,
@@ -120,6 +132,9 @@ export const agentTools = {
approve_postmortem: approvePostmortemTool,
list_maintenances: listMaintenancesTool,
create_maintenance: createMaintenanceTool,
+ add_maintenance_update: addMaintenanceUpdateTool,
+ update_maintenance_update: updateMaintenanceUpdateTool,
+ delete_maintenance_update: deleteMaintenanceUpdateTool,
list_monitors: listMonitorsTool,
get_monitor: getMonitorTool,
get_monitor_status: getMonitorStatusTool,
diff --git a/packages/services/src/agent-tools/maintenance.ts b/packages/services/src/agent-tools/maintenance.ts
index 467e98589..8485f734d 100644
--- a/packages/services/src/agent-tools/maintenance.ts
+++ b/packages/services/src/agent-tools/maintenance.ts
@@ -2,9 +2,12 @@ import { z } from "zod";
import { attributedUserSchema, toAgentUser } from "../attribution";
import {
+ addMaintenanceUpdate,
createMaintenance,
+ deleteMaintenanceUpdate,
listMaintenances,
notifyMaintenance,
+ updateMaintenanceUpdate,
} from "../maintenance";
import type { AgentTool } from "./types";
@@ -58,6 +61,13 @@ const ListMaintenancesOutput = z.object({
to: z.string(),
pageId: z.number().int().nullable(),
pageComponentIds: z.array(z.number().int()),
+ updates: z.array(
+ z.object({
+ id: z.number().int(),
+ message: z.string(),
+ date: z.string(),
+ }),
+ ),
createdBy: attributedUserSchema.nullable(),
updatedBy: attributedUserSchema.nullable(),
}),
@@ -76,7 +86,7 @@ export const listMaintenancesTool: AgentTool<
> = {
name: "list_maintenances",
description:
- "List maintenance windows in this workspace, newest first. Paginated via `page` (1-indexed) and `perPage`.",
+ "List maintenance windows in this workspace, newest first. Returns timeline update ids so edit/delete can target a specific entry. Paginated via `page` (1-indexed) and `perPage`.",
scope: "read",
destructive: false,
inputSchema: ListMaintenancesInputShape,
@@ -101,6 +111,11 @@ export const listMaintenancesTool: AgentTool<
to: m.to.toISOString(),
pageId: m.pageId,
pageComponentIds: m.pageComponentIds,
+ updates: m.updates.map((u) => ({
+ id: u.id,
+ message: u.message,
+ date: u.date.toISOString(),
+ })),
createdBy: toAgentUser(m.createdByUser),
updatedBy: toAgentUser(m.updatedByUser),
})),
@@ -119,7 +134,9 @@ const CreateMaintenanceInputShape = z.object({
message: z
.string()
.min(1)
- .describe("Public message describing the work, shown on the page."),
+ .describe(
+ "Public message describing the work; posted as the first timeline update.",
+ ),
from: z.iso
.datetime()
.describe("Start time, ISO 8601 (e.g. 2026-04-30T14:00:00Z)."),
@@ -197,7 +214,7 @@ export const createMaintenanceTool: AgentTool<
verb: "scheduled",
},
async run({ ctx, input }) {
- const record = await createMaintenance({
+ const { maintenance: record, initialUpdate } = await createMaintenance({
ctx,
input: {
title: input.title,
@@ -211,11 +228,10 @@ export const createMaintenanceTool: AgentTool<
let notified = false;
if (input.notify) {
try {
- await notifyMaintenance({
+ notified = await notifyMaintenance({
ctx,
- input: { maintenanceId: record.id },
+ input: { maintenanceUpdateId: initialUpdate.id },
});
- notified = true;
} catch (err) {
console.warn("notifyMaintenance failed after create_maintenance", err);
}
@@ -230,3 +246,182 @@ export const createMaintenanceTool: AgentTool<
};
},
};
+
+const AddMaintenanceUpdateInputShape = z.object({
+ maintenanceId: z
+ .number()
+ .int()
+ .describe("Maintenance id from list_maintenances — never guess."),
+ message: z.string().min(1).describe("Public update message."),
+ date: z.iso
+ .datetime()
+ .optional()
+ .describe("Update time in ISO 8601. Defaults to now."),
+ notify: z
+ .boolean()
+ .describe("Whether to dispatch subscriber notifications for this update."),
+});
+
+const MaintenanceUpdateOutput = z.object({
+ id: z.number().int(),
+ maintenanceId: z.number().int(),
+ message: z.string(),
+ date: z.string(),
+ notified: z.boolean().optional(),
+});
+
+export const addMaintenanceUpdateTool: AgentTool<
+ z.infer<typeof AddMaintenanceUpdateInputShape>,
+ z.infer<typeof MaintenanceUpdateOutput>
+> = {
+ name: "add_maintenance_update",
+ description:
+ "Append a public update to an existing maintenance. PUBLIC, AUDIT-LOGGED, AND POTENTIALLY NOTIFIES SUBSCRIBERS. The maintenanceId MUST come from list_maintenances. Subscriber notification is only available during this call.",
+ scope: "write",
+ destructive: true,
+ inputSchema: AddMaintenanceUpdateInputShape,
+ outputSchema: MaintenanceUpdateOutput,
+ approval: {
+ extraFlags: [{ id: "notify", label: "Notify subscribers" }],
+ applyFlags: (input, flags) => ({ ...input, notify: flags.notify ?? false }),
+ summarize: (input) => ({
+ title: `Publish Maintenance Update #${input.maintenanceId}`,
+ lines: [
+ { label: "Maintenance ID", value: String(input.maintenanceId) },
+ ...(input.date
+ ? [{ label: "Date", value: formatMaintenanceDate(input.date) }]
+ : []),
+ { label: "Message", value: input.message },
+ ],
+ }),
+ verb: "published",
+ },
+ async run({ ctx, input }) {
+ const update = await addMaintenanceUpdate({
+ ctx,
+ input: {
+ maintenanceId: input.maintenanceId,
+ message: input.message,
+ date: input.date ? new Date(input.date) : undefined,
+ },
+ });
+ let notified = false;
+ if (input.notify) {
+ try {
+ notified = await notifyMaintenance({
+ ctx,
+ input: { maintenanceUpdateId: update.id },
+ });
+ } catch (err) {
+ console.warn(
+ "notifyMaintenance failed after add_maintenance_update",
+ err,
+ );
+ }
+ }
+ return {
+ id: update.id,
+ maintenanceId: update.maintenanceId,
+ message: update.message,
+ date: update.date.toISOString(),
+ notified,
+ };
+ },
+};
+
+const UpdateMaintenanceUpdateInputShape = z
+ .object({
+ id: z
+ .number()
+ .int()
+ .describe(
+ "Maintenance update id from list_maintenances (or create/add result) — never guess.",
+ ),
+ message: z
+ .string()
+ .min(1)
+ .optional()
+ .describe("Replacement public message."),
+ date: z.iso.datetime().optional().describe("Replacement ISO 8601 date."),
+ })
+ .refine((input) => input.message !== undefined || input.date !== undefined, {
+ message: "At least one field must be provided.",
+ });
+
+export const updateMaintenanceUpdateTool: AgentTool<
+ z.infer<typeof UpdateMaintenanceUpdateInputShape>,
+ z.infer<typeof MaintenanceUpdateOutput>
+> = {
+ name: "update_maintenance_update",
+ description:
+ "Edit an existing maintenance timeline entry. PUBLIC and AUDIT-LOGGED. Does not notify subscribers. The update id MUST come from list_maintenances (or a prior create/add result).",
+ scope: "write",
+ destructive: true,
+ inputSchema: UpdateMaintenanceUpdateInputShape,
+ outputSchema: MaintenanceUpdateOutput,
+ approval: {
+ summarize: (input) => ({
+ title: `Edit Maintenance Update #${input.id}`,
+ lines: [
+ ...(input.date
+ ? [{ label: "Date", value: formatMaintenanceDate(input.date) }]
+ : []),
+ ...(input.message ? [{ label: "Message", value: input.message }] : []),
+ ],
+ }),
+ verb: "updated",
+ },
+ async run({ ctx, input }) {
+ const update = await updateMaintenanceUpdate({
+ ctx,
+ input: {
+ id: input.id,
+ message: input.message,
+ date: input.date ? new Date(input.date) : undefined,
+ },
+ });
+ return {
+ id: update.id,
+ maintenanceId: update.maintenanceId,
+ message: update.message,
+ date: update.date.toISOString(),
+ };
+ },
+};
+
+const DeleteMaintenanceUpdateInputShape = z.object({
+ id: z
+ .number()
+ .int()
+ .describe(
+ "Maintenance update id from list_maintenances (or create/add result) — never guess.",
+ ),
+});
+const DeleteMaintenanceUpdateOutput = z.object({
+ id: z.number().int(),
+ success: z.boolean(),
+});
+
+export const deleteMaintenanceUpdateTool: AgentTool<
+ z.infer<typeof DeleteMaintenanceUpdateInputShape>,
+ z.infer<typeof DeleteMaintenanceUpdateOutput>
+> = {
+ name: "delete_maintenance_update",
+ description:
+ "Delete a maintenance timeline entry. PUBLIC, AUDIT-LOGGED, AND IRREVERSIBLE. A maintenance must retain at least one update. The update id MUST come from list_maintenances (or a prior create/add result).",
+ scope: "write",
+ destructive: true,
+ inputSchema: DeleteMaintenanceUpdateInputShape,
+ outputSchema: DeleteMaintenanceUpdateOutput,
+ approval: {
+ summarize: (input) => ({
+ title: `Delete Maintenance Update #${input.id}`,
+ lines: [{ label: "Update ID", value: String(input.id) }],
+ }),
+ verb: "deleted",
+ },
+ async run({ ctx, input }) {
+ await deleteMaintenanceUpdate({ ctx, input });
+ return { id: input.id, success: true };
+ },
+};
diff --git a/packages/services/src/agent-tools/prompt.ts b/packages/services/src/agent-tools/prompt.ts
index 025dd0d1b..d321d594f 100644
--- a/packages/services/src/agent-tools/prompt.ts
+++ b/packages/services/src/agent-tools/prompt.ts
@@ -54,9 +54,9 @@ Managed incidents (internal):
// Workspaces without subscriber notify get a different rubric — asking
// is wasted friction when the field is a server-side no-op anyway.
const notifyStep = opts.canNotifySubscribers
- ? `3. For tools with a notify flag (create_status_report, add_status_report_update, resolve_status_report, create_maintenance) ALWAYS ask explicitly: "Should I notify subscribers? yes/no" — never infer the answer.
+ ? `3. For tools with a notify flag (create_status_report, add_status_report_update, resolve_status_report, create_maintenance, add_maintenance_update) ALWAYS ask explicitly: "Should I notify subscribers? yes/no" — never infer the answer.
4. Only call the tool once the user has confirmed BOTH the content AND the notify decision.`
- : `3. This workspace plan does NOT support subscriber notifications. For any tool with a notify flag (create_status_report, add_status_report_update, resolve_status_report, create_maintenance) ALWAYS pass \`notify: false\`. Do NOT ask the user about notifications — they would be a no-op anyway. Do NOT mention notifications in your draft.
+ : `3. This workspace plan does NOT support subscriber notifications. For any tool with a notify flag (create_status_report, add_status_report_update, resolve_status_report, create_maintenance, add_maintenance_update) ALWAYS pass \`notify: false\`. Do NOT ask the user about notifications — they would be a no-op anyway. Do NOT mention notifications in your draft.
4. Only call the tool once the user has confirmed the content.`;
return `${preamble}You are the openstatus assistant for workspace "${opts.workspaceName}".
@@ -96,6 +96,7 @@ Docs knowledge base:
Lifecycle:
- Status reports flow: create_status_report once → add_status_report_update repeatedly → resolve_status_report.
+- Maintenance communication flows: create_maintenance once → add_maintenance_update for public progress. Use update_maintenance_update only to correct an existing entry and delete_maintenance_update only when the entry must be removed.
- "provide an update", "we found the cause", "still investigating" → add_status_report_update.
- "rename the report", "add a component" → update_status_report (metadata only — does not notify).
- "it's fixed", "incident is resolved" → resolve_status_report (publishes a final update).
diff --git a/packages/services/src/import/phase-writers.ts b/packages/services/src/import/phase-writers.ts
index 6ab1ef1ce..a545bdc99 100644
--- a/packages/services/src/import/phase-writers.ts
+++ b/packages/services/src/import/phase-writers.ts
@@ -1,6 +1,7 @@
import { and, count, eq, isNull } from "@openstatus/db";
import {
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
monitor,
page,
@@ -636,6 +637,19 @@ export async function writeMaintenancesPhase(
continue;
}
+ // the message is the first timeline update; the announcement time
+ // of imported history is unknown, so it is dated at the window start
+ const [insertedUpdate] = await tx
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: inserted.id,
+ message: data.message,
+ date: data.from,
+ createdBy: actorUserId,
+ updatedBy: actorUserId,
+ })
+ .returning();
+
const componentLinks: Array<{
maintenanceId: number;
pageComponentId: number;
@@ -667,6 +681,18 @@ export async function writeMaintenancesPhase(
}),
after: inserted,
});
+ if (insertedUpdate) {
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.create",
+ entityType: "maintenance_update",
+ entityId: insertedUpdate.id,
+ metadata: auditMeta(pc, {
+ sourceId: resource.sourceId,
+ maintenanceId: inserted.id,
+ }),
+ after: insertedUpdate,
+ });
+ }
} catch (err) {
resource.status = "failed";
resource.error = err instanceof Error ? err.message : String(err);
diff --git a/packages/services/src/maintenance/__tests__/attribution.test.ts b/packages/services/src/maintenance/__tests__/attribution.test.ts
index b128a9bdc..bb46958ea 100644
--- a/packages/services/src/maintenance/__tests__/attribution.test.ts
+++ b/packages/services/src/maintenance/__tests__/attribution.test.ts
@@ -47,7 +47,7 @@ function range() {
}
async function create(ctx: ServiceContext, title: string) {
- return createMaintenance({
+ const { maintenance } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-${title}`,
@@ -57,6 +57,7 @@ async function create(ctx: ServiceContext, title: string) {
pageComponentIds: [],
},
});
+ return maintenance;
}
describe("maintenance attribution", () => {
diff --git a/packages/services/src/maintenance/__tests__/maintenance.test.ts b/packages/services/src/maintenance/__tests__/maintenance.test.ts
index fbb992421..98cdcb359 100644
--- a/packages/services/src/maintenance/__tests__/maintenance.test.ts
+++ b/packages/services/src/maintenance/__tests__/maintenance.test.ts
@@ -1,5 +1,6 @@
import { db, eq, inArray } from "@openstatus/db";
import {
+ maintenanceUpdate,
maintenancesToPageComponents,
page,
pageComponent,
@@ -23,11 +24,14 @@ import {
} from "../../../test/helpers";
import type { ServiceContext } from "../../context";
import { ConflictError, ForbiddenError, NotFoundError } from "../../errors";
+import { addMaintenanceUpdate } from "../add-update";
import { createMaintenance } from "../create";
import { deleteMaintenance } from "../delete";
+import { deleteMaintenanceUpdate } from "../delete-update";
import { getMaintenance, listMaintenances } from "../list";
import { notifyMaintenance } from "../notify";
import { updateMaintenance } from "../update";
+import { updateMaintenanceUpdate } from "../update-update";
const subscriptionSpies = (globalThis as Record<string, unknown>)
.__subscriptionSpies as
@@ -137,7 +141,7 @@ describe("createMaintenance", () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
const range = futureRange();
- const record = await createMaintenance({
+ const { maintenance: record, initialUpdate } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-happy`,
@@ -150,6 +154,9 @@ describe("createMaintenance", () => {
expect(record.title).toBe(`${TEST_PREFIX}-happy`);
expect(record.pageId).toBe(testPageId);
+ expect(initialUpdate.maintenanceId).toBe(record.id);
+ expect(initialUpdate.message).toBe("planned work");
+ expect(initialUpdate.createdBy).toBe(1);
const assoc = await tx
.select()
@@ -167,6 +174,13 @@ describe("createMaintenance", () => {
entityId: record.id,
db: tx,
});
+ await expectAuditRow({
+ workspaceId: teamCtx.workspace.id,
+ action: "maintenance_update.create",
+ entityType: "maintenance_update",
+ entityId: initialUpdate.id,
+ db: tx,
+ });
});
});
@@ -212,7 +226,7 @@ describe("createMaintenance", () => {
// Duplicate ids in the input would violate the composite PK on
// `maintenances_to_page_components` if not deduped. Guard against a
// regression where the `Set` in `validatePageComponentIds` is dropped.
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx: { ...teamCtx, db: tx },
input: {
title: `${TEST_PREFIX}-dedupe`,
@@ -280,7 +294,7 @@ describe("updateMaintenance", () => {
test("updates title + replaces associations", async () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-update`,
@@ -310,10 +324,53 @@ describe("updateMaintenance", () => {
});
});
+ test("message rewrites the newest update and audits it", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ const { maintenance: record, initialUpdate } = await createMaintenance({
+ ctx,
+ input: {
+ title: `${TEST_PREFIX}-update-message`,
+ message: "first",
+ ...futureRange(),
+ pageId: testPageId,
+ pageComponentIds: [],
+ },
+ });
+ const later = await addMaintenanceUpdate({
+ ctx,
+ input: {
+ maintenanceId: record.id,
+ message: "second",
+ date: new Date(Date.now() + 1000),
+ },
+ });
+
+ await updateMaintenance({
+ ctx,
+ input: { id: record.id, message: "second, edited" },
+ });
+
+ const full = await getMaintenance({ ctx, input: { id: record.id } });
+ expect(full.message).toBe("second, edited");
+ expect(full.updates.map((u) => [u.id, u.message])).toEqual([
+ [later.id, "second, edited"],
+ [initialUpdate.id, "first"],
+ ]);
+ await expectAuditRow({
+ workspaceId: teamCtx.workspace.id,
+ action: "maintenance_update.update",
+ entityType: "maintenance_update",
+ entityId: later.id,
+ db: tx,
+ });
+ });
+ });
+
test("keeps pageId when clearing all components", async () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-keep-page`,
@@ -342,7 +399,7 @@ describe("updateMaintenance", () => {
test("moves pageId when components belong to another page", async () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-move-page`,
@@ -363,7 +420,7 @@ describe("updateMaintenance", () => {
test("throws NotFoundError for cross-workspace update", async () => {
await withTestTransaction(async (tx) => {
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx: { ...teamCtx, db: tx },
input: {
title: `${TEST_PREFIX}-cross-ws-update`,
@@ -390,7 +447,7 @@ describe("updateMaintenance", () => {
// `{from, to}` submissions. A partial update that moves only `to`
// earlier than the stored `from` has to be rejected by the service's
// own effective-range check. Regression guard for that code path.
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-range-update`,
@@ -413,7 +470,7 @@ describe("updateMaintenance", () => {
test("throws ConflictError when pageComponentIds span multiple pages", async () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-update-mixed-pages`,
@@ -441,7 +498,7 @@ describe("deleteMaintenance", () => {
test("cascades associations", async () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-delete`,
@@ -469,7 +526,7 @@ describe("list / get", () => {
await withTestTransaction(async (tx) => {
const teamCtxTx = { ...teamCtx, db: tx };
const freeCtxTx = { ...freeCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx: teamCtxTx,
input: {
title: `${TEST_PREFIX}-isolation`,
@@ -500,7 +557,7 @@ describe("list / get", () => {
test("list returns totalSize and enriched relations", async () => {
await withTestTransaction(async (tx) => {
const ctx = { ...teamCtx, db: tx };
- const record = await createMaintenance({
+ const { maintenance: record } = await createMaintenance({
ctx,
input: {
title: `${TEST_PREFIX}-list-enrich`,
@@ -524,9 +581,9 @@ describe("list / get", () => {
});
describe("notifyMaintenance", () => {
- test("throws when maintenance belongs to another workspace", async () => {
+ test("throws when the announcement belongs to another workspace", async () => {
await withTestTransaction(async (tx) => {
- const record = await createMaintenance({
+ const { initialUpdate } = await createMaintenance({
ctx: { ...teamCtx, db: tx },
input: {
title: `${TEST_PREFIX}-notify-cross-ws`,
@@ -540,42 +597,308 @@ describe("notifyMaintenance", () => {
await expect(
notifyMaintenance({
ctx: { ...freeCtx, db: tx },
- input: { maintenanceId: record.id },
+ input: { maintenanceUpdateId: initialUpdate.id },
}),
).rejects.toBeInstanceOf(ForbiddenError);
});
});
-});
-describe("slack actor path", () => {
- test("createMaintenance succeeds with a slack actor", async () => {
+ describe("slack actor path", () => {
+ test("createMaintenance succeeds with a slack actor", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = {
+ ...makeSlackCtx(teamCtx.workspace, {
+ teamId: "T123",
+ slackUserId: "U123",
+ userId: 1,
+ }),
+ db: tx,
+ };
+ const { maintenance: record } = await createMaintenance({
+ ctx,
+ input: {
+ title: `${TEST_PREFIX}-slack`,
+ message: "scheduled via slack",
+ ...futureRange(),
+ pageId: testPageId,
+ pageComponentIds: [],
+ },
+ });
+ await expectAuditRow({
+ workspaceId: teamCtx.workspace.id,
+ action: "maintenance.create",
+ entityType: "maintenance",
+ entityId: record.id,
+ actorType: "slack",
+ db: tx,
+ });
+ });
+ });
+ });
+
+ describe("maintenance updates", () => {
+ async function createParent(ctx: ServiceContext, suffix: string) {
+ const { maintenance } = await createMaintenance({
+ ctx,
+ input: {
+ title: `${TEST_PREFIX}-${suffix}`,
+ message: "announcement",
+ ...futureRange(),
+ pageId: testPageId,
+ pageComponentIds: [],
+ },
+ });
+ return maintenance;
+ }
+
+ test("creates, edits, deletes, stamps attribution, touches parent, audits", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ // a second actor on the same workspace: every timeline write must
+ // flip the parent's `updatedBy`, which the creator alone cannot show
+ const editorCtx = {
+ ...makeUserCtx(teamCtx.workspace, { userId: 2 }),
+ db: tx,
+ };
+ const parent = await createParent(ctx, "updates");
+ const before = await getMaintenance({ ctx, input: { id: parent.id } });
+ expect(before.updates.map((u) => u.message)).toEqual(["announcement"]);
+ expect(before.updatedBy).toBe(1);
+
+ const date = new Date("2026-06-20T00:15:00.000Z");
+ const created = await addMaintenanceUpdate({
+ ctx: editorCtx,
+ input: { maintenanceId: parent.id, message: "work started", date },
+ });
+ expect(created.message).toBe("work started");
+ expect(created.date.getTime()).toBe(date.getTime());
+ expect(created.createdBy).toBe(2);
+ expect(created.updatedBy).toBe(2);
+ const afterAdd = await getMaintenance({
+ ctx,
+ input: { id: parent.id },
+ });
+ expect(afterAdd.updatedBy).toBe(2);
+
+ const edited = await updateMaintenanceUpdate({
+ ctx,
+ input: { id: created.id, message: "work resumed" },
+ });
+ expect(edited.message).toBe("work resumed");
+ expect(edited.date.getTime()).toBe(date.getTime());
+
+ // `message` follows the newest update by date — the backdated note
+ // does not become the public message
+ const full = await getMaintenance({ ctx, input: { id: parent.id } });
+ expect(full.message).toBe("announcement");
+ expect(full.updates.map((u) => u.message)).toEqual([
+ "announcement",
+ "work resumed",
+ ]);
+ // the edit by user 1 flipped the parent back from the editor
+ expect(full.updatedBy).toBe(1);
+
+ await deleteMaintenanceUpdate({
+ ctx: editorCtx,
+ input: { id: created.id },
+ });
+ const gone = await tx
+ .select()
+ .from(maintenanceUpdate)
+ .where(eq(maintenanceUpdate.id, created.id))
+ .get();
+ expect(gone).toBeUndefined();
+ const afterDelete = await getMaintenance({
+ ctx,
+ input: { id: parent.id },
+ });
+ expect(afterDelete.updatedBy).toBe(2);
+
+ for (const action of [
+ "maintenance_update.create",
+ "maintenance_update.update",
+ "maintenance_update.delete",
+ ] as const) {
+ await expectAuditRow({
+ workspaceId: teamCtx.workspace.id,
+ action,
+ entityType: "maintenance_update",
+ entityId: created.id,
+ db: tx,
+ });
+ }
+ });
+ });
+
+ test("rejects future-dated updates", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ const parent = await createParent(ctx, "future-update");
+ const future = new Date(Date.now() + 10 * 60 * 1000);
+ await expect(
+ addMaintenanceUpdate({
+ ctx,
+ input: { maintenanceId: parent.id, message: "later", date: future },
+ }),
+ ).rejects.toThrow("Date cannot be in the future.");
+ const [first] = (
+ await getMaintenance({ ctx, input: { id: parent.id } })
+ ).updates;
+ await expect(
+ updateMaintenanceUpdate({
+ ctx,
+ input: { id: first.id, date: future },
+ }),
+ ).rejects.toThrow("Date cannot be in the future.");
+ });
+ });
+
+ test("the last update cannot be removed", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ const parent = await createParent(ctx, "last-update");
+ const note = await addMaintenanceUpdate({
+ ctx,
+ input: {
+ maintenanceId: parent.id,
+ message: "note",
+ date: new Date(Date.now() + 1000),
+ },
+ });
+ let full = await getMaintenance({ ctx, input: { id: parent.id } });
+ expect(full.message).toBe("note");
+
+ await deleteMaintenanceUpdate({ ctx, input: { id: note.id } });
+ full = await getMaintenance({ ctx, input: { id: parent.id } });
+ expect(full.updates).toHaveLength(1);
+ expect(full.message).toBe("announcement");
+
+ await expect(
+ deleteMaintenanceUpdate({ ctx, input: { id: full.updates[0].id } }),
+ ).rejects.toBeInstanceOf(ConflictError);
+ });
+ });
+
+ test("scopes update rows to the workspace", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ const parent = await createParent(ctx, "scoped");
+ const created = await addMaintenanceUpdate({
+ ctx,
+ input: { maintenanceId: parent.id, message: "team only" },
+ });
+ const foreign = { ...freeCtx, db: tx };
+
+ await expect(
+ addMaintenanceUpdate({
+ ctx: foreign,
+ input: { maintenanceId: parent.id, message: "nope" },
+ }),
+ ).rejects.toBeInstanceOf(NotFoundError);
+ await expect(
+ updateMaintenanceUpdate({
+ ctx: foreign,
+ input: { id: created.id, message: "nope" },
+ }),
+ ).rejects.toBeInstanceOf(NotFoundError);
+ await expect(
+ deleteMaintenanceUpdate({ ctx: foreign, input: { id: created.id } }),
+ ).rejects.toBeInstanceOf(NotFoundError);
+ });
+ });
+
+ test("rejects read-only actors", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ const parent = await createParent(ctx, "read-only");
+ const created = await addMaintenanceUpdate({
+ ctx,
+ input: { maintenanceId: parent.id, message: "x" },
+ });
+ const readOnly = {
+ ...makeApiKeyCtx(teamCtx.workspace, {
+ keyId: "k-read",
+ userId: 1,
+ scopes: ["read"],
+ }),
+ db: tx,
+ };
+
+ await expect(
+ addMaintenanceUpdate({
+ ctx: readOnly,
+ input: { maintenanceId: parent.id, message: "x" },
+ }),
+ ).rejects.toBeInstanceOf(ForbiddenError);
+ await expect(
+ updateMaintenanceUpdate({
+ ctx: readOnly,
+ input: { id: created.id, message: "x" },
+ }),
+ ).rejects.toBeInstanceOf(ForbiddenError);
+ await expect(
+ deleteMaintenanceUpdate({ ctx: readOnly, input: { id: created.id } }),
+ ).rejects.toBeInstanceOf(ForbiddenError);
+ });
+ });
+ });
+
+ test("throws when a later update belongs to another workspace", async () => {
await withTestTransaction(async (tx) => {
- const ctx = {
- ...makeSlackCtx(teamCtx.workspace, {
- teamId: "T123",
- slackUserId: "U123",
- userId: 1,
+ const ctx = { ...teamCtx, db: tx };
+ const { maintenance: parent } = await createMaintenance({
+ ctx,
+ input: {
+ title: `${TEST_PREFIX}-notify-update-ws`,
+ message: "m",
+ ...futureRange(),
+ pageId: testPageId,
+ pageComponentIds: [],
+ },
+ });
+ const created = await addMaintenanceUpdate({
+ ctx,
+ input: { maintenanceId: parent.id, message: "x" },
+ });
+ await expect(
+ notifyMaintenance({
+ ctx: { ...freeCtx, db: tx },
+ input: { maintenanceUpdateId: created.id },
}),
- db: tx,
- };
- const record = await createMaintenance({
+ ).rejects.toBeInstanceOf(ForbiddenError);
+ });
+ });
+
+ test("returns false when the plan disables status-subscribers", async () => {
+ await withTestTransaction(async (tx) => {
+ const ctx = { ...teamCtx, db: tx };
+ const { maintenance: parent } = await createMaintenance({
ctx,
input: {
- title: `${TEST_PREFIX}-slack`,
- message: "scheduled via slack",
+ title: `${TEST_PREFIX}-notify-update-gated`,
+ message: "m",
...futureRange(),
pageId: testPageId,
pageComponentIds: [],
},
});
- await expectAuditRow({
- workspaceId: teamCtx.workspace.id,
- action: "maintenance.create",
- entityType: "maintenance",
- entityId: record.id,
- actorType: "slack",
- db: tx,
+ const created = await addMaintenanceUpdate({
+ ctx,
+ input: { maintenanceId: parent.id, message: "x" },
});
+ const gated: ServiceContext = {
+ ...ctx,
+ workspace: {
+ ...teamCtx.workspace,
+ limits: { ...teamCtx.workspace.limits, "status-subscribers": false },
+ },
+ };
+ expect(
+ await notifyMaintenance({
+ ctx: gated,
+ input: { maintenanceUpdateId: created.id },
+ }),
+ ).toBe(false);
});
});
});
diff --git a/packages/services/src/maintenance/add-update.ts b/packages/services/src/maintenance/add-update.ts
new file mode 100644
index 000000000..dd768543d
--- /dev/null
+++ b/packages/services/src/maintenance/add-update.ts
@@ -0,0 +1,67 @@
+import { eq } from "@openstatus/db";
+import { maintenance, maintenanceUpdate } from "@openstatus/db/src/schema";
+
+import { emitAudit } from "../audit";
+import { requireScope } from "../auth";
+import {
+ type ServiceContext,
+ tryGetActorUserId,
+ withTransaction,
+} from "../context";
+import type { MaintenanceUpdate } from "../types";
+import { getMaintenanceInWorkspace } from "./internal";
+import { AddMaintenanceUpdateInput } from "./schemas";
+
+export async function addMaintenanceUpdate(args: {
+ ctx: ServiceContext;
+ input: AddMaintenanceUpdateInput;
+}): Promise<MaintenanceUpdate> {
+ const { ctx } = args;
+ requireScope(ctx, "write");
+ const input = AddMaintenanceUpdateInput.parse(args.input);
+ const actorUserId = tryGetActorUserId(ctx.actor);
+
+ return withTransaction(ctx, async (tx) => {
+ const record = await getMaintenanceInWorkspace({
+ tx,
+ id: input.maintenanceId,
+ workspaceId: ctx.workspace.id,
+ });
+
+ const created = await tx
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: record.id,
+ message: input.message,
+ date: input.date ?? new Date(),
+ createdBy: actorUserId,
+ updatedBy: actorUserId,
+ })
+ .returning()
+ .get();
+
+ await touchMaintenance(tx, record.id, actorUserId);
+
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.create",
+ entityType: "maintenance_update",
+ entityId: created.id,
+ after: created,
+ metadata: { maintenanceId: record.id },
+ });
+
+ return created;
+ });
+}
+
+/** Timeline writes bump the parent so feeds and caches see a change. */
+export async function touchMaintenance(
+ tx: Parameters<Parameters<typeof withTransaction>[1]>[0],
+ maintenanceId: number,
+ actorUserId: number | null,
+): Promise<void> {
+ await tx
+ .update(maintenance)
+ .set({ updatedAt: new Date(), updatedBy: actorUserId })
+ .where(eq(maintenance.id, maintenanceId));
+}
diff --git a/packages/services/src/maintenance/create.ts b/packages/services/src/maintenance/create.ts
index dc9b3294b..de544ed7f 100644
--- a/packages/services/src/maintenance/create.ts
+++ b/packages/services/src/maintenance/create.ts
@@ -1,4 +1,4 @@
-import { maintenance } from "@openstatus/db/src/schema";
+import { maintenance, maintenanceUpdate } from "@openstatus/db/src/schema";
import { emitAudit } from "../audit";
import { requireScope } from "../auth";
@@ -8,7 +8,7 @@ import {
withTransaction,
} from "../context";
import { ConflictError } from "../errors";
-import type { Maintenance } from "../types";
+import type { Maintenance, MaintenanceUpdate } from "../types";
import {
assertPageInWorkspace,
updatePageComponentAssociations,
@@ -16,10 +16,15 @@ import {
} from "./internal";
import { CreateMaintenanceInput } from "./schemas";
+export type CreateMaintenanceResult = {
+ maintenance: Maintenance;
+ initialUpdate: MaintenanceUpdate;
+};
+
export async function createMaintenance(args: {
ctx: ServiceContext;
input: CreateMaintenanceInput;
-}): Promise<Maintenance> {
+}): Promise<CreateMaintenanceResult> {
const { ctx } = args;
requireScope(ctx, "write");
const input = CreateMaintenanceInput.parse(args.input);
@@ -50,6 +55,7 @@ export async function createMaintenance(args: {
workspaceId: ctx.workspace.id,
pageId: input.pageId,
title: input.title,
+ // deprecated column: mirrors the first update until it is dropped
message: input.message,
from: input.from,
to: input.to,
@@ -65,6 +71,18 @@ export async function createMaintenance(args: {
componentIds: validated.componentIds,
});
+ const initialUpdate = await tx
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: record.id,
+ message: input.message,
+ date: input.date ?? new Date(),
+ createdBy: actorUserId,
+ updatedBy: actorUserId,
+ })
+ .returning()
+ .get();
+
await emitAudit(tx, ctx, {
action: "maintenance.create",
entityType: "maintenance",
@@ -72,6 +90,14 @@ export async function createMaintenance(args: {
after: record,
});
- return record;
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.create",
+ entityType: "maintenance_update",
+ entityId: initialUpdate.id,
+ after: initialUpdate,
+ metadata: { maintenanceId: record.id },
+ });
+
+ return { maintenance: record, initialUpdate };
});
}
diff --git a/packages/services/src/maintenance/delete-update.ts b/packages/services/src/maintenance/delete-update.ts
new file mode 100644
index 000000000..f44ec5308
--- /dev/null
+++ b/packages/services/src/maintenance/delete-update.ts
@@ -0,0 +1,57 @@
+import { eq, sql } from "@openstatus/db";
+import { maintenanceUpdate } from "@openstatus/db/src/schema";
+
+import { emitAudit } from "../audit";
+import { requireScope } from "../auth";
+import {
+ type ServiceContext,
+ tryGetActorUserId,
+ withTransaction,
+} from "../context";
+import { ConflictError } from "../errors";
+import { touchMaintenance } from "./add-update";
+import { getMaintenanceUpdateInWorkspace } from "./internal";
+import { DeleteMaintenanceUpdateInput } from "./schemas";
+
+export async function deleteMaintenanceUpdate(args: {
+ ctx: ServiceContext;
+ input: DeleteMaintenanceUpdateInput;
+}): Promise<void> {
+ const { ctx } = args;
+ requireScope(ctx, "write");
+ const input = DeleteMaintenanceUpdateInput.parse(args.input);
+ const actorUserId = tryGetActorUserId(ctx.actor);
+
+ await withTransaction(ctx, async (tx) => {
+ const existing = await getMaintenanceUpdateInWorkspace({
+ tx,
+ id: input.id,
+ workspaceId: ctx.workspace.id,
+ });
+
+ // the newest update is the maintenance's public message
+ const remaining = await tx
+ .select({ count: sql<number>`count(*)` })
+ .from(maintenanceUpdate)
+ .where(eq(maintenanceUpdate.maintenanceId, existing.maintenanceId))
+ .get();
+ if ((remaining?.count ?? 0) <= 1) {
+ throw new ConflictError(
+ "A maintenance needs at least one update. Delete the maintenance instead.",
+ );
+ }
+
+ await tx
+ .delete(maintenanceUpdate)
+ .where(eq(maintenanceUpdate.id, existing.id));
+ await touchMaintenance(tx, existing.maintenanceId, actorUserId);
+
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.delete",
+ entityType: "maintenance_update",
+ entityId: existing.id,
+ before: existing,
+ metadata: { maintenanceId: existing.maintenanceId },
+ });
+ });
+}
diff --git a/packages/services/src/maintenance/get-update.ts b/packages/services/src/maintenance/get-update.ts
new file mode 100644
index 000000000..44221c253
--- /dev/null
+++ b/packages/services/src/maintenance/get-update.ts
@@ -0,0 +1,17 @@
+import { type ServiceContext, getReadDb } from "../context";
+import type { MaintenanceUpdate } from "../types";
+import { getMaintenanceUpdateInWorkspace } from "./internal";
+import { GetMaintenanceUpdateInput } from "./schemas";
+
+export async function getMaintenanceUpdate(args: {
+ ctx: ServiceContext;
+ input: GetMaintenanceUpdateInput;
+}): Promise<MaintenanceUpdate> {
+ const { ctx } = args;
+ const input = GetMaintenanceUpdateInput.parse(args.input);
+ return getMaintenanceUpdateInWorkspace({
+ tx: getReadDb(ctx),
+ id: input.id,
+ workspaceId: ctx.workspace.id,
+ });
+}
diff --git a/packages/services/src/maintenance/index.ts b/packages/services/src/maintenance/index.ts
index 143d1d23c..3d492dac1 100644
--- a/packages/services/src/maintenance/index.ts
+++ b/packages/services/src/maintenance/index.ts
@@ -1,22 +1,32 @@
-export { createMaintenance } from "./create";
+export { addMaintenanceUpdate } from "./add-update";
+export { type CreateMaintenanceResult, createMaintenance } from "./create";
export { deleteMaintenance } from "./delete";
+export { deleteMaintenanceUpdate } from "./delete-update";
+export { getMaintenanceUpdate } from "./get-update";
export {
getMaintenance,
listMaintenances,
type ListMaintenancesResult,
+ type MaintenanceUpdateWithRelations,
type MaintenanceWithRelations,
} from "./list";
export { notifyMaintenance } from "./notify";
export { updateMaintenance } from "./update";
+export { updateMaintenanceUpdate } from "./update-update";
+export { latestMaintenanceUpdate } from "./utils";
export {
+ AddMaintenanceUpdateInput,
CreateMaintenanceInput,
DeleteMaintenanceInput,
+ DeleteMaintenanceUpdateInput,
GetMaintenanceInput,
+ GetMaintenanceUpdateInput,
ListMaintenancesInput,
type MaintenanceListPeriod,
maintenanceListPeriodSchema,
maintenanceListPeriods,
NotifyMaintenanceInput,
UpdateMaintenanceInput,
+ UpdateMaintenanceUpdateInput,
} from "./schemas";
diff --git a/packages/services/src/maintenance/internal.ts b/packages/services/src/maintenance/internal.ts
index f603a63ff..707b6f885 100644
--- a/packages/services/src/maintenance/internal.ts
+++ b/packages/services/src/maintenance/internal.ts
@@ -1,6 +1,7 @@
import { and, eq, inArray } from "@openstatus/db";
import {
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
page,
pageComponent,
@@ -115,3 +116,24 @@ export async function getMaintenanceInWorkspace(args: {
if (!row) throw new NotFoundError("maintenance", id);
return row;
}
+
+export async function getMaintenanceUpdateInWorkspace(args: {
+ tx: DB;
+ id: number;
+ workspaceId: number;
+}) {
+ const { tx, id, workspaceId } = args;
+ const row = await tx
+ .select({ update: maintenanceUpdate })
+ .from(maintenanceUpdate)
+ .innerJoin(maintenance, eq(maintenance.id, maintenanceUpdate.maintenanceId))
+ .where(
+ and(
+ eq(maintenanceUpdate.id, id),
+ eq(maintenance.workspaceId, workspaceId),
+ ),
+ )
+ .get();
+ if (!row) throw new NotFoundError("maintenance_update", id);
+ return row.update;
+}
diff --git a/packages/services/src/maintenance/list.ts b/packages/services/src/maintenance/list.ts
index 5d6a587e4..793aca2ca 100644
--- a/packages/services/src/maintenance/list.ts
+++ b/packages/services/src/maintenance/list.ts
@@ -11,6 +11,7 @@ import {
} from "@openstatus/db";
import {
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
pageComponent,
selectPageComponentSchema,
@@ -18,13 +19,14 @@ import {
import { type AttributedUserDetail, loadAttributedUsers } from "../attribution";
import type { DB, ServiceContext } from "../context";
-import type { Maintenance, PageComponent } from "../types";
+import type { Maintenance, MaintenanceUpdate, PageComponent } from "../types";
import { getMaintenanceInWorkspace } from "./internal";
import {
GetMaintenanceInput,
ListMaintenancesInput,
type MaintenanceListPeriod,
} from "./schemas";
+import { latestMaintenanceUpdate } from "./utils";
function periodToSince(period: MaintenanceListPeriod): Date {
const day = 24 * 60 * 60 * 1000;
@@ -39,7 +41,16 @@ function periodToSince(period: MaintenanceListPeriod): Date {
}
}
+type Attributed = {
+ createdByUser: AttributedUserDetail | null;
+ updatedByUser: AttributedUserDetail | null;
+};
+
+export type MaintenanceUpdateWithRelations = MaintenanceUpdate & Attributed;
+
export type MaintenanceWithRelations = Maintenance & {
+ /** Newest first. `message` on the row is the newest update's text. */
+ updates: MaintenanceUpdateWithRelations[];
pageComponents: PageComponent[];
pageComponentIds: number[];
createdByUser: AttributedUserDetail | null;
@@ -63,6 +74,13 @@ async function enrichMaintenancesBatch(
if (rows.length === 0) return [];
const ids = rows.map((r) => r.id);
+ const allUpdates = await db
+ .select()
+ .from(maintenanceUpdate)
+ .where(inArray(maintenanceUpdate.maintenanceId, ids))
+ .orderBy(desc(maintenanceUpdate.date), desc(maintenanceUpdate.id))
+ .all();
+
// Explicit column selection (not `select()`) keeps the row shape in our
// hands instead of relying on drizzle's auto-derived `row.<table_name>`
// keys, which are named after the JS variable and silently break on
@@ -80,10 +98,30 @@ async function enrichMaintenancesBatch(
.where(inArray(maintenancesToPageComponents.maintenanceId, ids))
.all();
- const users = await loadAttributedUsers(
- db,
- rows.flatMap((r) => [r.createdBy, r.updatedBy]),
- );
+ const users = await loadAttributedUsers(db, [
+ ...rows.flatMap((r) => [r.createdBy, r.updatedBy]),
+ ...allUpdates.flatMap((u) => [u.createdBy, u.updatedBy]),
+ ]);
+ const attributed = (row: {
+ createdBy: number | null;
+ updatedBy: number | null;
+ }): Attributed => ({
+ createdByUser:
+ row.createdBy != null ? (users.get(row.createdBy) ?? null) : null,
+ updatedByUser:
+ row.updatedBy != null ? (users.get(row.updatedBy) ?? null) : null,
+ });
+
+ const updatesByMaintenance = new Map<
+ number,
+ MaintenanceUpdateWithRelations[]
+ >();
+ for (const update of allUpdates) {
+ const withUsers = { ...update, ...attributed(update) };
+ const existing = updatesByMaintenance.get(update.maintenanceId);
+ if (existing) existing.push(withUsers);
+ else updatesByMaintenance.set(update.maintenanceId, [withUsers]);
+ }
const componentsByMaintenance = new Map<number, PageComponent[]>();
for (const row of assocRows) {
@@ -95,14 +133,15 @@ async function enrichMaintenancesBatch(
return rows.map((r) => {
const components = componentsByMaintenance.get(r.id) ?? [];
+ const updates = updatesByMaintenance.get(r.id) ?? [];
return {
...r,
+ // the column is a stale mirror of the first update
+ message: latestMaintenanceUpdate(updates)?.message ?? r.message,
+ updates,
pageComponents: components,
pageComponentIds: components.map((c) => c.id),
- createdByUser:
- r.createdBy != null ? (users.get(r.createdBy) ?? null) : null,
- updatedByUser:
- r.updatedBy != null ? (users.get(r.updatedBy) ?? null) : null,
+ ...attributed(r),
};
});
}
diff --git a/packages/services/src/maintenance/notify.ts b/packages/services/src/maintenance/notify.ts
index 054f09ad5..40b364a59 100644
--- a/packages/services/src/maintenance/notify.ts
+++ b/packages/services/src/maintenance/notify.ts
@@ -1,5 +1,5 @@
import { db as defaultDb, eq } from "@openstatus/db";
-import { maintenance } from "@openstatus/db/src/schema";
+import { maintenance, maintenanceUpdate } from "@openstatus/db/src/schema";
import { dispatchMaintenanceUpdate } from "@openstatus/subscriptions";
import { requireScope } from "../auth";
@@ -8,39 +8,46 @@ import { ForbiddenError, NotFoundError } from "../errors";
import { NotifyMaintenanceInput } from "./schemas";
/**
- * Dispatch subscriber notifications for a maintenance. Separate from the
- * create/update mutations because the dashboard runs on Edge and cannot
- * fire-and-forget — callers invoke this as a second awaited call.
+ * Dispatch subscriber notifications for one timeline entry (the announcement
+ * is the first update). Separate from the mutations because the dashboard
+ * runs on Edge and cannot fire-and-forget — callers invoke this as a second
+ * awaited call, mirroring `notifyStatusReport`.
*
* Enforces:
- * - Workspace owns the target maintenance.
+ * - Workspace owns the target update (via join to the parent maintenance).
* - Plan has `status-subscribers` enabled — otherwise no-op.
+ *
+ * Returns true only when a dispatch actually ran.
*/
export async function notifyMaintenance(args: {
ctx: ServiceContext;
input: NotifyMaintenanceInput;
-}): Promise<void> {
+}): Promise<boolean> {
const { ctx } = args;
requireScope(ctx, "write");
const input = NotifyMaintenanceInput.parse(args.input);
const db = ctx.db ?? defaultDb;
const row = await db
- .select({ id: maintenance.id, workspaceId: maintenance.workspaceId })
- .from(maintenance)
- .where(eq(maintenance.id, input.maintenanceId))
+ .select({ workspaceId: maintenance.workspaceId })
+ .from(maintenanceUpdate)
+ .innerJoin(maintenance, eq(maintenanceUpdate.maintenanceId, maintenance.id))
+ .where(eq(maintenanceUpdate.id, input.maintenanceUpdateId))
.get();
if (!row) {
- throw new NotFoundError("maintenance", input.maintenanceId);
+ throw new NotFoundError("maintenance_update", input.maintenanceUpdateId);
}
if (row.workspaceId !== ctx.workspace.id) {
- throw new ForbiddenError("Maintenance does not belong to this workspace.");
+ throw new ForbiddenError(
+ "Maintenance update does not belong to this workspace.",
+ );
}
if (!ctx.workspace.limits["status-subscribers"]) {
- return;
+ return false;
}
- await dispatchMaintenanceUpdate(input.maintenanceId);
+ await dispatchMaintenanceUpdate(input.maintenanceUpdateId);
+ return true;
}
diff --git a/packages/services/src/maintenance/schemas.ts b/packages/services/src/maintenance/schemas.ts
index 62a0db48e..509ab2f0e 100644
--- a/packages/services/src/maintenance/schemas.ts
+++ b/packages/services/src/maintenance/schemas.ts
@@ -10,12 +10,27 @@ export const maintenanceListPeriods = ["1d", "7d", "14d"] as const;
export type MaintenanceListPeriod = (typeof maintenanceListPeriods)[number];
export const maintenanceListPeriodSchema = z.enum(maintenanceListPeriods);
+// `z.coerce.date()` turns `null` into 1970-01-01; reject it before coercing.
+const coercedDate = z
+ .union([z.string(), z.number(), z.date()])
+ .pipe(z.coerce.date());
+
+// Timeline updates record what happened; the skew tolerates client clocks.
+const CLOCK_SKEW_MS = 5 * 60 * 1000;
+const pastDate = coercedDate.refine(
+ (date) => date.getTime() <= Date.now() + CLOCK_SKEW_MS,
+ { error: "Date cannot be in the future." },
+);
+
export const CreateMaintenanceInput = z
.object({
title: z.string().trim().min(1).max(256),
+ /** Becomes the first timeline update. */
message: z.string().min(1),
- from: z.coerce.date(),
- to: z.coerce.date(),
+ /** Date of the first update; defaults to now, must not be in the future. */
+ date: pastDate.optional(),
+ from: coercedDate,
+ to: coercedDate,
pageId: z.number().int(),
pageComponentIds: z.array(z.number().int()).default([]),
})
@@ -28,14 +43,51 @@ export type CreateMaintenanceInput = z.infer<typeof CreateMaintenanceInput>;
export const UpdateMaintenanceInput = z.object({
id: z.number().int(),
title: z.string().trim().min(1).max(256).optional(),
+ /** Rewrites the newest timeline update. */
message: z.string().min(1).optional(),
- from: z.coerce.date().optional(),
- to: z.coerce.date().optional(),
+ from: coercedDate.optional(),
+ to: coercedDate.optional(),
/** When provided, replaces the full association set (empty array clears). */
pageComponentIds: z.array(z.number().int()).optional(),
});
export type UpdateMaintenanceInput = z.infer<typeof UpdateMaintenanceInput>;
+export const AddMaintenanceUpdateInput = z.object({
+ maintenanceId: z.number().int(),
+ message: z.string().min(1),
+ date: pastDate.optional(),
+});
+export type AddMaintenanceUpdateInput = z.infer<
+ typeof AddMaintenanceUpdateInput
+>;
+
+export const UpdateMaintenanceUpdateInput = z
+ .object({
+ id: z.number().int(),
+ message: z.string().min(1).optional(),
+ date: pastDate.optional(),
+ })
+ .refine((input) => input.message !== undefined || input.date !== undefined, {
+ message: "At least one field must be provided.",
+ });
+export type UpdateMaintenanceUpdateInput = z.infer<
+ typeof UpdateMaintenanceUpdateInput
+>;
+
+export const DeleteMaintenanceUpdateInput = z.object({
+ id: z.number().int(),
+});
+export type DeleteMaintenanceUpdateInput = z.infer<
+ typeof DeleteMaintenanceUpdateInput
+>;
+
+export const GetMaintenanceUpdateInput = z.object({
+ id: z.number().int(),
+});
+export type GetMaintenanceUpdateInput = z.infer<
+ typeof GetMaintenanceUpdateInput
+>;
+
export const DeleteMaintenanceInput = z.object({ id: z.number().int() });
export type DeleteMaintenanceInput = z.infer<typeof DeleteMaintenanceInput>;
@@ -54,6 +106,6 @@ export const ListMaintenancesInput = z.object({
export type ListMaintenancesInput = z.infer<typeof ListMaintenancesInput>;
export const NotifyMaintenanceInput = z.object({
- maintenanceId: z.number().int(),
+ maintenanceUpdateId: z.number().int(),
});
export type NotifyMaintenanceInput = z.infer<typeof NotifyMaintenanceInput>;
diff --git a/packages/services/src/maintenance/update-update.ts b/packages/services/src/maintenance/update-update.ts
new file mode 100644
index 000000000..c1bdb8473
--- /dev/null
+++ b/packages/services/src/maintenance/update-update.ts
@@ -0,0 +1,65 @@
+import { eq } from "@openstatus/db";
+import { maintenanceUpdate } from "@openstatus/db/src/schema";
+
+import { emitAudit } from "../audit";
+import { requireScope } from "../auth";
+import {
+ type ServiceContext,
+ tryGetActorUserId,
+ withTransaction,
+} from "../context";
+import { InternalServiceError } from "../errors";
+import type { MaintenanceUpdate } from "../types";
+import { touchMaintenance } from "./add-update";
+import { getMaintenanceUpdateInWorkspace } from "./internal";
+import { UpdateMaintenanceUpdateInput } from "./schemas";
+
+export async function updateMaintenanceUpdate(args: {
+ ctx: ServiceContext;
+ input: UpdateMaintenanceUpdateInput;
+}): Promise<MaintenanceUpdate> {
+ const { ctx } = args;
+ requireScope(ctx, "write");
+ const input = UpdateMaintenanceUpdateInput.parse(args.input);
+ const actorUserId = tryGetActorUserId(ctx.actor);
+
+ return withTransaction(ctx, async (tx) => {
+ const existing = await getMaintenanceUpdateInWorkspace({
+ tx,
+ id: input.id,
+ workspaceId: ctx.workspace.id,
+ });
+
+ const values: Partial<MaintenanceUpdate> = {
+ updatedAt: new Date(),
+ updatedBy: actorUserId,
+ };
+ if (input.message !== undefined) values.message = input.message;
+ if (input.date !== undefined) values.date = input.date;
+
+ const updated = await tx
+ .update(maintenanceUpdate)
+ .set(values)
+ .where(eq(maintenanceUpdate.id, existing.id))
+ .returning()
+ .get();
+ if (!updated) {
+ throw new InternalServiceError(
+ `failed to update maintenance update ${existing.id}`,
+ );
+ }
+
+ await touchMaintenance(tx, existing.maintenanceId, actorUserId);
+
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.update",
+ entityType: "maintenance_update",
+ entityId: updated.id,
+ before: existing,
+ after: updated,
+ metadata: { maintenanceId: existing.maintenanceId },
+ });
+
+ return updated;
+ });
+}
diff --git a/packages/services/src/maintenance/update.ts b/packages/services/src/maintenance/update.ts
index 34b81aede..cd848df5b 100644
--- a/packages/services/src/maintenance/update.ts
+++ b/packages/services/src/maintenance/update.ts
@@ -1,9 +1,10 @@
-import { eq } from "@openstatus/db";
-import { maintenance } from "@openstatus/db/src/schema";
+import { desc, eq } from "@openstatus/db";
+import { maintenance, maintenanceUpdate } from "@openstatus/db/src/schema";
import { emitAudit } from "../audit";
import { requireScope } from "../auth";
import {
+ type DB,
type ServiceContext,
tryGetActorUserId,
withTransaction,
@@ -24,6 +25,7 @@ export async function updateMaintenance(args: {
const { ctx } = args;
requireScope(ctx, "write");
const input = UpdateMaintenanceInput.parse(args.input);
+ const actorUserId = tryGetActorUserId(ctx.actor);
return withTransaction(ctx, async (tx) => {
const existing = await getMaintenanceInWorkspace({
@@ -42,10 +44,9 @@ export async function updateMaintenance(args: {
const updateValues: Record<string, unknown> = {
updatedAt: new Date(),
- updatedBy: tryGetActorUserId(ctx.actor),
+ updatedBy: actorUserId,
};
if (input.title !== undefined) updateValues.title = input.title;
- if (input.message !== undefined) updateValues.message = input.message;
if (input.from !== undefined) updateValues.from = input.from;
if (input.to !== undefined) updateValues.to = input.to;
@@ -71,6 +72,10 @@ export async function updateMaintenance(args: {
});
}
+ if (input.message !== undefined) {
+ await rewriteLatestUpdate(tx, ctx, existing.id, input.message);
+ }
+
const updated = await tx
.update(maintenance)
.set(updateValues)
@@ -95,3 +100,67 @@ export async function updateMaintenance(args: {
return updated;
});
}
+
+/**
+ * `message` is the newest update's text, so editing it rewrites that row.
+ * A maintenance without updates (pre-backfill) gets one dated now instead.
+ */
+async function rewriteLatestUpdate(
+ tx: DB,
+ ctx: ServiceContext,
+ maintenanceId: number,
+ message: string,
+): Promise<void> {
+ const actorUserId = tryGetActorUserId(ctx.actor);
+ const latest = await tx
+ .select()
+ .from(maintenanceUpdate)
+ .where(eq(maintenanceUpdate.maintenanceId, maintenanceId))
+ .orderBy(desc(maintenanceUpdate.date), desc(maintenanceUpdate.id))
+ .limit(1)
+ .get();
+
+ if (!latest) {
+ const created = await tx
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId,
+ message,
+ date: new Date(),
+ createdBy: actorUserId,
+ updatedBy: actorUserId,
+ })
+ .returning()
+ .get();
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.create",
+ entityType: "maintenance_update",
+ entityId: created.id,
+ after: created,
+ metadata: { maintenanceId },
+ });
+ return;
+ }
+
+ if (latest.message === message) return;
+
+ const updated = await tx
+ .update(maintenanceUpdate)
+ .set({ message, updatedAt: new Date(), updatedBy: actorUserId })
+ .where(eq(maintenanceUpdate.id, latest.id))
+ .returning()
+ .get();
+ if (!updated) {
+ throw new InternalServiceError(
+ `failed to update maintenance update ${latest.id}`,
+ );
+ }
+ await emitAudit(tx, ctx, {
+ action: "maintenance_update.update",
+ entityType: "maintenance_update",
+ entityId: updated.id,
+ before: latest,
+ after: updated,
+ metadata: { maintenanceId },
+ });
+}
diff --git a/packages/services/src/maintenance/utils.ts b/packages/services/src/maintenance/utils.ts
new file mode 100644
index 000000000..78cb7618e
--- /dev/null
+++ b/packages/services/src/maintenance/utils.ts
@@ -0,0 +1,18 @@
+import type { MaintenanceUpdate } from "../types";
+
+/** Newest entry by date, then id; the public `message` of a maintenance. */
+export function latestMaintenanceUpdate<
+ T extends Pick<MaintenanceUpdate, "date" | "id">,
+>(updates: ReadonlyArray<T>): T | undefined {
+ let latest: T | undefined;
+ for (const update of updates) {
+ if (
+ !latest ||
+ update.date.getTime() > latest.date.getTime() ||
+ (update.date.getTime() === latest.date.getTime() && update.id > latest.id)
+ ) {
+ latest = update;
+ }
+ }
+ return latest;
+}
diff --git a/packages/services/src/page/get-content.ts b/packages/services/src/page/get-content.ts
index f45d7658d..cd4199ec6 100644
--- a/packages/services/src/page/get-content.ts
+++ b/packages/services/src/page/get-content.ts
@@ -2,6 +2,7 @@ import { and, db as defaultDb, desc, eq, inArray } from "@openstatus/db";
import {
type PageComponentImpact,
maintenance,
+ maintenanceUpdate,
maintenancesToPageComponents,
pageComponent,
pageComponentGroup,
@@ -18,6 +19,7 @@ type GroupRow = typeof pageComponentGroup.$inferSelect;
type ReportRow = typeof statusReport.$inferSelect;
type UpdateRow = typeof statusReportUpdate.$inferSelect;
type MaintenanceRow = typeof maintenance.$inferSelect;
+type MaintenanceUpdateRow = typeof maintenanceUpdate.$inferSelect;
export type StatusReportContent = ReportRow & {
pageComponentIds: number[];
@@ -33,6 +35,7 @@ export type StatusReportContent = ReportRow & {
export type MaintenanceContent = MaintenanceRow & {
pageComponentIds: number[];
+ maintenanceUpdates: MaintenanceUpdateRow[];
};
export type StatusPageContent = {
@@ -155,22 +158,36 @@ export async function getStatusPageContent(args: {
}));
const maintenanceIds = pageMaintenances.map((m) => m.id);
- const maintenanceComponents =
+ const [maintenanceComponents, maintenanceUpdates] = await Promise.all([
maintenanceIds.length > 0
- ? await db
+ ? db
.select()
.from(maintenancesToPageComponents)
.where(
inArray(maintenancesToPageComponents.maintenanceId, maintenanceIds),
)
.all()
- : [];
+ : Promise.resolve(
+ [] as (typeof maintenancesToPageComponents.$inferSelect)[],
+ ),
+ maintenanceIds.length > 0
+ ? db
+ .select()
+ .from(maintenanceUpdate)
+ .where(inArray(maintenanceUpdate.maintenanceId, maintenanceIds))
+ .orderBy(desc(maintenanceUpdate.date), desc(maintenanceUpdate.id))
+ .all()
+ : Promise.resolve([] as MaintenanceUpdateRow[]),
+ ]);
const maintenances: MaintenanceContent[] = pageMaintenances.map((m) => ({
...m,
pageComponentIds: maintenanceComponents
.filter((mc) => mc.maintenanceId === m.id)
.map((mc) => mc.pageComponentId),
+ maintenanceUpdates: maintenanceUpdates.filter(
+ (u) => u.maintenanceId === m.id,
+ ),
}));
return { components, groups, statusReports, maintenances };
diff --git a/packages/services/src/types.ts b/packages/services/src/types.ts
index 29feaa32b..e9f855367 100644
--- a/packages/services/src/types.ts
+++ b/packages/services/src/types.ts
@@ -22,7 +22,7 @@ export type {
export type { Page, PageComponent } from "@openstatus/db/src/schema";
-export type { Maintenance } from "@openstatus/db/src/schema";
+export type { Maintenance, MaintenanceUpdate } from "@openstatus/db/src/schema";
export type { MonitorIncident, Monitor } from "@openstatus/db/src/schema";
diff --git a/packages/subscriptions/src/channels/email.test.ts b/packages/subscriptions/src/channels/email.test.ts
index 7dbf54d55..19ec30dde 100644
--- a/packages/subscriptions/src/channels/email.test.ts
+++ b/packages/subscriptions/src/channels/email.test.ts
@@ -158,7 +158,7 @@ describe("sendEmailNotifications", () => {
expect(args.idempotencyKey).toMatch(/^status-report-update:77:[0-9a-z]+$/);
});
- test("falls back to a page-update key when there is no update id (maintenance)", async () => {
+ test("falls back to a page-update key when there is no update id", async () => {
const sub = makeSub();
await sendEmailNotifications(
[sub],
@@ -196,6 +196,28 @@ describe("sendEmailNotifications", () => {
expect(keys[0]).not.toBe(keys[1]);
});
+ test("changes the key when the maintenance window changes", async () => {
+ const base = {
+ updateId: 77,
+ status: "maintenance" as const,
+ date: "2026-07-16T11:00:00Z",
+ startsAt: "2026-07-20T10:00:00Z",
+ };
+ await sendEmailNotifications(
+ [makeSub()],
+ makeUpdate({ ...base, endsAt: "2026-07-20T11:00:00Z" }),
+ );
+ await sendEmailNotifications(
+ [makeSub()],
+ makeUpdate({ ...base, endsAt: "2026-07-20T12:00:00Z" }),
+ );
+
+ const keys = sendStatusReportUpdateMock.calls.map(
+ (c) => c.args[0].idempotencyKey,
+ );
+ expect(keys[0]).not.toBe(keys[1]);
+ });
+
test("changes the key when the update content changes", async () => {
const date = "2026-07-16T11:00:00Z";
await sendEmailNotifications(
diff --git a/packages/subscriptions/src/channels/email.ts b/packages/subscriptions/src/channels/email.ts
index ae4dfeecb..afccdccef 100644
--- a/packages/subscriptions/src/channels/email.ts
+++ b/packages/subscriptions/src/channels/email.ts
@@ -24,13 +24,14 @@ export async function validateEmailConfig(config: unknown) {
return { valid: email.success, error: email.error?.message };
}
-// Stable per status-report update / maintenance so Resend dedupes the email
-// retry path. Status reports key off the specific update; maintenance has no
-// update row, so fall back to its id + status.
+// Stable per entity update so Resend dedupes the email retry path.
function idempotencyKeyFor(pageUpdate: PageUpdate): string {
- return pageUpdate.updateId != null
- ? `status-report-update:${pageUpdate.updateId}`
- : `page-update:${pageUpdate.id}:${pageUpdate.status}`;
+ if (pageUpdate.updateId == null) {
+ return `page-update:${pageUpdate.id}:${pageUpdate.status}`;
+ }
+ return pageUpdate.status === "maintenance"
+ ? `maintenance-update:${pageUpdate.updateId}`
+ : `status-report-update:${pageUpdate.updateId}`;
}
// FNV-1a, Edge-safe (no node:crypto). Resend 409s when a key is reused within
@@ -94,6 +95,9 @@ export async function sendEmailNotifications(
pageUpdate.status,
pageUpdate.message,
pageUpdate.date,
+ // the maintenance window is rendered instead of `date` below
+ pageUpdate.startsAt ?? null,
+ pageUpdate.endsAt ?? null,
pageUpdate.pageComponents,
pageUpdate.componentsWithImpact?.map((c) => c.impact),
]),
@@ -111,7 +115,13 @@ export async function sendEmailNotifications(
reportTitle: pageUpdate.title,
status: pageUpdate.status,
message: pageUpdate.message,
- date: pageUpdate.date,
+ // the template prints non-date strings verbatim, so the window reads "from - to"
+ date:
+ pageUpdate.status === "maintenance" &&
+ pageUpdate.startsAt &&
+ pageUpdate.endsAt
+ ? `${pageUpdate.startsAt} - ${pageUpdate.endsAt}`
+ : pageUpdate.date,
pageComponents: pageUpdate.pageComponents,
componentImpacts: pageUpdate.componentsWithImpact,
idempotencyKey: `${idempotencyKeyFor(pageUpdate)}:${payloadHash}`,
diff --git a/packages/subscriptions/src/channels/slack-blocks.test.ts b/packages/subscriptions/src/channels/slack-blocks.test.ts
index 83dd0dcba..d33ece0ad 100644
--- a/packages/subscriptions/src/channels/slack-blocks.test.ts
+++ b/packages/subscriptions/src/channels/slack-blocks.test.ts
@@ -75,6 +75,21 @@ describe("buildRootMessage", () => {
expect(contextText(maintenance)).not.toContain("Updated");
});
+ test("maintenance root pins the scheduled start, not the update date", () => {
+ const root = buildRootMessage(
+ makeUpdate({
+ status: "maintenance",
+ date: "2026-01-01T12:30:00.000Z",
+ startsAt: "2026-01-02T00:00:00.000Z",
+ endsAt: "2026-01-02T02:00:00.000Z",
+ }),
+ makeSub(),
+ );
+ const text = JSON.stringify(root.attachments[0]?.blocks);
+ expect(text).toContain("Scheduled 2026-01-02T00:00:00.000Z");
+ expect(text).not.toContain("2026-01-01T12:30:00.000Z");
+ });
+
test("uses the custom domain origin when present", () => {
const root = buildRootMessage(
makeUpdate(),
diff --git a/packages/subscriptions/src/channels/slack-blocks.ts b/packages/subscriptions/src/channels/slack-blocks.ts
index 0531fcce9..542c82aff 100644
--- a/packages/subscriptions/src/channels/slack-blocks.ts
+++ b/packages/subscriptions/src/channels/slack-blocks.ts
@@ -95,15 +95,19 @@ export function buildRootMessage(
});
}
- // Maintenance carries a scheduled window, not an update timestamp.
- const dateLabel =
- pageUpdate.status === "maintenance" ? "Scheduled" : "Updated";
+ // Maintenance carries a scheduled window, not an update timestamp. The root
+ // is re-rendered on every update, so it must not pick up the update's date.
+ const isMaintenance = pageUpdate.status === "maintenance";
+ const dateLabel = isMaintenance ? "Scheduled" : "Updated";
+ const dateValue = isMaintenance
+ ? (pageUpdate.startsAt ?? pageUpdate.date)
+ : pageUpdate.date;
blocks.push({
type: "context",
elements: [
{
type: "mrkdwn",
- text: `${dateLabel} ${pageUpdate.date} · <${eventUrl(pageUpdate, subscription)}|View details> · Manage with \`/openstatus unsubscribe\``,
+ text: `${dateLabel} ${dateValue} · <${eventUrl(pageUpdate, subscription)}|View details> · Manage with \`/openstatus unsubscribe\``,
},
],
});
diff --git a/packages/subscriptions/src/channels/slack-store.ts b/packages/subscriptions/src/channels/slack-store.ts
index a635cf809..b7e9b1e40 100644
--- a/packages/subscriptions/src/channels/slack-store.ts
+++ b/packages/subscriptions/src/channels/slack-store.ts
@@ -11,29 +11,36 @@ export interface SlackThreadAnchor {
pendingRootReply?: SlackReplyMessage;
}
+// The entity a thread belongs to. Report and maintenance ids come from
+// different tables, so the kind keeps their anchors apart.
+export interface SlackThreadEvent {
+ kind: "report" | "maintenance";
+ id: number;
+}
+
export interface SlackAnchorStore {
getAnchor(
- reportId: number,
+ event: SlackThreadEvent,
subscriberId: number,
): Promise<SlackThreadAnchor | null>;
setAnchor(
- reportId: number,
+ event: SlackThreadEvent,
subscriberId: number,
anchor: SlackThreadAnchor,
): Promise<void>;
- clearAnchor(reportId: number, subscriberId: number): Promise<void>;
- // Atomically claim delivery of (report, subscriber, update). Returns true only
+ clearAnchor(event: SlackThreadEvent, subscriberId: number): Promise<void>;
+ // Atomically claim delivery of (event, subscriber, update). Returns true only
// for the caller that wins the claim; concurrent callers get false and must
// skip. This is the dedupe reservation — a single atomic op, not a
// read-then-write pair, so two dispatchers can't both post the same message.
reserveDelivery(
- reportId: number,
+ event: SlackThreadEvent,
subscriberId: number,
updateId: number,
): Promise<boolean>;
// Release a reservation whose post failed, so the delivery can be retried.
releaseDelivery(
- reportId: number,
+ event: SlackThreadEvent,
subscriberId: number,
updateId: number,
): Promise<void>;
@@ -41,16 +48,16 @@ export interface SlackAnchorStore {
const TTL_SECONDS = 90 * 24 * 60 * 60;
-function anchorKey(reportId: number, subscriberId: number): string {
- return `slack:report:${reportId}:sub:${subscriberId}`;
+function anchorKey(event: SlackThreadEvent, subscriberId: number): string {
+ return `slack:${event.kind}:${event.id}:sub:${subscriberId}`;
}
function deliveredKey(
- reportId: number,
+ event: SlackThreadEvent,
subscriberId: number,
updateId: number,
): string {
- return `${anchorKey(reportId, subscriberId)}:update:${updateId}`;
+ return `${anchorKey(event, subscriberId)}:update:${updateId}`;
}
let redisClient: Redis | null = null;
@@ -64,30 +71,30 @@ function getRedis(): Redis {
export function createRedisAnchorStore(): SlackAnchorStore {
return {
- async getAnchor(reportId, subscriberId) {
+ async getAnchor(event, subscriberId) {
const raw = await getRedis().get<SlackThreadAnchor>(
- anchorKey(reportId, subscriberId),
+ anchorKey(event, subscriberId),
);
return raw ?? null;
},
- async setAnchor(reportId, subscriberId, anchor) {
- await getRedis().set(anchorKey(reportId, subscriberId), anchor, {
+ async setAnchor(event, subscriberId, anchor) {
+ await getRedis().set(anchorKey(event, subscriberId), anchor, {
ex: TTL_SECONDS,
});
},
- async clearAnchor(reportId, subscriberId) {
- await getRedis().del(anchorKey(reportId, subscriberId));
+ async clearAnchor(event, subscriberId) {
+ await getRedis().del(anchorKey(event, subscriberId));
},
- async reserveDelivery(reportId, subscriberId, updateId) {
+ async reserveDelivery(event, subscriberId, updateId) {
const res = await getRedis().set(
- deliveredKey(reportId, subscriberId, updateId),
+ deliveredKey(event, subscriberId, updateId),
1,
{ ex: TTL_SECONDS, nx: true },
);
return res === "OK";
},
- async releaseDelivery(reportId, subscriberId, updateId) {
- await getRedis().del(deliveredKey(reportId, subscriberId, updateId));
+ async releaseDelivery(event, subscriberId, updateId) {
+ await getRedis().del(deliveredKey(event, subscriberId, updateId));
},
};
}
@@ -96,23 +103,23 @@ export function createMemoryAnchorStore(): SlackAnchorStore {
const anchors = new Map<string, SlackThreadAnchor>();
const delivered = new Set<string>();
return {
- async getAnchor(reportId, subscriberId) {
- return anchors.get(anchorKey(reportId, subscriberId)) ?? null;
+ async getAnchor(event, subscriberId) {
+ return anchors.get(anchorKey(event, subscriberId)) ?? null;
},
- async setAnchor(reportId, subscriberId, anchor) {
- anchors.set(anchorKey(reportId, subscriberId), anchor);
+ async setAnchor(event, subscriberId, anchor) {
+ anchors.set(anchorKey(event, subscriberId), anchor);
},
- async clearAnchor(reportId, subscriberId) {
- anchors.delete(anchorKey(reportId, subscriberId));
+ async clearAnchor(event, subscriberId) {
+ anchors.delete(anchorKey(event, subscriberId));
},
- async reserveDelivery(reportId, subscriberId, updateId) {
- const key = deliveredKey(reportId, subscriberId, updateId);
+ async reserveDelivery(event, subscriberId, updateId) {
+ const key = deliveredKey(event, subscriberId, updateId);
if (delivered.has(key)) return false;
delivered.add(key);
return true;
},
- async releaseDelivery(reportId, subscriberId, updateId) {
- delivered.delete(deliveredKey(reportId, subscriberId, updateId));
+ async releaseDelivery(event, subscriberId, updateId) {
+ delivered.delete(deliveredKey(event, subscriberId, updateId));
},
};
}
diff --git a/packages/subscriptions/src/channels/slack.test.ts b/packages/subscriptions/src/channels/slack.test.ts
index 8dabbe03b..495a7f1f8 100644
--- a/packages/subscriptions/src/channels/slack.test.ts
+++ b/packages/subscriptions/src/channels/slack.test.ts
@@ -78,6 +78,8 @@ function makeUpdate(over: Partial<PageUpdate> = {}): PageUpdate {
const noopUnsub = async () => {};
const token = async () => "xoxb-test";
+const REPORT = { kind: "report", id: 10 } as const;
+const MAINTENANCE = { kind: "maintenance", id: 10 } as const;
describe("createSlackChannel", () => {
test("first update opens the thread (root post, no update, anchor set)", async () => {
@@ -95,7 +97,7 @@ describe("createSlackChannel", () => {
expect(calls.filter((c) => c.method === "post").length).toBe(1);
expect(calls[0]?.thread_ts).toBeUndefined();
expect(calls.some((c) => c.method === "update")).toBe(false);
- expect(await store.getAnchor(10, 1)).not.toBeNull();
+ expect(await store.getAnchor(REPORT, 1)).not.toBeNull();
});
test("subsequent update backfills the first update then replies in thread and re-renders root", async () => {
@@ -267,7 +269,7 @@ describe("createSlackChannel", () => {
expect(calls.filter((c) => c.method === "post").length).toBe(1);
});
- test("maintenance posts once with no thread and no anchor", async () => {
+ test("maintenance threads like a report: root, then backfill + reply + re-render", async () => {
const { client, calls } = makeClient();
const store = createMemoryAnchorStore();
const channel = createSlackChannel({
@@ -276,15 +278,55 @@ describe("createSlackChannel", () => {
getBotToken: token,
softUnsubscribe: noopUnsub,
});
+ const maintenance = {
+ status: "maintenance" as const,
+ startsAt: "2026-01-02T00:00:00.000Z",
+ endsAt: "2026-01-02T02:00:00.000Z",
+ };
await channel.sendNotifications(
[makeSub()],
- makeUpdate({ status: "maintenance", updateId: undefined }),
+ makeUpdate({ ...maintenance, updateId: 200, message: "scheduled" }),
);
-
expect(calls.filter((c) => c.method === "post").length).toBe(1);
+ expect(calls[0]?.thread_ts).toBeUndefined();
+ expect(await store.getAnchor(MAINTENANCE, 1)).not.toBeNull();
+
+ await channel.sendNotifications(
+ [makeSub()],
+ makeUpdate({ ...maintenance, updateId: 201, message: "starting now" }),
+ );
+ const posts = calls.filter((c) => c.method === "post");
+ expect(posts.length).toBe(3);
+ expect(posts[1]?.thread_ts).toBe("1700000000.0001");
+ expect(posts[1]?.text).toContain("scheduled");
+ expect(posts[2]?.thread_ts).toBe("1700000000.0001");
+ expect(posts[2]?.text).toContain("starting now");
+ expect(calls.filter((c) => c.method === "update").length).toBe(1);
+ });
+
+ test("a maintenance and a report sharing an id keep separate threads", async () => {
+ const { client, calls } = makeClient();
+ const store = createMemoryAnchorStore();
+ const channel = createSlackChannel({
+ store,
+ createClient: () => client,
+ getBotToken: token,
+ softUnsubscribe: noopUnsub,
+ });
+
+ await channel.sendNotifications([makeSub()], makeUpdate({ updateId: 100 }));
+ await channel.sendNotifications(
+ [makeSub()],
+ makeUpdate({ status: "maintenance", updateId: 100 }),
+ );
+
+ // Both are roots: no thread reply, no root re-render.
+ expect(calls.filter((c) => c.method === "post").length).toBe(2);
+ expect(calls.every((c) => c.thread_ts === undefined)).toBe(true);
expect(calls.some((c) => c.method === "update")).toBe(false);
- expect(await store.getAnchor(10, 1)).toBeNull();
+ expect((await store.getAnchor(REPORT, 1))?.ts).toBe("1700000000.0001");
+ expect((await store.getAnchor(MAINTENANCE, 1))?.ts).toBe("1700000000.0002");
});
});
@@ -320,16 +362,16 @@ describe("validateSlackConfig", () => {
describe("reserveDelivery (memory store)", () => {
test("only the first reservation for a key wins", async () => {
const store = createMemoryAnchorStore();
- expect(await store.reserveDelivery(1, 2, 3)).toBe(true);
- expect(await store.reserveDelivery(1, 2, 3)).toBe(false);
+ expect(await store.reserveDelivery(REPORT, 2, 3)).toBe(true);
+ expect(await store.reserveDelivery(REPORT, 2, 3)).toBe(false);
// A different updateId is an independent reservation.
- expect(await store.reserveDelivery(1, 2, 4)).toBe(true);
+ expect(await store.reserveDelivery(REPORT, 2, 4)).toBe(true);
});
test("releaseDelivery makes the key reservable again", async () => {
const store = createMemoryAnchorStore();
- expect(await store.reserveDelivery(1, 2, 3)).toBe(true);
- await store.releaseDelivery(1, 2, 3);
- expect(await store.reserveDelivery(1, 2, 3)).toBe(true);
+ expect(await store.reserveDelivery(REPORT, 2, 3)).toBe(true);
+ await store.releaseDelivery(REPORT, 2, 3);
+ expect(await store.reserveDelivery(REPORT, 2, 3)).toBe(true);
});
});
diff --git a/packages/subscriptions/src/channels/slack.ts b/packages/subscriptions/src/channels/slack.ts
index 0c81d01cc..ef6208c0e 100644
--- a/packages/subscriptions/src/channels/slack.ts
+++ b/packages/subscriptions/src/channels/slack.ts
@@ -8,7 +8,11 @@ import { WebClient } from "@slack/web-api";
import type { PageUpdate, Subscription } from "../types";
import { buildReplyMessage, buildRootMessage } from "./slack-blocks";
-import { type SlackAnchorStore, createRedisAnchorStore } from "./slack-store";
+import {
+ type SlackAnchorStore,
+ type SlackThreadEvent,
+ createRedisAnchorStore,
+} from "./slack-store";
interface SlackPostResult {
ts?: string;
@@ -124,40 +128,29 @@ export function createSlackChannel(deps: SlackChannelDeps) {
}
}
- async function deliverMaintenance(
+ // Every event kind threads: the first delivered update becomes the root,
+ // later ones reply under it and re-render the root.
+ async function deliverThreaded(
client: SlackClient,
sub: Subscription,
channelId: string,
pageUpdate: PageUpdate,
): Promise<DeliveryOutcome> {
- const root = buildRootMessage(pageUpdate, sub);
- const res = await runSlack(sub.id, () =>
- client.postMessage({
- channel: channelId,
- attachments: root.attachments,
- }),
- );
- if (res === TEAM_TOKEN_INVALID) return TEAM_TOKEN_INVALID;
- }
-
- async function deliverReport(
- client: SlackClient,
- sub: Subscription,
- channelId: string,
- pageUpdate: PageUpdate,
- ): Promise<DeliveryOutcome> {
- const reportId = pageUpdate.id;
+ const event: SlackThreadEvent = {
+ kind: pageUpdate.status === "maintenance" ? "maintenance" : "report",
+ id: pageUpdate.id,
+ };
const updateId = pageUpdate.updateId;
if (updateId == null) {
- console.error(`slack: status report update ${reportId} missing updateId`);
+ console.error(`slack: ${event.kind} ${event.id} missing updateId`);
return;
}
// Atomic dedupe: only the caller that wins this reservation posts. On a
// failed post we release it below so the delivery stays retriable.
- if (!(await deps.store.reserveDelivery(reportId, sub.id, updateId))) return;
+ if (!(await deps.store.reserveDelivery(event, sub.id, updateId))) return;
- const anchor = await deps.store.getAnchor(reportId, sub.id);
+ const anchor = await deps.store.getAnchor(event, sub.id);
const root = buildRootMessage(pageUpdate, sub);
if (!anchor) {
@@ -168,13 +161,13 @@ export function createSlackChannel(deps: SlackChannelDeps) {
}),
);
if (!res || res === TEAM_TOKEN_INVALID) {
- await deps.store.releaseDelivery(reportId, sub.id, updateId);
+ await deps.store.releaseDelivery(event, sub.id, updateId);
return res === TEAM_TOKEN_INVALID ? TEAM_TOKEN_INVALID : undefined;
}
if (res.ts) {
// Stash this first update so the next one can backfill it into the
// thread before the root is re-rendered and its content lost.
- await deps.store.setAnchor(reportId, sub.id, {
+ await deps.store.setAnchor(event, sub.id, {
ts: res.ts,
channelId,
pendingRootReply: buildReplyMessage(pageUpdate),
@@ -196,14 +189,14 @@ export function createSlackChannel(deps: SlackChannelDeps) {
}),
);
if (!backfillRes || backfillRes === TEAM_TOKEN_INVALID) {
- await deps.store.releaseDelivery(reportId, sub.id, updateId);
+ await deps.store.releaseDelivery(event, sub.id, updateId);
return backfillRes === TEAM_TOKEN_INVALID
? TEAM_TOKEN_INVALID
: undefined;
}
// Clear before posting the current reply: if that reply fails and the
// delivery is retried, the first update must not be backfilled twice.
- await deps.store.setAnchor(reportId, sub.id, {
+ await deps.store.setAnchor(event, sub.id, {
ts: anchor.ts,
channelId: anchor.channelId,
});
@@ -219,7 +212,7 @@ export function createSlackChannel(deps: SlackChannelDeps) {
}),
);
if (!replyRes || replyRes === TEAM_TOKEN_INVALID) {
- await deps.store.releaseDelivery(reportId, sub.id, updateId);
+ await deps.store.releaseDelivery(event, sub.id, updateId);
return replyRes === TEAM_TOKEN_INVALID ? TEAM_TOKEN_INVALID : undefined;
}
@@ -266,10 +259,12 @@ export function createSlackChannel(deps: SlackChannelDeps) {
// Sequential per team so a token failure aborts the batch before
// hammering Slack with N calls that will all fail identically.
for (const { sub, channelId } of members) {
- const outcome =
- pageUpdate.status === "maintenance"
- ? await deliverMaintenance(client, sub, channelId, pageUpdate)
- : await deliverReport(client, sub, channelId, pageUpdate);
+ const outcome = await deliverThreaded(
+ client,
+ sub,
+ channelId,
+ pageUpdate,
+ );
if (outcome === TEAM_TOKEN_INVALID) {
console.error(
`slack: team ${teamId} bot token invalid — aborting ${members.length} deliveries; subscribers left intact (reconnect the Slack app)`,
diff --git a/packages/subscriptions/src/dispatcher.test.ts b/packages/subscriptions/src/dispatcher.test.ts
index 1da6e3ee3..f46a5dd87 100644
--- a/packages/subscriptions/src/dispatcher.test.ts
+++ b/packages/subscriptions/src/dispatcher.test.ts
@@ -1,6 +1,9 @@
import "./test-preload.ts";
import { db, eq } from "@openstatus/db";
import {
+ maintenance,
+ maintenanceUpdate,
+ maintenancesToPageComponents,
pageSubscriber,
pageSubscriberToPageComponent,
statusReport,
@@ -25,7 +28,11 @@ import {
} from "@std/testing/bdd";
import { assertSpyCalls, type Stub, stub } from "@std/testing/mock";
-import { dispatchPageUpdate, dispatchStatusReportUpdate } from "./dispatcher";
+import {
+ dispatchMaintenanceUpdate,
+ dispatchPageUpdate,
+ dispatchStatusReportUpdate,
+} from "./dispatcher";
import type { PageUpdate } from "./types";
// RESEND_API_KEY is set in test-preload.ts (see bunfig.toml) so @openstatus/emails
@@ -37,7 +44,9 @@ let rejectNextSend: Error | null = null;
// Built in `beforeAll` — a private page keeps the subscriber set this suite
// dispatches to independent of anything else running against the database.
let PAGE_ID: number;
+let WORKSPACE_ID: number;
let COMPONENT_1: number;
+let COMPONENT_1_NAME: string;
let COMPONENT_2: number;
const EMAILS = {
@@ -73,8 +82,11 @@ async function cleanAll() {
beforeAll(async () => {
const { workspace } = await createTestWorkspace();
+ WORKSPACE_ID = workspace.id;
PAGE_ID = (await createPage(workspace.id)).id;
- COMPONENT_1 = (await createPageComponent(workspace.id, PAGE_ID)).id;
+ const component1 = await createPageComponent(workspace.id, PAGE_ID);
+ COMPONENT_1 = component1.id;
+ COMPONENT_1_NAME = component1.name;
COMPONENT_2 = (await createPageComponent(workspace.id, PAGE_ID, { order: 1 }))
.id;
@@ -231,6 +243,59 @@ describe("dispatchPageUpdate - edge cases", () => {
});
});
+describe("dispatchMaintenanceUpdate", () => {
+ test("dispatches the selected update with parent schedule and components", async () => {
+ const startsAt = new Date("2026-08-10T10:00:00.000Z");
+ const endsAt = new Date("2026-08-10T11:00:00.000Z");
+ const occurredAt = new Date("2026-08-07T14:00:00.000Z");
+ const record = await db
+ .insert(maintenance)
+ .values({
+ workspaceId: WORKSPACE_ID,
+ pageId: PAGE_ID,
+ title: "Database maintenance",
+ message: "parent message",
+ from: startsAt,
+ to: endsAt,
+ })
+ .returning()
+ .get();
+
+ try {
+ await db
+ .insert(maintenancesToPageComponents)
+ .values({
+ maintenanceId: record.id,
+ pageComponentId: COMPONENT_1,
+ })
+ .run();
+ const update = await db
+ .insert(maintenanceUpdate)
+ .values({
+ maintenanceId: record.id,
+ message: "specific update message",
+ date: occurredAt,
+ })
+ .returning()
+ .get();
+
+ await dispatchMaintenanceUpdate(update.id);
+
+ const args = sendStatusReportUpdateMock.calls[0].args[0];
+ expect(args.message).toBe("specific update message");
+ expect(args.date).toBe(
+ `${startsAt.toISOString()} - ${endsAt.toISOString()}`,
+ );
+ expect(args.pageComponents).toContain(COMPONENT_1_NAME);
+ expect(args.idempotencyKey).toMatch(
+ new RegExp(`^maintenance-update:${update.id}:`),
+ );
+ } finally {
+ await db.delete(maintenance).where(eq(maintenance.id, record.id));
+ }
+ });
+});
+
// ─── dispatchStatusReportUpdate - impacts ─────────────────────────────────────
describe("dispatchStatusReportUpdate - impacts", () => {
diff --git a/packages/subscriptions/src/dispatcher.ts b/packages/subscriptions/src/dispatcher.ts
index f50f806a6..39c31aa74 100644
--- a/packages/subscriptions/src/dispatcher.ts
+++ b/packages/subscriptions/src/dispatcher.ts
@@ -1,6 +1,6 @@
import { and, db, eq, isNotNull, isNull } from "@openstatus/db";
import {
- maintenance,
+ maintenanceUpdate,
page,
pageSubscriber,
statusReportUpdate,
@@ -86,44 +86,48 @@ export async function dispatchStatusReportUpdate(statusReportUpdateId: number) {
}
/**
- * Dispatch notifications for a maintenance update
+ * Dispatch notifications for a maintenance update (the announcement is the first one)
*/
-export async function dispatchMaintenanceUpdate(maintenanceId: number) {
- const maintenanceWithComponents = await db.query.maintenance.findFirst({
- where: eq(maintenance.id, maintenanceId),
+export async function dispatchMaintenanceUpdate(maintenanceUpdateId: number) {
+ const update = await db.query.maintenanceUpdate.findFirst({
+ where: eq(maintenanceUpdate.id, maintenanceUpdateId),
with: {
- maintenancesToPageComponents: {
- with: { pageComponent: true },
+ maintenance: {
+ with: {
+ maintenancesToPageComponents: {
+ with: { pageComponent: true },
+ },
+ },
},
},
});
- if (!maintenanceWithComponents) {
- console.error(`Maintenance ${maintenanceId} not found`);
+ if (!update?.maintenance) {
+ console.error(`Maintenance update ${maintenanceUpdateId} not found`);
return;
}
- if (!maintenanceWithComponents.pageId) {
- console.error(`Maintenance ${maintenanceId} has no page ID`);
+ if (!update.maintenance.pageId) {
+ console.error(`Maintenance ${update.maintenance.id} has no page ID`);
return;
}
- const pageComponents =
- maintenanceWithComponents.maintenancesToPageComponents.map(
- (i) => i.pageComponent,
- );
+ const pageComponents = update.maintenance.maintenancesToPageComponents.map(
+ (i) => i.pageComponent,
+ );
await dispatchPageUpdate({
- id: maintenanceWithComponents.id,
- pageId: maintenanceWithComponents.pageId,
- title: maintenanceWithComponents.title,
+ id: update.maintenance.id,
+ pageId: update.maintenance.pageId,
+ title: update.maintenance.title,
status: "maintenance",
- message: maintenanceWithComponents.message,
+ message: update.message,
pageComponentIds: pageComponents.map((c) => c.id),
pageComponents: pageComponents.map((c) => c.name),
- date: `${maintenanceWithComponents.from.toISOString()} - ${maintenanceWithComponents.to.toISOString()}`,
- startsAt: maintenanceWithComponents.from.toISOString(),
- endsAt: maintenanceWithComponents.to.toISOString(),
+ date: update.date.toISOString(),
+ updateId: update.id,
+ startsAt: update.maintenance.from.toISOString(),
+ endsAt: update.maintenance.to.toISOString(),
pageComponentsWithId: pageComponents.map((c) => ({
id: c.id,
name: c.name,
diff --git a/packages/subscriptions/src/types.ts b/packages/subscriptions/src/types.ts
index d1cdf9c5f..0c5684ee6 100644
--- a/packages/subscriptions/src/types.ts
+++ b/packages/subscriptions/src/types.ts
@@ -44,7 +44,7 @@ export interface PageUpdate {
// Optional fields consumed by the prepared (staged) generic webhook payload.
// Populated by the matching dispatcher; ignored by email/Slack/Discord
// builders, which key off the fields above.
- updateId?: number; // statusReportUpdate.id (status reports only)
+ updateId?: number; // entity-specific update row id
pageComponentsWithId?: { id: number; name: string }[];
// Current impact per component as of this update (not the raw delta).
componentsWithImpact?: {
diff --git a/packages/ui/src/components/blocks/status-events.tsx b/packages/ui/src/components/blocks/status-events.tsx
index 11cbefae7..a7c1d8494 100644
--- a/packages/ui/src/components/blocks/status-events.tsx
+++ b/packages/ui/src/components/blocks/status-events.tsx
@@ -648,15 +648,23 @@ export function StatusEventTimelineReportUpdate({
interface StatusMaintenanceUpdate {
title: string;
- message: string;
+ /** Fallback body when no `maintenanceUpdates` are given. */
+ message?: string;
from: Date;
to: Date;
+ maintenanceUpdates?: {
+ id: number;
+ date: Date;
+ message: string;
+ }[];
}
/**
* StatusEventTimelineMaintenance - Timeline entry for maintenance windows
*
- * Displays a maintenance window with title, date range, duration, and message.
+ * Displays a maintenance window with title, date range and duration. The
+ * oldest update is the announcement and later ones follow as dated notes;
+ * `message` is only used when no updates are given.
* Uses a blue dot indicator to distinguish from incident updates.
*
* The date range is formatted and split to allow individual StatusTimestamp
@@ -697,53 +705,89 @@ export function StatusEventTimelineMaintenance({
maintenance.from,
maintenance.to,
);
+ // chronological: the oldest update is the announcement, notes follow it;
+ // dates have second precision, so the id breaks ties
+ const [announcement, ...updates] = [
+ ...(maintenance.maintenanceUpdates ?? []),
+ ].sort((a, b) => a.date.getTime() - b.date.getTime() || a.id - b.id);
+ const body = announcement?.message ?? maintenance.message ?? "";
+ const renderBody = (message: string) =>
+ message.trim() === "" ? (
+ <span className="text-muted-foreground/70">-</span>
+ ) : renderMessage ? (
+ renderMessage(message)
+ ) : (
+ message
+ );
+
return (
<div
data-slot="status-event-timeline-maintenance"
data-variant="maintenance"
className="group"
>
- <div className="flex flex-row items-center justify-between gap-2">
- <div className="flex flex-row gap-4">
+ <div className="flex flex-row gap-4">
+ {withDot ? (
+ <div className="flex flex-col">
+ <div className="flex h-5 flex-col items-center justify-center">
+ <StatusEventTimelineDot />
+ </div>
+ {updates.length > 0 ? <StatusEventTimelineSeparator /> : null}
+ </div>
+ ) : null}
+ <div className={cn(updates.length > 0 ? "mb-2" : "mb-0")}>
+ <StatusEventTimelineTitle>
+ <span>{maintenance.title}</span>{" "}
+ <span className="text-muted-foreground/70">·</span>{" "}
+ <span className="text-muted-foreground font-mono text-xs">
+ <StatusTimestamp date={maintenance.from} variant="rich" asChild>
+ <span>{from}</span>
+ </StatusTimestamp>
+ {" - "}
+ <StatusTimestamp date={maintenance.to} variant="rich" asChild>
+ <span>{to}</span>
+ </StatusTimestamp>
+ </span>{" "}
+ {duration ? (
+ <span className="text-muted-foreground/70 font-mono text-xs">
+ {labels.durationFor(duration)}
+ </span>
+ ) : null}
+ </StatusEventTimelineTitle>
+ <StatusEventTimelineMessage>
+ {renderBody(body)}
+ </StatusEventTimelineMessage>
+ </div>
+ </div>
+ {updates.map((update, index) => (
+ <div
+ key={`${update.date.getTime()}-${index}`}
+ className="flex flex-row gap-4"
+ >
{withDot ? (
<div className="flex flex-col">
<div className="flex h-5 flex-col items-center justify-center">
<StatusEventTimelineDot />
</div>
+ {index !== updates.length - 1 ? (
+ <StatusEventTimelineSeparator />
+ ) : null}
</div>
) : null}
- {/* NOTE: is always last, no need for className="mb-2" */}
- <div>
+ <div className={cn(index === updates.length - 1 ? "mb-0" : "mb-2")}>
<StatusEventTimelineTitle>
- <span>{maintenance.title}</span>{" "}
- <span className="text-muted-foreground/70">·</span>{" "}
<span className="text-muted-foreground font-mono text-xs">
- <StatusTimestamp date={maintenance.from} variant="rich" asChild>
- <span>{from}</span>
- </StatusTimestamp>
- {" - "}
- <StatusTimestamp date={maintenance.to} variant="rich" asChild>
- <span>{to}</span>
+ <StatusTimestamp date={update.date} variant="rich" asChild>
+ <span>{labels.formatDateTime(update.date)}</span>
</StatusTimestamp>
- </span>{" "}
- {duration ? (
- <span className="text-muted-foreground/70 font-mono text-xs">
- {labels.durationFor(duration)}
- </span>
- ) : null}
+ </span>
</StatusEventTimelineTitle>
<StatusEventTimelineMessage>
- {maintenance.message.trim() === "" ? (
- <span className="text-muted-foreground/70">-</span>
- ) : renderMessage ? (
- renderMessage(maintenance.message)
- ) : (
- maintenance.message
- )}
+ {renderBody(update.message)}
</StatusEventTimelineMessage>
</div>
</div>
- </div>
+ ))}
</div>
);
}
diff --git a/packages/ui/src/components/blocks/status-feed.tsx b/packages/ui/src/components/blocks/status-feed.tsx
index 41182b075..0928f0a4e 100644
--- a/packages/ui/src/components/blocks/status-feed.tsx
+++ b/packages/ui/src/components/blocks/status-feed.tsx
@@ -273,6 +273,7 @@ export function StatusFeed({
maintenance={{
title: maintenance.title,
message: maintenance.message,
+ maintenanceUpdates: maintenance.maintenanceUpdates,
from: maintenance.from,
to: maintenance.to,
}}
diff --git a/packages/ui/src/components/blocks/status.types.ts b/packages/ui/src/components/blocks/status.types.ts
index 869831bb5..6546a5a8c 100644
--- a/packages/ui/src/components/blocks/status.types.ts
+++ b/packages/ui/src/components/blocks/status.types.ts
@@ -35,7 +35,13 @@ export interface Maintenance {
id: number;
title: string;
affected: string[];
- message: string;
+ /** Fallback body when no `maintenanceUpdates` are given. */
+ message?: string;
+ maintenanceUpdates?: {
+ id: number;
+ date: Date;
+ message: string;
+ }[];
from: Date;
to: Date;
}