renamed swagger to oas and updated doc-check

.github/workflows/doc-check.yml

@@ -19,12 +19,21 @@ jobs:
         id: checkout
         uses: actions/checkout@v4
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Install Dependencies
+        id: bun-install
+        run: bun install --frozen-lockfile
+
+      - name: Save OpenAPI Specification
+        id: bun-save-oas
+        run: bun save-oas
+
       - name: Check Documentaiton
         id: doc-check
-        uses: alexvuka1/doc-check@d06cb7b25c4f6f4e63c5fd2b97c9d655d983ee88
+        uses: alexvuka1/doc-check@e4fb43620b1cd4bd6e06b37aa00c140ceaea0bff
         with:
-          str: 'World'
-
-      - name: Print Output
-        id: output
-        run: echo "${{ steps.doc-check.outputs.time }}"
+          openapi-path: ${{ github.workspace }}/openapi.json
+          doc-path: ${{ github.workspace }}/docs/api.md
+          token: ${{ secrets.GITHUB_TOKEN }}

.prettierrc

@@ -1,4 +1,5 @@
 {
   "singleQuote": true,
-  "trailingComma": "all"
+  "trailingComma": "all",
+  "tabWidth": 2
 }

package.json

@@ -12,7 +12,7 @@
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
-    "save-swagger": "bun src/saveSwagger.ts",
+    "save-oas": "bun src/saveOAS.ts",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
   },
   "dependencies": {

src/saveOAS.ts

@@ -0,0 +1,18 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { writeFileSync } from 'fs';
+
+const saveOAS = async () => {
+  const app = await NestFactory.create(AppModule);
+
+  const config = new DocumentBuilder()
+    .setTitle('doc-check-demo')
+    .setDescription('The doc-check-demo API description')
+    .setVersion('1.0')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+
+  writeFileSync('./openapi.json', JSON.stringify(document));
+};
+saveOAS();