@digi-frontend/dgate-api-documentation 1.0.52 → 1.0.53

package/package.json

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

package/src/components/MethodAccordion/MethodAccordion.tsx

@@ -100,7 +100,13 @@ const MethodsAccordion = ({
         id: `header_${index}`,
         paramName: item,
         paramType: capitalize('header'),
-        schemaType: capitalize(data?.schema?.type) || '',
+        schemaType: `${capitalize(data?.schema?.type) || ''} ${
+          data?.schema?.type?.toLowerCase() == 'array' &&
+          data?.schema?.items &&
+          data?.schema?.items?.type
+            ? ` _ ${capitalize(data?.schema?.items?.type)}`
+            : ''
+        }`,
         required: (
           <>
             {readOnly ? (
@@ -177,7 +183,6 @@ const MethodsAccordion = ({
                       maxLength={120}
                       onChange={(value) => {
                         if (value === '' || regex.ASCII.test(value)) {
-                          // onResponseTableChange('description', value, item, indexRef.current)
                           setFieldValue(
                             `responses[${indexRef.current}].headers[${item}].description`,
                             value
@@ -362,15 +367,18 @@ const MethodsAccordion = ({
   }
 
   const generateTableData = (items, isForRequest?: boolean) => {
-    const data = isForRequest
-      ? items.filter((item) => item.in && item.in.toLowerCase() != 'header')
-      : items.filter((item) => item.in && item.in.toLowerCase() == 'header')
-    return data.map((item, index) => {
+    return items?.map((item, index) => {
       return {
         id: index,
         paramName: item.name,
         paramType: capitalize(item.in),
-        schemaType: capitalize(item.schema?.type) || '',
+        schemaType: `${capitalize(item?.schema?.type) || ''} ${
+          item?.schema?.type?.toLowerCase() == 'array' &&
+          item?.schema?.items &&
+          item?.schema?.items?.type
+            ? ` _ ${capitalize(item?.schema?.items?.type)}`
+            : ''
+        }`,
         required: (
           <>
             {readOnly ? (
@@ -652,7 +660,6 @@ const MethodsAccordion = ({
   }
 
   const saveNewResponseRow = (value) => {
-    // setTableResponseData([...tableResponseData, values])
     setFieldValue(`responses[${indexRef.current}].headers[${value.name}]`, value)
   }
 

package/src/components/table/style.scss

@@ -15,6 +15,12 @@ div.endBtnIcon {
   width: 16.875rem !important;
 }
 
+.select-inputs {
+  display: flex;
+  flex-direction: row;
+  gap: .625rem;
+}
+
 .addEnumButton {
   color: #4d75d8 !important;
   display: flex;

package/src/components/table/table.tsx

@@ -186,7 +186,10 @@ const ParamterTable = ({
                 </td>
 
                 <td key={'parameter schema type'}>
-                  <div data-id="TEXT_DESCRIPTION" className="tableData">
+                  <div
+                    data-id="TEXT_DESCRIPTION"
+                    className="tableData select-inputs"
+                  >
                     <SelectGroupV2
                       disabled={readOnly}
                       clearable={false}
@@ -211,41 +214,36 @@ const ParamterTable = ({
                       isMultiple={false}
                       withSearch={false}
                     />{' '}
-                  </div>
-                </td>
-
-                <td key={'parameter array schema type'}>
-                  <div data-id="TEXT_DESCRIPTION" className="tableData">
-                    {values.schema && values.schema?.type?.toLowerCase() == 'array' ? (
-                      <SelectGroupV2
-                        disabled={readOnly}
-                        clearable={false}
-                        value={{
-                          label: capitalize(values?.schema?.items?.type),
-                          value: values.schema?.items?.type,
-                        }}
-                        errorMsg={!!errors?.schema?.items?.type && errors?.schema?.items?.type}
-                        onChange={(item) =>
-                          setFieldValue('schema.items.type', item?.value?.toLowerCase())
-                        } // Updates state on selection
-                        options={[
-                          {
-                            list: [
-                              { label: 'String', value: 'string' },
-                              { label: 'Integer', value: 'integer' },
-                              { label: 'Boolean', value: 'boolean' },
-                              { label: 'Object', value: 'object' },
-                              { label: 'Array', value: 'array' },
-                              { label: 'Number', value: 'number' },
-                            ],
-                          },
-                        ]}
-                        isMultiple={false}
-                        withSearch={false}
-                      />
+                    {!!values?.schema?.type && values?.schema?.type.toLowerCase() === 'array' ? (
+                        <SelectGroupV2
+                          disabled={readOnly}
+                          clearable={false}
+                          value={{
+                            label: capitalize(values?.schema?.items?.type),
+                            value: values.schema?.items?.type,
+                          }}
+                          errorMsg={!!errors?.schema?.items?.type && errors?.schema?.items?.type}
+                          onChange={(item) =>
+                            setFieldValue('schema.items.type', item?.value?.toLowerCase())
+                          } // Updates state on selection
+                          options={[
+                            {
+                              list: [
+                                { label: 'String', value: 'string' },
+                                { label: 'Integer', value: 'integer' },
+                                { label: 'Boolean', value: 'boolean' },
+                                { label: 'Object', value: 'object' },
+                                { label: 'Array', value: 'array' },
+                                { label: 'Number', value: 'number' },
+                              ],
+                            },
+                          ]}
+                          isMultiple={false}
+                          withSearch={false}
+                        />
                     ) : (
-                      '-'
-                    )}{' '}
+                      ''
+                    )}
                   </div>
                 </td>
 

package/src/constants/index.ts

@@ -70,7 +70,7 @@ export const paramsTableHeaders = [
   },
   { id: 'paramType', label: 'In', sortable: false, classes: 'requiredParam' },
   { id: 'schemaType', label: 'Schema-Type', sortable: false, classes: 'requiredParam' },
-  { id: 'arraySchemaType', label: 'Array Schema Type', sortable: false },
+  // { id: 'arraySchemaType', label: 'Array Schema Type', sortable: false },
   { id: 'enum', label: 'Enum', sortable: false },
   { id: 'required', label: 'Required', sortable: false, classes: 'requiredParam' },
   { id: 'description', label: 'Description', sortable: false },

package/src/helpers/layout.helper.ts

@@ -119,13 +119,7 @@ const validateBodyForResponse = (content, method) => {
     return {}
   }
   let _content = JSON.parse((content?.schema as any)?.properties as string)
-  // if (method == 'get') {
-  //   if (!_content?.body) {
-  //     _content = {
-  //       body: _content,
-  //     }
-  //   }
-  // }
+
   return _content
 }
 

package/src/layout/docsComponents/DocsContent/EndpointPage/index.tsx

@@ -177,7 +177,7 @@ export const EndpointPage = ({ data }) => {
               </tr>
             </thead>
             <tbody>
-              {Object.keys(headersList).map((key, index) => (
+              {!!headersList && Object.keys(headersList) && Object.keys(headersList).map((key, index) => (
                 <tr>
                   <td>{key}</td>
                   <td>{headersList[key]?.required.toString()}</td>

package/src/layout/docsLayout.tsx

@@ -45,7 +45,6 @@ const DocsLayout = ({ apis }: ILayoutProps): JSX.Element => {
   const [expandedSections, setExpandedSections] = useState({})
   const allData = useRef([]);
   const [pending, setPending] = useState(true)
-  console.log({ apis, transformedOpenApis, activeItemData })
   useEffect(() => {
     if (transformedOpenApis.length === 0) {
       const t = structuredClone(apis)

package/src/layout/layout.tsx

@@ -57,7 +57,7 @@ const Layout = ({
     }
   }, [dirty])
 
-  // keep it here until production
+  // TODO: keep it here until production
   useEffect(() => {
     console.log({ values, errors })
   }, [values])