Docs include field description (#3973)

- include field description
2024-02-16 14:38:39 +01:00
parent b90b3e762e
commit 547145389c
1 changed files with 5 additions and 0 deletions
--- 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;