Docs include field description (#3973)

- include field description
twentyhq · Feb 16, 2024 · 5471453 · 5471453
1 parent b90b3e7
commit 5471453
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/twenty-server/src/core/open-api/utils/components.utils.ts b/packages/twenty-server/src/core/open-api/utils/components.utils.ts
@@ -73,6 +73,10 @@ const getSchemaComponentsProperties = (
         break;
     }
 
+    if (field.description) {
+      itemProperty.description = field.description;
+    }
+
     if (Object.keys(itemProperty).length) {
       node[field.name] = itemProperty;
     }
@@ -98,6 +102,7 @@ const computeSchemaComponent = (
 ): OpenAPIV3.SchemaObject => {
   const result = {
     type: 'object',
+    description: item.description,
     properties: getSchemaComponentsProperties(item),
     example: {},
   } as OpenAPIV3.SchemaObject;