From dea5af085a2f7450b57ee9908760c0c3d07c0615 Mon Sep 17 00:00:00 2001
From: Shahed Nasser <shahednasser@gmail.com>
Date: Fri, 30 Aug 2024 17:02:02 +0300
Subject: [PATCH] docs-util: fix clean script removing Auth tags (#8911)

* docs-util: fix clean script removing Auth tags

* fix removal of response types other than json
---
 .../src/classes/helpers/schema-factory.ts     |  6 ++++-
 .../docs-generator/src/classes/kinds/oas.ts   | 25 +++++++++++++++++--
 .../docs-generator/src/commands/clean-oas.ts  |  7 +++++-
 3 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts b/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts
index c84adf2a3e..85a73523e3 100644
--- a/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts
+++ b/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts
@@ -76,7 +76,11 @@ class SchemaFactory {
     let schema = Object.assign({}, schemasFactory[key])
 
     if (additionalData) {
-      schema = Object.assign(schema, additionalData)
+      schema = Object.assign(schema, {
+        ...additionalData,
+        // keep the description
+        description: schema.description || additionalData.description
+      })
     }
 
     return schema
diff --git a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts
index 706dede7ae..ce4e725344 100644
--- a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts
+++ b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts
@@ -506,8 +506,11 @@ class OasKindGenerator extends FunctionKindGenerator {
       }
       updatedResponseSchema = newResponseSchema
     } else if (oas.responses && !newResponseSchema) {
-      // remove response schema by only keeping the default responses
-      oas.responses = DEFAULT_OAS_RESPONSES
+      // check if it has a success response of a type other than JSON
+      if (!this.hasResponseType(node, oas)) {
+        // remove response schema by only keeping the default responses
+        oas.responses = DEFAULT_OAS_RESPONSES
+      }
     } else {
       // check if response status should be changed
       const oldResponseStatus = Object.keys(oas.responses!).find(
@@ -2070,6 +2073,24 @@ class OasKindGenerator extends FunctionKindGenerator {
     )
   }
 
+  hasResponseType(node: FunctionNode, oas: OpenApiOperation): boolean {
+    const oldResponseStatus = Object.keys(oas.responses!).find(
+      (status) => !Object.keys(DEFAULT_OAS_RESPONSES).includes(status)
+    )
+    if (!oldResponseStatus) {
+      return false
+    }
+
+    const responseContent = (oas.responses![oldResponseStatus] as OpenAPIV3.ResponseObject).content
+    if (!responseContent) {
+      return false
+    }
+
+    const fnText = node.getText()
+
+    return Object.keys(responseContent).some((responseType) => fnText.includes(responseType))
+  }
+
   private removeStringRegExpTypeOverlaps(types: ts.Type[]): ts.Type[] {
     return types.filter((itemType) => {
       // remove overlapping string / regexp types
diff --git a/www/utils/packages/docs-generator/src/commands/clean-oas.ts b/www/utils/packages/docs-generator/src/commands/clean-oas.ts
index e2b5ad1679..1854614fb2 100644
--- a/www/utils/packages/docs-generator/src/commands/clean-oas.ts
+++ b/www/utils/packages/docs-generator/src/commands/clean-oas.ts
@@ -26,6 +26,11 @@ const ignoreSchemas = [
   "AuthStoreSessionResponse",
 ]
 
+const ignoreTags = {
+  admin: ["Auth"],
+  store: ["Auth"]
+}
+
 export default async function () {
   const oasOutputBasePath = getOasOutputBasePath()
   const oasOperationsPath = path.join(oasOutputBasePath, "operations")
@@ -225,7 +230,7 @@ export default async function () {
     const lengthBefore = parsedBaseYaml.tags?.length || 0
 
     parsedBaseYaml.tags = parsedBaseYaml.tags?.filter((tag) =>
-      areaTags.has(tag.name)
+      areaTags.has(tag.name) || ignoreTags[area].includes(tag.name)
     )
 
     if (lengthBefore !== (parsedBaseYaml.tags?.length || 0)) {