feat: parse request body parameters recursively and add checkmark before added property

Author: jaychang99

src/utils/format-single-api-endpoint-as-markdown.ts

@@ -1,7 +1,10 @@
 import { CustomPathDiffItem } from './generate-markdown-diff'
 import { responseFormatter } from '@/utils/single-api-endpoint-formatter.ts/response-formatter'
 import { requestParametersFormatter } from '@/utils/single-api-endpoint-formatter.ts/request-parameters-formatter'
-import { requestBodyFormatter } from '@/utils/single-api-endpoint-formatter.ts/request-body-formatter'
+import {
+  CustomRequestBodyObject,
+  requestBodyFormatter
+} from '@/utils/single-api-endpoint-formatter.ts/request-body-formatter'
 
 type FormatSingleApiEndpointAsMarkdown = (
   endpoint: CustomPathDiffItem,
@@ -30,7 +33,8 @@ export const formatSingleApiEndpointAsMarkdown: FormatSingleApiEndpointAsMarkdow
       shouldCheckForChanges
     })
     const requestBodyMarkdown = requestBodyFormatter({
-      endpointDetailData
+      endpointDetailData,
+      baseRequestBody: baseApiEndpoint?.requestBody as CustomRequestBodyObject
     })
     const responseMarkdown = responseFormatter(
       responses,

src/utils/single-api-endpoint-formatter.ts/request-body-formatter.ts

@@ -1,9 +1,13 @@
+import { tableFromObject } from '@/formatters/table-from-object'
+import { FlattenedSchemaPropertyItem } from '@/types/flattened-schema-property-item'
+import { getflattenedSchema } from '@/utils/get-flattened-schema'
 import { SchemaObject } from '@/utils/json-to-markdown'
-import { jsonToMarkdownTable } from '@/utils/json-to-markdown-table'
+import { Markdown } from '@/utils/markdown/markdown'
 import { OpenAPIV3 } from 'openapi-types'
 
 export type RequestBodyFormatter = (args: {
   endpointDetailData: OpenAPIV3.OperationObject
+  baseRequestBody?: CustomRequestBodyObject
 }) => string
 interface CustomMediaTypeObject {
   schema?: SchemaObject
@@ -17,7 +21,7 @@ interface CustomMediaTypeObject {
   }
 }
 
-interface CustomRequestBodyObject {
+export interface CustomRequestBodyObject {
   description?: string
   content: {
     [media: string]: CustomMediaTypeObject
@@ -26,9 +30,30 @@ interface CustomRequestBodyObject {
 }
 
 export const requestBodyFormatter: RequestBodyFormatter = ({
-  endpointDetailData
+  endpointDetailData,
+  baseRequestBody // only used for modified endpoints
 }) => {
+  let flattenedRequestBody: FlattenedSchemaPropertyItem[] = []
+  let flattenedBaseRequestBody: FlattenedSchemaPropertyItem[] = []
+
+  if (baseRequestBody) {
+    const resolvedBaseRequestBody =
+      baseRequestBody as unknown as CustomRequestBodyObject
+
+    const baseRequestBodyContent =
+      resolvedBaseRequestBody?.content?.['application/json'] ??
+      resolvedBaseRequestBody?.content?.['text/plain']
+
+    const baseRequestBodyContentSchema =
+      baseRequestBodyContent?.schema as SchemaObject
+
+    flattenedBaseRequestBody = getflattenedSchema(baseRequestBodyContentSchema)
+  }
+
   const requestBody = endpointDetailData.requestBody as CustomRequestBodyObject // all refs have been resolved in main.ts
+  flattenedRequestBody = requestBody.content['application/json'].schema
+    ? getflattenedSchema(requestBody.content['application/json'].schema)
+    : []
   const doesHaveRequestBody = requestBody !== undefined
 
   if (!doesHaveRequestBody) {
@@ -43,10 +68,42 @@ export const requestBodyFormatter: RequestBodyFormatter = ({
 - Content Required: ${requestBody?.required ?? 'Not Provided'}
 `
 
+  const mdc = new Markdown()
+
+  const headers = ['Property', 'Type', 'Required', 'Description', 'Example']
+
+  // const rows = Object.entries(obj.schema.properties ?? {}).map(
+  //   ([propertyName, propertyMetadata]) => [
+  //     propertyName,
+  //     propertyMetadata.type,
+  //     obj.schema.required?.includes(propertyName) ? 'Yes' : 'No',
+  //     propertyMetadata.description ?? '',
+  //     propertyMetadata.example ?? ''
+  //   ]
+  // )
+  const baseFlattenedSchemaPropertyList = flattenedBaseRequestBody?.map(
+    row => row.property
+  )
+  const rowsFromNewBody = flattenedRequestBody.map(row => {
+    const hasBeenAdded = !baseFlattenedSchemaPropertyList.includes(row.property)
+
+    return {
+      property: `${hasBeenAdded ? '✅' : ''} ${row.property}`,
+      type: row.type,
+      required: row.required,
+      description: row.description,
+      example: row.example
+    }
+  })
+  const rows = [...rowsFromNewBody]
+  const dataIndex = headers.map(header => header.toLowerCase())
+
+  const tableMarkdown = tableFromObject({ headers, rows, dataIndex })
+
+  mdc.appendToNewLine(tableMarkdown)
+
   const requestBodyMarkdown = requestBody?.content?.['application/json']?.schema
-    ? jsonToMarkdownTable({
-        schema: requestBody?.content?.['application/json']?.schema
-      })
+    ? mdc.toString()
     : ''
 
   return requestBodyAdditionalInfo + requestBodyMarkdown