feat: enhance OpenAPI specification to exclude sensitive fields from …

…generated schemas
NHL-P2-INF2-DP · Dec 17, 2024 · 18f5023 · 18f5023
1 parent 02b4bd9
commit 18f5023
Showing 1 changed file with 33 additions and 2 deletions.
diff --git a/src/app/api/v1/openapi/route.ts b/src/app/api/v1/openapi/route.ts
@@ -333,7 +333,22 @@ async function generateOpenAPISpec(): Promise<OpenAPIObject> {
         required: true,
         content: {
           'application/json': {
-            schema: { $ref: `#/components/schemas/${modelName}` },
+            schema: {
+              type: 'object',
+              properties: {
+                ...Object.fromEntries(
+                  Object.entries(
+                    spec.components!.schemas![modelName].properties,
+                  ).filter(
+                    ([key]) => !['id', 'createdAt', 'updatedAt'].includes(key),
+                  ),
+                ),
+              },
+              required: spec.components!.schemas![modelName].required?.filter(
+                (field: string) =>
+                  !['id', 'createdAt', 'updatedAt'].includes(field),
+              ),
+            },
           },
         },
       },
@@ -409,7 +424,23 @@ async function generateOpenAPISpec(): Promise<OpenAPIObject> {
           required: true,
           content: {
             'application/json': {
-              schema: { $ref: `#/components/schemas/${modelName}` },
+              schema: {
+                type: 'object',
+                properties: {
+                  ...Object.fromEntries(
+                    Object.entries(
+                      spec.components!.schemas![modelName].properties,
+                    ).filter(
+                      ([key]) =>
+                        !['id', 'createdAt', 'updatedAt'].includes(key),
+                    ),
+                  ),
+                },
+                required: spec.components!.schemas![modelName].required?.filter(
+                  (field: string) =>
+                    !['id', 'createdAt', 'updatedAt'].includes(field),
+                ),
+              },
             },
           },
         },