From f0f83afdd956f982cccc36a62149de9183faee37 Mon Sep 17 00:00:00 2001
From: Shahed Nasser <shahednasser@gmail.com>
Date: Fri, 16 Aug 2024 12:37:03 +0300
Subject: [PATCH] docs-util: fix update OAS schema (#8556)

* docs-util: fix update OAS schema

* fix to updating

* fix condition
---
 .../classes/helpers/knowledge-base-factory.ts |  5 ++
 .../docs-generator/src/classes/kinds/oas.ts   | 79 +++++++++++++++----
 2 files changed, 68 insertions(+), 16 deletions(-)

diff --git a/www/utils/packages/docs-generator/src/classes/helpers/knowledge-base-factory.ts b/www/utils/packages/docs-generator/src/classes/helpers/knowledge-base-factory.ts
index 98300513c4..bd61776e9e 100644
--- a/www/utils/packages/docs-generator/src/classes/helpers/knowledge-base-factory.ts
+++ b/www/utils/packages/docs-generator/src/classes/helpers/knowledge-base-factory.ts
@@ -518,6 +518,11 @@ class KnowledgeBaseFactory {
     },
   ]
   private oasDescriptionKnowledgeBase: KnowledgeBase[] = [
+    {
+      exact: "additional_data",
+      template:
+        "Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.",
+    },
     {
       pattern: /.*/,
       template(str, options) {
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 f81dfe9023..44206a4c2f 100644
--- a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts
+++ b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts
@@ -1739,7 +1739,7 @@ class OasKindGenerator extends FunctionKindGenerator {
       return
     }
 
-    const oldSchemaObj = (
+    let oldSchemaObj = (
       oldSchema && "$ref" in oldSchema
         ? this.oasSchemaHelper.getSchemaByName(oldSchema.$ref)?.schema
         : oldSchema
@@ -1756,23 +1756,33 @@ class OasKindGenerator extends FunctionKindGenerator {
       return undefined
     }
 
-    // update schema
-    if (oldSchemaObj!.type !== newSchemaObj?.type) {
-      oldSchemaObj!.type = newSchemaObj?.type
-    }
+    const oldSchemaType = this.inferOasSchemaType(oldSchemaObj)
+    const newSchemaType = this.inferOasSchemaType(newSchemaObj)
 
-    if (
-      oldSchemaObj!.description !== newSchemaObj?.description &&
-      oldSchemaObj!.description === SUMMARY_PLACEHOLDER
+    if (oldSchemaType !== newSchemaType && newSchemaType && newSchemaObj) {
+      oldSchemaObj = {
+        ...newSchemaObj,
+        description: oldSchemaObj?.description,
+      }
+    } else if (
+      oldSchemaObj?.allOf &&
+      newSchemaObj.allOf &&
+      oldSchemaObj.allOf.length !== newSchemaObj.allOf.length
     ) {
-      oldSchemaObj!.description =
-        newSchemaObj?.description || SUMMARY_PLACEHOLDER
-    }
-
-    oldSchemaObj!.required = newSchemaObj?.required
-    oldSchemaObj!["x-schemaName"] = newSchemaObj?.["x-schemaName"]
-
-    if (oldSchemaObj!.type === "object") {
+      oldSchemaObj.allOf = newSchemaObj.allOf
+    } else if (
+      oldSchemaObj?.oneOf &&
+      newSchemaObj.oneOf &&
+      oldSchemaObj.oneOf.length !== newSchemaObj.oneOf.length
+    ) {
+      oldSchemaObj.oneOf = newSchemaObj.oneOf
+    } else if (
+      oldSchemaObj?.anyOf &&
+      newSchemaObj.anyOf &&
+      oldSchemaObj.anyOf.length !== newSchemaObj.anyOf.length
+    ) {
+      oldSchemaObj.anyOf = newSchemaObj.anyOf
+    } else if (oldSchemaType === "object") {
       if (!oldSchemaObj?.properties && newSchemaObj?.properties) {
         oldSchemaObj!.properties = newSchemaObj.properties
       } else if (!newSchemaObj?.properties) {
@@ -1823,9 +1833,46 @@ class OasKindGenerator extends FunctionKindGenerator {
         }) || oldSchemaObj.items
     }
 
+    // update schema
+
+    if (
+      oldSchemaObj!.description !== newSchemaObj?.description &&
+      oldSchemaObj!.description === SUMMARY_PLACEHOLDER
+    ) {
+      oldSchemaObj!.description =
+        newSchemaObj?.description || SUMMARY_PLACEHOLDER
+    }
+
+    oldSchemaObj!.required = newSchemaObj?.required
+    oldSchemaObj!["x-schemaName"] = newSchemaObj?.["x-schemaName"]
+
     return oldSchemaObj
   }
 
+  /**
+   * This method infers a schema's type.
+   *
+   * @param schema - The schema to infer its type
+   * @returns The type, if available.
+   */
+  inferOasSchemaType(schema?: OpenApiSchema): string | undefined {
+    switch (true) {
+      case schema === undefined:
+        return undefined
+      case schema?.allOf !== undefined:
+        return "allOf"
+      case schema?.anyOf !== undefined:
+        return "anyOf"
+      case schema?.oneOf !== undefined:
+        return "oneOf"
+      case schema?.type !== undefined:
+        return schema.type
+      case schema !== undefined:
+      default:
+        return "object"
+    }
+  }
+
   /**
    * This method retrieves the workflow used in an API route.
    *