Add OpenAPI Link to Docs

casesandberg · Dec 24, 2024 · 6c2dafd · 6c2dafd
1 parent d2cc63d
commit 6c2dafd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/apps/api/lib/openApi.ts b/apps/api/lib/openApi.ts
@@ -107,7 +107,7 @@ async function getDocument() {
     info: {
       title: 'PlayMoney API',
       version: '1.0',
-      description: `Include \`x-api-key: {{key}}\` in the header of your requests. Api key can be generated at [https://playmoney.dev/settings/api](https://playmoney.dev/settings/api)`,
+      description: `Include \`x-api-key: {{key}}\` in the header of your requests. \n\nApi key can be generated at [https://playmoney.dev/settings/api](https://playmoney.dev/settings/api)\n\nOpenAPI spec can be found at [https://github.com/casesandberg/play-money/blob/main/apps/api/openapi.json](https://github.com/casesandberg/play-money/blob/main/apps/api/openapi.json)`,
     },
     servers: process.env.NEXT_PUBLIC_API_URL
       ? [

diff --git a/apps/api/openapi.json b/apps/api/openapi.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "PlayMoney API",
     "version": "1.0",
-    "description": "Include `x-api-key: {{key}}` in the header of your requests. Api key can be generated at [https://playmoney.dev/settings/api](https://playmoney.dev/settings/api)"
+    "description": "Include `x-api-key: {{key}}` in the header of your requests. \n\nApi key can be generated at [https://playmoney.dev/settings/api](https://playmoney.dev/settings/api)\n\nOpenAPI spec can be found at [https://github.com/casesandberg/play-money/blob/main/apps/api/openapi.json](https://github.com/casesandberg/play-money/blob/main/apps/api/openapi.json)"
   },
   "components": {
     "securitySchemes": {