Openstatus www.openstatus.dev

fix: naming and api reference (#497)

* fix: naming and api reference

* chore: include changelog

* chore: add link to docs

authored by

Maximilian Kaske and committed by
GitHub
aa19183e 15ce8210

+82 -53
-4
apps/docs/api-reference/incident/delete-incident:id.mdx
··· 1 - --- 2 - title: "Delete Incident" 3 - openapi: delete /incident/:id 4 - ---
-4
apps/docs/api-reference/incident/get-incident.mdx
··· 1 - --- 2 - title: Get all incidents 3 - openapi: get /incident/ 4 - ---
-4
apps/docs/api-reference/incident/get-incident:id.mdx
··· 1 - --- 2 - title: Get incident 3 - openapi: get /incident/:id 4 - ---
-4
apps/docs/api-reference/incident/post-incident.mdx
··· 1 - --- 2 - title: Create Incident 3 - openapi: post /incident/ 4 - ---
-4
apps/docs/api-reference/incident/post-incident:idupdate.mdx
··· 1 - --- 2 - title: Create Incident Update 3 - openapi: post /incident/:id/update 4 - ---
-4
apps/docs/api-reference/incident_update/get-incident_update:id.mdx
··· 1 - --- 2 - title: Get Incident Update 3 - openapi: get /incident_update/:id 4 - ---
-4
apps/docs/api-reference/incident_update/post-incident_update.mdx
··· 1 - --- 2 - title: Create Incident Update 3 - openapi: post /incident_update/ 4 - ---
+4
apps/docs/api-reference/status_report/delete-status_report:id.mdx
··· 1 + --- 2 + title: Delete Status Report 3 + openapi: delete /status_report/:id 4 + ---
+4
apps/docs/api-reference/status_report/get-status_report.mdx
··· 1 + --- 2 + title: Get all status reports 3 + openapi: get /status_report/ 4 + ---
+4
apps/docs/api-reference/status_report/get-status_report:id.mdx
··· 1 + --- 2 + title: Get Status Report 3 + openapi: get /status_report/:id 4 + ---
+4
apps/docs/api-reference/status_report/post-status_report.mdx
··· 1 + --- 2 + title: Create Status Report 3 + openapi: post /status_report/ 4 + ---
+4
apps/docs/api-reference/status_report/post-status_report:idupdate.mdx
··· 1 + --- 2 + title: Create Status Report Update 3 + openapi: post /status_report/:id/update 4 + ---
+4
apps/docs/api-reference/status_report_update/get-status_report_update:id.mdx
··· 1 + --- 2 + title: Get Status Report Update 3 + openapi: get /status_report_update/:id 4 + ---
+4
apps/docs/api-reference/status_report_update/post-status_report_update.mdx
··· 1 + --- 2 + title: Create Status Report Update 3 + openapi: post /status_report_update/ 4 + ---
+7 -6
apps/docs/getting-started/incident.mdx
··· 3 3 description: "How to create your first incident 🔥" 4 4 --- 5 5 6 - When creating an incident, you can map it to either to a **status page** or to a 7 - **monitor**. This will allow you access the latest incidents on your status 8 - page. 6 + <Warning> 7 + **Incidents** have been renamed to [Status 8 + Reports](/getting-started/status-report). That also includes the [API 9 + endpoint](/api-reference/status_report). It will allow us to differenciate 10 + between **public status reports** and **internal incident management**. 11 + </Warning> 9 12 10 - Update your incident over time and keep your users informed. Add a new 11 - **status**, **date** and **message** to your incident. They will be displayed on 12 - a timeline. 13 + Coming soon: Internal Incident Management
+11
apps/docs/getting-started/status-report.mdx
··· 1 + --- 2 + title: Status Report 3 + description: "How to create your first report 🔥" 4 + --- 5 + 6 + When creating a status report, you can map it to either to a **status page** or 7 + to a **monitor**. This will allow you access the latest reports on your status 8 + page. 9 + 10 + Update your report over time and keep your users informed. Add a new **status**, 11 + **date** and **message** to your report. They will be displayed on a timeline.
+14 -13
apps/docs/mint.json
··· 74 74 "getting-started/monitor", 75 75 "getting-started/status-page", 76 76 "getting-started/incident", 77 + "getting-started/status-report", 77 78 "getting-started/notification", 78 79 "getting-started/heartbeat" 79 80 ] ··· 114 115 "pages": [ 115 116 "api-reference/auth", 116 117 { 117 - "group": "Incident", 118 - "pages": [ 119 - "api-reference/incident/get-incident:id", 120 - "api-reference/incident/get-incident", 121 - "api-reference/incident/delete-incident:id", 122 - "api-reference/incident/post-incident", 123 - "api-reference/incident/post-incident:idupdate" 124 - ] 125 - }, 126 - { 127 118 "group": "Monitor", 128 119 "pages": [ 129 120 "api-reference/monitor/get-monitor:id", ··· 134 125 ] 135 126 }, 136 127 { 137 - "group": "Incident udpate", 128 + "group": "Status Report", 138 129 "pages": [ 139 - "api-reference/incident_update/get-incident_update:id", 140 - "api-reference/incident_update/post-incident_update" 130 + "api-reference/status_report/get-status_report:id", 131 + "api-reference/status_report/get-status_report", 132 + "api-reference/status_report/delete-status_report:id", 133 + "api-reference/status_report/post-status_report", 134 + "api-reference/status_report/post-status_report:idupdate" 135 + ] 136 + }, 137 + { 138 + "group": "Status Report Udpate", 139 + "pages": [ 140 + "api-reference/status_report_update/get-status_report_update:id", 141 + "api-reference/status_report_update/post-status_report_update" 141 142 ] 142 143 } 143 144 ]
apps/web/public/assets/changelog/golang-monitor-checker.png

