From 486b4839ba7251d88311f20242f75bc2b8010d37 Mon Sep 17 00:00:00 2001 From: Thibault Le Ouay Date: Tue, 4 Jun 2024 10:14:27 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20some=20typo=20(#861)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/docs/api-reference/auth.mdx | 1 - apps/server/src/v1/incidents/get_all.ts | 2 +- apps/server/src/v1/monitors/summary/get.ts | 2 +- apps/server/src/v1/statusReportUpdates/get.ts | 3 ++- apps/server/src/v1/statusReportUpdates/post.ts | 1 + apps/server/src/v1/statusReports/delete.ts | 2 +- apps/server/src/v1/statusReports/get.ts | 2 +- apps/server/src/v1/statusReports/get_all.ts | 2 +- apps/server/src/v1/statusReports/post.ts | 2 +- 9 files changed, 9 insertions(+), 8 deletions(-) diff --git a/apps/docs/api-reference/auth.mdx b/apps/docs/api-reference/auth.mdx index ba4af00b26..2759afbf9f 100644 --- a/apps/docs/api-reference/auth.mdx +++ b/apps/docs/api-reference/auth.mdx @@ -22,4 +22,3 @@ Use the above snippet to try it out. We currently do not have an SDK to make the best out of it. Any contributions are welcome. -The API infrastructure is powered by [Unkey](https://unkey.dev). diff --git a/apps/server/src/v1/incidents/get_all.ts b/apps/server/src/v1/incidents/get_all.ts index bc4e501174..e9218cd4fe 100644 --- a/apps/server/src/v1/incidents/get_all.ts +++ b/apps/server/src/v1/incidents/get_all.ts @@ -11,7 +11,7 @@ import { HTTPException } from "hono/http-exception"; const getAllRoute = createRoute({ method: "get", tags: ["incident"], - description: "Get all incidents", + description: "Get all Incidents", path: "/", request: {}, responses: { diff --git a/apps/server/src/v1/monitors/summary/get.ts b/apps/server/src/v1/monitors/summary/get.ts index 9110b98ac9..e0dcd1f1a3 100644 --- a/apps/server/src/v1/monitors/summary/get.ts +++ b/apps/server/src/v1/monitors/summary/get.ts @@ -33,7 +33,7 @@ const dailyStatsSchemaArray = z const getMonitorStats = createRoute({ method: "get", tags: ["monitor"], - description: "Get monitor daily summary", + description: "Get a monitor daily summary", path: "/:id/summary", request: { params: ParamsSchema, diff --git a/apps/server/src/v1/statusReportUpdates/get.ts b/apps/server/src/v1/statusReportUpdates/get.ts index 4d5f61b146..70c75f04c9 100644 --- a/apps/server/src/v1/statusReportUpdates/get.ts +++ b/apps/server/src/v1/statusReportUpdates/get.ts @@ -11,6 +11,7 @@ import { HTTPException } from "hono/http-exception"; const getRoute = createRoute({ method: "get", tags: ["status_report_update"], + description: "Get a Status Reports Update", path: "/:id", request: { params: ParamsSchema, @@ -22,7 +23,7 @@ const getRoute = createRoute({ schema: StatusReportUpdateSchema, }, }, - description: "Get all status report updates", + description: "Get a status report update", }, ...openApiErrorResponses, }, diff --git a/apps/server/src/v1/statusReportUpdates/post.ts b/apps/server/src/v1/statusReportUpdates/post.ts index 3498515a75..7e5835c55f 100644 --- a/apps/server/src/v1/statusReportUpdates/post.ts +++ b/apps/server/src/v1/statusReportUpdates/post.ts @@ -18,6 +18,7 @@ import { HTTPException } from "hono/http-exception"; const createStatusUpdate = createRoute({ method: "post", tags: ["status_report_update"], + description: "Create a Status Report Update", path: "/", request: { body: { diff --git a/apps/server/src/v1/statusReports/delete.ts b/apps/server/src/v1/statusReports/delete.ts index 93ebb59cab..e0ac5c656c 100644 --- a/apps/server/src/v1/statusReports/delete.ts +++ b/apps/server/src/v1/statusReports/delete.ts @@ -11,7 +11,7 @@ import { HTTPException } from "hono/http-exception"; const deleteRoute = createRoute({ method: "delete", tags: ["status_report"], - description: "Delete an status report", + description: "Delete a Status Report", path: "/:id", request: { params: ParamsSchema, diff --git a/apps/server/src/v1/statusReports/get.ts b/apps/server/src/v1/statusReports/get.ts index e0ace02fee..28e870fdcf 100644 --- a/apps/server/src/v1/statusReports/get.ts +++ b/apps/server/src/v1/statusReports/get.ts @@ -11,7 +11,7 @@ import { HTTPException } from "hono/http-exception"; const getRoute = createRoute({ method: "get", tags: ["status_report"], - description: "Get an status report", + description: "Get a Status Report", path: "/:id", request: { params: ParamsSchema, diff --git a/apps/server/src/v1/statusReports/get_all.ts b/apps/server/src/v1/statusReports/get_all.ts index 0b8159ecc9..4dff1a52b9 100644 --- a/apps/server/src/v1/statusReports/get_all.ts +++ b/apps/server/src/v1/statusReports/get_all.ts @@ -11,7 +11,7 @@ import { HTTPException } from "hono/http-exception"; const getAllRoute = createRoute({ method: "get", tags: ["status_report"], - description: "Get all status reports", + description: "Get all Status Reports", path: "/", request: {}, responses: { diff --git a/apps/server/src/v1/statusReports/post.ts b/apps/server/src/v1/statusReports/post.ts index 42327fae56..15d4e2204b 100644 --- a/apps/server/src/v1/statusReports/post.ts +++ b/apps/server/src/v1/statusReports/post.ts @@ -21,7 +21,7 @@ import { sendEmailHtml } from "@openstatus/emails"; const postRoute = createRoute({ method: "post", tags: ["status_report"], - description: "Create an status report", + description: "Create a Status Report", path: "/", request: { body: {