@digi-frontend/dgate-api-documentation 1.0.84 → 1.0.86

package/src/helpers/layout.helper.ts

@@ -2,6 +2,11 @@ import { TransformedPathsArray } from '@entities/layout.type'
 import { OpenAPIFile, SecurityScheme } from '@entities/openApi'
 import { TransformedOpenApi } from '@entities/transformedOpenApi'
 
+const resolveRef = (ref: string, openApiJson: OpenAPIFile): Object => {
+  const parts = ref.replace(/^#\//, '').split('/')
+  return parts.reduce((obj, key) => obj?.[key], openApiJson)
+}
+
 export const transformOpenApiObject = (openApiJson: OpenAPIFile): TransformedOpenApi => {
   if (openApiJson.components && openApiJson.components.securitySchemes) {
     const authKey = Object.keys(openApiJson.components.securitySchemes)?.at(0)
@@ -17,6 +22,7 @@ export const transformOpenApiObject = (openApiJson: OpenAPIFile): TransformedOpe
           scheme: 'public',
         },
       },
+      ...(openApiJson.components || {}),
     }
   }
 
@@ -26,7 +32,7 @@ export const transformOpenApiObject = (openApiJson: OpenAPIFile): TransformedOpe
 
   return {
     ...openApiJson,
-    paths: transformPathsToArray(openApiJson.paths),
+    paths: transformPathsToArray(openApiJson),
   } as TransformedOpenApi
 }
 
@@ -50,7 +56,8 @@ export const transformOpenApiObjectToOrigin = (values: TransformedOpenApi): Open
   return object
 }
 