This is a binary file and will not be displayed.

+16
apps/web/src/content/changelog/golang-monitor-checker.mdx
··· 1 + --- 2 + title: Golang monitor checker 3 + description: Stability improvement for the the endpoint health checker. 4 + image: /assets/changelog/golang-monitor-checker.png 5 + publishedAt: 2023-12-02 6 + --- 7 + 8 + The endpoint health checker has been improved to be more stable and reliable 9 + with [Go](https://go.dev). In the past, we have been experiencing missing data 10 + endpoints and longer request times for some `regions`. 11 + 12 + In addition to that, we have renamed the **Incidents** to **Status Reports** to 13 + easily distinguish betwwen internal incidents and external reports. 14 + 15 + > The API endpoint has also moved from `/v1/incidents` to `/v1/status_reports`. 16 + > Read more in the [docs](https://docs.openstatus.dev/getting-started/incident).
+2 -2
utils/api-bruno/incident_update/Get Incident Update.bru utils/api-bruno/incident_update/Get Status Report Update.bru
··· 1 1 meta { 2 - name: Get Incident Update 2 + name: Get Status Report Update 3 3 type: http 4 4 seq: 1 5 5 } 6 6 7 7 get { 8 - url: {{url}}/v1/incident_update/{{updateId}} 8 + url: {{url}}/v1/status_report_update/{{updateId}} 9 9 body: none 10 10 auth: none 11 11 }
+2 -2
utils/api-bruno/incidents/All incidents.bru utils/api-bruno/incidents/All Status Reports.bru
··· 1 1 meta { 2 - name: All incidents 2 + name: All Status Reports 3 3 type: http 4 4 seq: 1 5 5 } 6 6 7 7 get { 8 - url: {{url}}/v1/incident 8 + url: {{url}}/v1/status_report 9 9 body: none 10 10 auth: none 11 11 }
+2 -2
utils/api-bruno/incidents/Get on incident.bru utils/api-bruno/incidents/Get Status Report.bru
··· 1 1 meta { 2 - name: Get on incident 2 + name: Get on status report 3 3 type: http 4 4 seq: 2 5 5 } 6 6 7 7 get { 8 - url: {{url}}/v1/incident/{{id}} 8 + url: {{url}}/v1/status_report/{{id}} 9 9 body: none 10 10 auth: none 11 11 }