Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
fix: naming and api reference (#497)
Maximilian Kaskeaa19183ece99
diff --git a/apps/docs/api-reference/incident/delete-incident:id.mdx b/apps/docs/api-reference/incident/delete-incident:id.mdxdeleted file mode 100644index b24b26c21..000000000--- a/apps/docs/api-reference/incident/delete-incident:id.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: "Delete Incident"-openapi: delete /incident/:id----diff --git a/apps/docs/api-reference/incident/get-incident.mdx b/apps/docs/api-reference/incident/get-incident.mdxdeleted file mode 100644index 3e943dcf9..000000000--- a/apps/docs/api-reference/incident/get-incident.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Get all incidents-openapi: get /incident/----diff --git a/apps/docs/api-reference/incident/get-incident:id.mdx b/apps/docs/api-reference/incident/get-incident:id.mdxdeleted file mode 100644index 4cef98dfe..000000000--- a/apps/docs/api-reference/incident/get-incident:id.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Get incident-openapi: get /incident/:id----diff --git a/apps/docs/api-reference/incident/post-incident.mdx b/apps/docs/api-reference/incident/post-incident.mdxdeleted file mode 100644index 2c1374f94..000000000--- a/apps/docs/api-reference/incident/post-incident.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Create Incident-openapi: post /incident/----diff --git a/apps/docs/api-reference/incident/post-incident:idupdate.mdx b/apps/docs/api-reference/incident/post-incident:idupdate.mdxdeleted file mode 100644index 39a8c48d8..000000000--- a/apps/docs/api-reference/incident/post-incident:idupdate.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Create Incident Update-openapi: post /incident/:id/update----diff --git a/apps/docs/api-reference/incident_update/get-incident_update:id.mdx b/apps/docs/api-reference/incident_update/get-incident_update:id.mdxdeleted file mode 100644index 8b2a91955..000000000--- a/apps/docs/api-reference/incident_update/get-incident_update:id.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Get Incident Update-openapi: get /incident_update/:id----diff --git a/apps/docs/api-reference/incident_update/post-incident_update.mdx b/apps/docs/api-reference/incident_update/post-incident_update.mdxdeleted file mode 100644index bedc784b8..000000000--- a/apps/docs/api-reference/incident_update/post-incident_update.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Create Incident Update-openapi: post /incident_update/----diff --git a/apps/docs/api-reference/status_report/delete-status_report:id.mdx b/apps/docs/api-reference/status_report/delete-status_report:id.mdxnew file mode 100644index 000000000..1b7a491b9--- /dev/null+++ b/apps/docs/api-reference/status_report/delete-status_report:id.mdx@@ -0,0 +1,4 @@+---+title: Delete Status Report+openapi: delete /status_report/:id+---diff --git a/apps/docs/api-reference/status_report/get-status_report.mdx b/apps/docs/api-reference/status_report/get-status_report.mdxnew file mode 100644index 000000000..a4b5f581e--- /dev/null+++ b/apps/docs/api-reference/status_report/get-status_report.mdx@@ -0,0 +1,4 @@+---+title: Get all status reports+openapi: get /status_report/+---diff --git a/apps/docs/api-reference/status_report/get-status_report:id.mdx b/apps/docs/api-reference/status_report/get-status_report:id.mdxnew file mode 100644index 000000000..3d50f941c--- /dev/null+++ b/apps/docs/api-reference/status_report/get-status_report:id.mdx@@ -0,0 +1,4 @@+---+title: Get Status Report+openapi: get /status_report/:id+---diff --git a/apps/docs/api-reference/status_report/post-status_report.mdx b/apps/docs/api-reference/status_report/post-status_report.mdxnew file mode 100644index 000000000..8e69e9db7--- /dev/null+++ b/apps/docs/api-reference/status_report/post-status_report.mdx@@ -0,0 +1,4 @@+---+title: Create Status Report+openapi: post /status_report/+---diff --git a/apps/docs/api-reference/status_report/post-status_report:idupdate.mdx b/apps/docs/api-reference/status_report/post-status_report:idupdate.mdxnew file mode 100644index 000000000..4fe269947--- /dev/null+++ b/apps/docs/api-reference/status_report/post-status_report:idupdate.mdx@@ -0,0 +1,4 @@+---+title: Create Status Report Update+openapi: post /status_report/:id/update+---diff --git a/apps/docs/api-reference/status_report_update/get-status_report_update:id.mdx b/apps/docs/api-reference/status_report_update/get-status_report_update:id.mdxnew file mode 100644index 000000000..ee79a3535--- /dev/null+++ b/apps/docs/api-reference/status_report_update/get-status_report_update:id.mdx@@ -0,0 +1,4 @@+---+title: Get Status Report Update+openapi: get /status_report_update/:id+---diff --git a/apps/docs/api-reference/status_report_update/post-status_report_update.mdx b/apps/docs/api-reference/status_report_update/post-status_report_update.mdxnew file mode 100644index 000000000..60f773837--- /dev/null+++ b/apps/docs/api-reference/status_report_update/post-status_report_update.mdx@@ -0,0 +1,4 @@+---+title: Create Status Report Update+openapi: post /status_report_update/+---diff --git a/apps/docs/getting-started/incident.mdx b/apps/docs/getting-started/incident.mdxindex c39e334f7..a48e0f322 100644--- a/apps/docs/getting-started/incident.mdx+++ b/apps/docs/getting-started/incident.mdx@@ -3,10 +3,11 @@ title: Incidentdescription: "How to create your first incident 🔥"----When creating an incident, you can map it to either to a **status page** or to a-**monitor**. This will allow you access the latest incidents on your status-page.+<Warning>+ **Incidents** have been renamed to [Status+ Reports](/getting-started/status-report). That also includes the [API+ endpoint](/api-reference/status_report). It will allow us to differenciate+ between **public status reports** and **internal incident management**.+</Warning>-Update your incident over time and keep your users informed. Add a new-**status**, **date** and **message** to your incident. They will be displayed on-a timeline.+Coming soon: Internal Incident Managementdiff --git a/apps/docs/getting-started/status-report.mdx b/apps/docs/getting-started/status-report.mdxnew file mode 100644index 000000000..1f8134031--- /dev/null+++ b/apps/docs/getting-started/status-report.mdx@@ -0,0 +1,11 @@+---+title: Status Report+description: "How to create your first report 🔥"+---++When creating a status report, you can map it to either to a **status page** or+to a **monitor**. This will allow you access the latest reports on your status+page.++Update your report over time and keep your users informed. Add a new **status**,+**date** and **message** to your report. They will be displayed on a timeline.diff --git a/apps/docs/mint.json b/apps/docs/mint.jsonindex edd397287..d0d05a8ce 100644--- a/apps/docs/mint.json+++ b/apps/docs/mint.json@@ -74,6 +74,7 @@"getting-started/monitor","getting-started/status-page","getting-started/incident",+ "getting-started/status-report","getting-started/notification","getting-started/heartbeat"]@@ -113,16 +114,6 @@"icon": "code","pages": ["api-reference/auth",- {- "group": "Incident",- "pages": [- "api-reference/incident/get-incident:id",- "api-reference/incident/get-incident",- "api-reference/incident/delete-incident:id",- "api-reference/incident/post-incident",- "api-reference/incident/post-incident:idupdate"- ]- },{"group": "Monitor","pages": [@@ -134,10 +125,20 @@]},{- "group": "Incident udpate",+ "group": "Status Report",+ "pages": [+ "api-reference/status_report/get-status_report:id",+ "api-reference/status_report/get-status_report",+ "api-reference/status_report/delete-status_report:id",+ "api-reference/status_report/post-status_report",+ "api-reference/status_report/post-status_report:idupdate"+ ]+ },+ {+ "group": "Status Report Udpate","pages": [- "api-reference/incident_update/get-incident_update:id",- "api-reference/incident_update/post-incident_update"+ "api-reference/status_report_update/get-status_report_update:id",+ "api-reference/status_report_update/post-status_report_update"]}]diff --git a/apps/web/public/assets/changelog/golang-monitor-checker.png b/apps/web/public/assets/changelog/golang-monitor-checker.pngnew file mode 100644index 000000000..cc748c7cdBinary files /dev/null and b/apps/web/public/assets/changelog/golang-monitor-checker.png differdiff --git a/apps/web/src/content/changelog/golang-monitor-checker.mdx b/apps/web/src/content/changelog/golang-monitor-checker.mdxnew file mode 100644index 000000000..63d8984ba--- /dev/null+++ b/apps/web/src/content/changelog/golang-monitor-checker.mdx@@ -0,0 +1,16 @@+---+title: Golang monitor checker+description: Stability improvement for the the endpoint health checker.+image: /assets/changelog/golang-monitor-checker.png+publishedAt: 2023-12-02+---++The endpoint health checker has been improved to be more stable and reliable+with [Go](https://go.dev). In the past, we have been experiencing missing data+endpoints and longer request times for some `regions`.++In addition to that, we have renamed the **Incidents** to **Status Reports** to+easily distinguish betwwen internal incidents and external reports.++> The API endpoint has also moved from `/v1/incidents` to `/v1/status_reports`.+> Read more in the [docs](https://docs.openstatus.dev/getting-started/incident).diff --git a/utils/api-bruno/incident_update/Get Incident Update.bru b/utils/api-bruno/incident_update/Get Status Report Update.brusimilarity index 62%rename from utils/api-bruno/incident_update/Get Incident Update.brurename to utils/api-bruno/incident_update/Get Status Report Update.bruindex 2a25d654b..40fd7b36c 100644--- a/utils/api-bruno/incident_update/Get Incident Update.bru+++ b/utils/api-bruno/incident_update/Get Status Report Update.bru@@ -1,11 +1,11 @@meta {- name: Get Incident Update+ name: Get Status Report Updatetype: httpseq: 1}get {- url: {{url}}/v1/incident_update/{{updateId}}+ url: {{url}}/v1/status_report_update/{{updateId}}body: noneauth: none}diff --git a/utils/api-bruno/incidents/All incidents.bru b/utils/api-bruno/incidents/All Status Reports.brusimilarity index 64%rename from utils/api-bruno/incidents/All incidents.brurename to utils/api-bruno/incidents/All Status Reports.bruindex a1024ddcf..ad399cd63 100644--- a/utils/api-bruno/incidents/All incidents.bru+++ b/utils/api-bruno/incidents/All Status Reports.bru@@ -1,11 +1,11 @@meta {- name: All incidents+ name: All Status Reportstype: httpseq: 1}get {- url: {{url}}/v1/incident+ url: {{url}}/v1/status_reportbody: noneauth: none}diff --git a/utils/api-bruno/incidents/Get on incident.bru b/utils/api-bruno/incidents/Get Status Report.brusimilarity index 66%rename from utils/api-bruno/incidents/Get on incident.brurename to utils/api-bruno/incidents/Get Status Report.bruindex 1bbc7d626..08249e9bf 100644--- a/utils/api-bruno/incidents/Get on incident.bru+++ b/utils/api-bruno/incidents/Get Status Report.bru@@ -1,11 +1,11 @@meta {- name: Get on incident+ name: Get on status reporttype: httpseq: 2}get {- url: {{url}}/v1/incident/{{id}}+ url: {{url}}/v1/status_report/{{id}}body: noneauth: none}