twentyhq/twenty
1
1
Fork 0
mirror of https://github.com/twentyhq/twenty.git synced 2024-09-11 23:37:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

Docs include field description (#3973)

Browse Source 
- include field description
This commit is contained in:
brendanlaschke 2024-02-16 14:38:39 +01:00 committed by GitHub
parent b90b3e762e
commit 547145389c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packages/twenty-server/src/core/open-api/utils/components.utils.ts
View File

@ -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;