-export const transformPathsToArray = (paths: OpenAPIFile['paths']): TransformedPathsArray | any => {
+export const transformPathsToArray = (openApiJson: OpenAPIFile): TransformedPathsArray | any => {
+  const paths: OpenAPIFile['paths'] = openApiJson.paths
   const transformedPaths = Object.entries(paths).map(([path, methods]) => ({
     path,
     methods: Object.entries(methods).map(([method, methodProps]) => {
@@ -61,20 +68,55 @@ export const transformPathsToArray = (paths: OpenAPIFile['paths']): TransformedP
         summary: methodProps.summary || '',
         responses: Object.entries(methodProps.responses).map(([code, codeProps]) => {
           const contentType = Object.keys(codeProps.content || {})[0]
-          const headers = !codeProps?.headers ? {} : codeProps.headers
+          let headers = codeProps?.headers ?? {}
+
+          // ? Fix headers with items property
+          Object.keys(headers).map((header: string) => {
+            let headerObj = headers[header]
+            if (
+              headerObj?.schema &&
+              headerObj?.schema?.type &&
+              headerObj?.schema?.type != 'array'
+            ) {
+              delete headers[header]?.schema?.items
+            }
+          })
+
+          let schema = codeProps.content?.[contentType]?.schema
+          if (schema?.$ref) {
+            schema = resolveRef(schema?.$ref, openApiJson)
+          } else if (schema?.type == 'array' && schema?.items?.$ref) {
+            const resolvedItemSchema = resolveRef(schema.items.$ref, openApiJson)
+            schema = {
+              ...schema,
+              items: resolvedItemSchema,
+            }
+          }
+
           return {
             code,
             headers,
             content: {
               contentType,
               schema: {
-                ...codeProps.content?.[contentType]?.schema,
-                properties: JSON.stringify(codeProps.content?.[contentType]?.schema?.properties),
+                ...schema,
+                properties: JSON.stringify(schema?.properties || schema?.items?.properties),
               },
             },
           }
         }),
       }
+
+      if (!obj.responses.find((item) => item.code == '200')) {
+        obj.responses.push({
+          code: '200',
+          content: {
+            contentType: 'application/json',
+            schema: {},
+          },
+          headers: {},
+        })
+      }
       // Add parameters if it does not exist in the original JSON
       if (!methodProps?.parameters) {
         obj.parameters = []
@@ -84,14 +126,24 @@ export const transformPathsToArray = (paths: OpenAPIFile['paths']): TransformedP
 
       if (method.toLowerCase() != 'get') {
         const contentType = Object.keys(methodProps?.requestBody?.content || {})[0]
-        const reqSchema = methodProps?.requestBody?.content?.schema
-        const requestBodyData = methodProps?.requestBody?.content?.schema?.properties
+        let reqSchema = methodProps?.requestBody?.content?.[contentType]?.schema
+
+        if (reqSchema?.$ref) {
+          reqSchema = resolveRef(reqSchema.$ref, openApiJson)
+        } else if (reqSchema?.type === 'array' && reqSchema.items?.$ref) {
+          reqSchema = {
+            ...reqSchema,
+            items: resolveRef(reqSchema.items.$ref, openApiJson),
+          }
+        }
+
+        const requestBodyData = reqSchema
           ? {
               content: {
                 contentType,
                 schema: {
                   ...reqSchema,
-                  properties: reqSchema?.properties ? JSON.stringify(reqSchema?.properties) : '{}',
+                  properties: JSON.stringify(reqSchema?.properties || reqSchema?.items?.properties),
                 },
               },
             }
@@ -128,8 +180,18 @@ export const transformPathsArrayToOrigin = (paths: TransformedPathsArray): OpenA
     acc[path] = methods.reduce(
       (methodAcc, { type, tags, responses, summary, requestBody, ...rest }) => {
         // Initialize the method object
+        // ? Validate (rest) [parameters]
+        let copiedRest = structuredClone(rest || {})
+        if (copiedRest && copiedRest.parameters) {
+          copiedRest.parameters.map((param) => {
+            if (param && param?.schema?.items && param?.schema?.items?.type == 'array') {
+              param.schema.items.items = {}
+            }
+            return param
+          })
+        }
         methodAcc[type] = {
-          ...rest,
+          ...copiedRest,
           tags,
           summary,
           responses: responses.reduce((respAcc, { code, content, headers }) => {

package/src/layout/docsComponents/DocsHeader/DocsHeader.module.scss

@@ -27,12 +27,18 @@
     font-size: 1rem;
     line-height: 1.25rem;
 
+    .btnContentWrapper {
+      .btnContent{
+        font-size: 0.918rem !important;
+      }
+    }
+
     &:hover:not(:disabled) {
       color: #000000 !important;
     }
 
     &:hover {
-      color: #000;
+      color: #000 !important;
     }
 
     svg {
@@ -74,6 +80,12 @@
     line-height: 1.234rem;
     height: 2.25rem;
 
+    .btnContentWrapper {
+      .btnContent{
+        font-size: 0.918rem !important;
+      }
+    }
+
     &:hover:not(:disabled) {
       color: #000000 !important;
     }

package/src/layout/layout.tsx

@@ -49,6 +49,7 @@ const Layout = ({
   })
   const { dirty, isValid, isSubmitting, values, setFieldValue, handleSubmit, errors } = formik
   const [isPublishDialogOpen, setIsPublishDialogOpen] = useState(false)
+
   const [openMethodIndex, setOpenMethodIndex] = useState<number | null>(null)
 
   useEffect(() => {
@@ -57,11 +58,6 @@ const Layout = ({
     }
   }, [dirty])
 
-  // TODO: keep it here until production
-  useEffect(() => {
-    console.log({ values, errors })
-  }, [values])
-
   return (
     <div className={styles.docsLayout}>
       {dirty && (
@@ -111,8 +107,8 @@ const Layout = ({
                         const h = `paths[${pathIndex}].methods[${methodIndex}].${key}`
                         setFieldValue(h, value)
                       }}
-                      isOpen={openMethodIndex === methodIndex}
-                      setIsOpen={(open) => setOpenMethodIndex(open ? methodIndex : null)}
+                      isOpen={openMethodIndex === parseInt(`${pathIndex}${methodIndex}`)}
+                      setIsOpen={(open) => setOpenMethodIndex(open ? parseInt(`${pathIndex}${methodIndex}`) : null)}
                       errors={(formik.errors.paths?.[pathIndex] as any)?.methods?.[methodIndex]}
                     />
                   ))}

package/variables.txt

@@ -1 +1 @@
-export APP_VERSION=1.0.83
+export APP_VERSION=1.0.85