openstatus.dev
Openstatus
www.openstatus.dev
📝 fix open api docs (#1125)
* 📝 fix open api docs
* ci: apply automated fixes
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
authored by
Thibault Le Ouay
autofix-ci[bot]
and committed by
GitHub
fd018dc0
7929e2a0
+12
+12
apps/server/src/v1/index.ts
+12
apps/server/src/v1/index.ts
···
34
34
35
35
api.use("/openapi", cors());
36
36
37
+
api.openAPIRegistry.registerComponent("securitySchemes", "ApiKeyAuth", {
38
+
type: "apiKey",
39
+
in: "header",
40
+
name: "x-openstatus-key",
41
+
"x-openstatus-key": "string",
42
+
});
43
+
37
44
api.doc("/openapi", {
38
45
openapi: "3.0.0",
39
46
info: {
···
46
53
description:
47
54
"OpenStatus is a open-source synthetic monitoring tool that allows you to monitor your website and API's uptime, latency, and more. \n\n The OpenStatus API allows you to interact with the OpenStatus platform programmatically. \n\n To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings.",
48
55
},
56
+
security: [
57
+
{
58
+
ApiKeyAuth: [],
59
+
},
60
+
],
49
61
});
50
62
51
63
api.get(