From 0b0fb3335914357cd99dc619989a9414ce4d2e4e Mon Sep 17 00:00:00 2001
From: "devin-ai-integration[bot]"
 <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Date: Fri, 24 Jan 2025 15:09:46 -0800
Subject: [PATCH] Always show Reference section in connector docs (#52143)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Aaron <AJ> Steers <aj@airbyte.io>
---
 docusaurus/src/remark/specDecoration.js | 111 ++++++++++++++++++++++--
 1 file changed, 104 insertions(+), 7 deletions(-)

diff --git a/docusaurus/src/remark/specDecoration.js b/docusaurus/src/remark/specDecoration.js
index ff87476ab7aa3..3656296715bb8 100644
--- a/docusaurus/src/remark/specDecoration.js
+++ b/docusaurus/src/remark/specDecoration.js
@@ -1,5 +1,5 @@
 const visit = require("unist-util-visit").visit;
-const { catalog, isPypiConnector } = require("../connector_registry");
+const { catalog } = require("../connector_registry");
 const { isDocsPage, getRegistryEntry } = require("./utils");
 
 const plugin = () => {
@@ -36,17 +36,41 @@ async function injectDefaultPyAirbyteSection(vfile, ast) {
   if (
     !docsPageInfo.isTrueDocsPage ||
     !registryEntry ||
-    !isPypiConnector(registryEntry) ||
     vfile.value.includes("## Usage with PyAirbyte")
   ) {
     return;
   }
   const connectorName = registryEntry.dockerRepository_oss.split("/").pop();
+  const hasValidSpec = registryEntry.spec_oss && registryEntry.spec_oss.connectionSpecification;
 
   let added = false;
   visit(ast, "heading", (node, index, parent) => {
     if (!added && isChangelogHeading(node)) {
       added = true;
+      const referenceContent = hasValidSpec ? [
+        {
+          type: "mdxJsxFlowElement",
+          name: "SpecSchema",
+          attributes: [
+            {
+              type: "mdxJsxAttribute",
+              name: "connector",
+              value: connectorName,
+            },
+          ],
+        }
+      ] : [
+        {
+          type: "paragraph",
+          children: [
+            {
+              type: "text",
+              value: "No configuration specification is available for this connector."
+            }
+          ]
+        }
+      ];
+
       parent.children.splice(
         index,
         0,
@@ -55,6 +79,65 @@ async function injectDefaultPyAirbyteSection(vfile, ast) {
           depth: 2,
           children: [{ type: "text", value: "Reference" }],
         },
+        ...referenceContent
+      );
+    }
+  });
+  if (!added) {
+    // If no Changelog heading found, try to find first h2 heading
+    let firstH2Index = -1;
+    visit(ast, "heading", (node, index) => {
+      if (!added && node.depth === 2 && firstH2Index === -1) {
+        firstH2Index = index;
+      }
+    });
+
+    // Insert after first h2 if found
+    if (firstH2Index >= 0) {
+      visit(ast, "heading", (node, index, parent) => {
+        if (index === firstH2Index) {
+          added = true;
+          const referenceContent = hasValidSpec ? [
+            {
+              type: "mdxJsxFlowElement",
+              name: "SpecSchema",
+              attributes: [
+                {
+                  type: "mdxJsxAttribute",
+                  name: "connector",
+                  value: connectorName,
+                },
+              ],
+            }
+          ] : [
+            {
+              type: "paragraph",
+              children: [
+                {
+                  type: "text",
+                  value: "No configuration specification is available for this connector."
+                }
+              ]
+            }
+          ];
+
+          parent.children.splice(
+            index + 1,
+            0,
+            {
+              type: "heading",
+              depth: 2,
+              children: [{ type: "text", value: "Reference" }],
+            },
+            ...referenceContent
+          );
+        }
+      });
+    }
+
+    // If still not added, append to end of document
+    if (!added) {
+      const referenceContent = hasValidSpec ? [
         {
           type: "mdxJsxFlowElement",
           name: "SpecSchema",
@@ -66,13 +149,27 @@ async function injectDefaultPyAirbyteSection(vfile, ast) {
             },
           ],
         }
+      ] : [
+        {
+          type: "paragraph",
+          children: [
+            {
+              type: "text",
+              value: "No configuration specification is available for this connector."
+            }
+          ]
+        }
+      ];
+
+      ast.children.push(
+        {
+          type: "heading",
+          depth: 2,
+          children: [{ type: "text", value: "Reference" }],
+        },
+        ...referenceContent
       );
     }
-  });
-  if (!added) {
-    throw new Error(
-      `Could not find a changelog heading in ${vfile.path} to add the default PyAirbyte section. This connector won't have a reference section. Make sure there is either a ## Changelog section or add a manual reference section.`
-    );
   }
 }