@digi-frontend/dgate-api-documentation 1.0.33 → 1.0.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digi-frontend/dgate-api-documentation",
-  "version": "1.0.33",
+  "version": "1.0.35",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "types": "dist/types/index.d.ts",

package/src/components/LivePreview/LivePreview.tsx

@@ -69,9 +69,12 @@ const LivePreview: React.FC<LivePreviewProps> = ({ transformedData }) => {
               rel="noopener noreferrer"
               target="_blank"
             >
+              {item?.externalDocs?.url && !item?.externalDocs?.description
+                ? item?.externalDocs?.url
+                : null}
               {item?.externalDocs?.description
                 ? item?.externalDocs?.description?.substring(0, 12)
-                : '-'}
+                : !item?.externalDocs?.url ? '-': null}
               {item?.externalDocs?.description && item?.externalDocs?.description?.length > 12
                 ? '...'
                 : ''}
@@ -104,6 +107,10 @@ const LivePreview: React.FC<LivePreviewProps> = ({ transformedData }) => {
     }))
   }
 
+  const securityScheme = !!securityKey
+    ? securitySchemes[securityKey].scheme || securitySchemes[securityKey].type
+    : '-'
+
   return (
     <div className={styles.livePreviewContainer}>
       <div className="row">
@@ -116,9 +123,9 @@ const LivePreview: React.FC<LivePreviewProps> = ({ transformedData }) => {
             key={'APIAuthenticationType'}
             label={'API authentication type: '}
             value={
-              !!securityKey
-                ? securitySchemes[securityKey].scheme || securitySchemes[securityKey].type
-                : '-'
+              !!securityScheme && securityScheme.toLowerCase() === 'public'
+                ? 'Keyless'
+                : securityScheme
             }
           />
           <SimpleLabelValue key={'version'} label={'Version: '} value={info?.version || '-'} />

package/src/components/MethodAccordion/MethodAccordion.tsx

@@ -443,7 +443,6 @@ const MethodsAccordion = ({
                     const currentResIndex = method.responses.findIndex(
                       (res) => res.code === currentResponse.code
                     )
-
                     if (currentResIndex !== -1) {
                       setFieldValue(
                         `responses[${currentResIndex}].content.schema.properties`,
@@ -466,7 +465,7 @@ const MethodsAccordion = ({
                       setFieldValue('responses', clonedResponses)
                     }
                   }}
-                  onValidation={() => null}
+                  onValidation={(valid) => null}
                 />
               }
             />

package/src/helpers/layout.helper.ts

@@ -113,6 +113,18 @@ export const transformPathsToArray = (paths: OpenAPIFile['paths']): TransformedP
   return transformedPaths
 }
 
+const validateBodyForResponse = (content, method) => {
+  let _content = JSON.parse((content?.schema as any)?.properties as string)
+  if (method == 'get') {
+    if (!_content?.body) {
+      _content = {
+        body: _content,
+      }
+    }
+  }
+  return _content
+}
+
 export const transformPathsArrayToOrigin = (paths: TransformedPathsArray): OpenAPIFile['paths'] => {
   return paths.reduce((acc, { path, methods }) => {
     acc[path] = methods.reduce((methodAcc, { type, tags, responses, requestBody, ...rest }) => {
@@ -128,7 +140,7 @@ export const transformPathsArrayToOrigin = (paths: TransformedPathsArray): OpenA
                   [content.contentType]: {
                     schema: {
                       ...(content.schema as object),
-                      properties: JSON.parse((content?.schema as any)?.properties as string),
+                      properties: validateBodyForResponse(content, type),
                     },
                   },
                 }