Merge pull request #12 from CharlyJazz/fixtags

discover tags if there is not tags array

src/lib/PrettyRestDoc.tsx

@@ -15,6 +15,10 @@ import { Navigation } from "./components/Navigation";
 import { SearchModal } from "./components/SearchModal";
 import Section from "./components/Section";
 import Spinner from "./components/Spinner";
+import {
+  getMissingAttributes,
+  validationReasons,
+} from "./fileValidationHelpers";
 interface Props {
   docSwagger?: OpenAPIV3.Document;
   docCustom?: SectionItem[];
@@ -171,47 +175,6 @@ const PrettyRestDoc: FC<Props> = ({
     index++;
   }
 
-  const getMissingAttributes = (jsonParsed: any): string[] => {
-    const requiredAttributes = [
-      "openapi",
-      "info",
-      "info.title",
-      "tags",
-      "paths",
-      "components",
-    ];
-
-    const missingAttributes: string[] = [];
-    for (const attr of requiredAttributes) {
-      const attrParts = attr.split(".");
-      let currentObj = jsonParsed;
-      let isValid = true;
-      for (const part of attrParts) {
-        if (!(part in currentObj)) {
-          isValid = false;
-          break;
-        }
-        currentObj = currentObj[part];
-      }
-      if (!isValid) {
-        missingAttributes.push(attr);
-      }
-    }
-    return missingAttributes;
-  };
-
-  const reason = (attr: string): string => {
-    const reasons: Record<string, string> = {
-      openapi: "It defines the OpenAPI version of the document.",
-      info: "It provides metadata about the API.",
-      "info.title": "It specifies the title of the API.",
-      tags: "It categorizes API operations into groups.",
-      paths: "It defines the available API endpoints.",
-      components: "It holds reusable components used in the specification.",
-    };
-    return reasons[attr] || "Unknown reason.";
-  };
-
   const parseOpenAPIFile = async (file: File) => {
     try {
       setInitialLoading(true);
@@ -227,7 +190,7 @@ const PrettyRestDoc: FC<Props> = ({
             const missingAttributesMsg = missingAttributes
               .map(
                 (attr) =>
-                  `Critical attribute: "${attr}" is not in the JSON File\nYou must add it in order to render it.\nThis value is important because: ${reason(
+                  `Critical attribute: "${attr}" is not in the JSON File\nYou must add it in order to render it.\nThis value is important because: ${validationReasons(
                     attr
                   )}.\n`
               )

src/lib/adapter-oa3/adapter/AdaptarOA3FromFileInput.ts

@@ -1,8 +1,9 @@
-import { OpenAPIV3 } from "openapi-types";
 import { Resolver } from "@stoplight/json-ref-resolver";
-import getArrayOfEndpoints from "./getArrayOfEndpoints";
+import { OpenAPIV3 } from "openapi-types";
 import { capitalizeFirstWord } from "../../../utils/capitalize";
 import { AdaptarOA3 } from "./AdaptarOA3";
+import discoveryTagsFromPaths from "./discoveryTagsFromPaths";
+import getArrayOfEndpoints from "./getArrayOfEndpoints";
 
 const resolver = new Resolver();
 
@@ -17,8 +18,11 @@ class AdaptarOA3FromFileInput extends AdaptarOA3 {
     const swaggerDocResolvedResult =
       swaggerDocResolved.result as OpenAPIV3.Document;
     const docMerged: SectionItem[] = [];
+    const tags =
+      swaggerDocResolvedResult.tags ||
+      discoveryTagsFromPaths(swaggerDocResolvedResult);
 
-    for (const tag of swaggerDocResolvedResult.tags || []) {
+    for (const tag of tags) {
       if (!tag.name) {
         console.warn(
           `There is a tag without name and we can not create the documentation without it`

src/lib/adapter-oa3/adapter/discoveryTagsFromPaths.ts

@@ -0,0 +1,44 @@
+import { OpenAPIV3 } from "openapi-types";
+
+const discoveryTagsFromPaths = (
+  openApiDocument: OpenAPIV3.Document
+): OpenAPIV3.TagObject[] => {
+  const tags: OpenAPIV3.TagObject[] = [];
+
+  if (openApiDocument.paths) {
+    for (const pathKey in openApiDocument.paths) {
+      const pathItem = openApiDocument.paths[
+        pathKey
+      ] as OpenAPIV3.PathItemObject;
+
+      if (pathItem) {
+        for (const methodKey in pathItem) {
+          if (methodKey !== "parameters") {
+            const method = (pathItem as any)[
+              methodKey
+            ] as OpenAPIV3.OperationObject;
+            if (method.tags && Array.isArray(method.tags)) {
+              method.tags.forEach((tag) => {
+                const existingTag = tags.find((t) => t.name === tag);
+                if (!existingTag) {
+                  tags.push({
+                    name: tag,
+                    description: `Section grouped by ${tag}`,
+                    externalDocs: {
+                      url: "",
+                      description: "",
+                    },
+                  });
+                }
+              });
+            }
+          }
+        }
+      }
+    }
+  }
+
+  return tags;
+};
+
+export default discoveryTagsFromPaths;

src/lib/fileValidationHelpers.ts

@@ -0,0 +1,38 @@
+export const getMissingAttributes = (jsonParsed: any): string[] => {
+  const requiredAttributes = [
+    "openapi",
+    "info",
+    "info.title",
+    "paths",
+    "components",
+  ];
+
+  const missingAttributes: string[] = [];
+  for (const attr of requiredAttributes) {
+    const attrParts = attr.split(".");
+    let currentObj = jsonParsed;
+    let isValid = true;
+    for (const part of attrParts) {
+      if (!(part in currentObj)) {
+        isValid = false;
+        break;
+      }
+      currentObj = currentObj[part];
+    }
+    if (!isValid) {
+      missingAttributes.push(attr);
+    }
+  }
+  return missingAttributes;
+};
+
+export const validationReasons = (attr: string): string => {
+  const reasons: Record<string, string> = {
+    openapi: "It defines the OpenAPI version of the document.",
+    info: "It provides metadata about the API.",
+    "info.title": "It specifies the title of the API.",
+    paths: "It defines the available API endpoints.",
+    components: "It holds reusable components used in the specification.",
+  };
+  return reasons[attr] || "Unknown reason.";
+};