admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Precise wording for api example (#7783)

Browse Source 
Enhance composite type filter example in open-api
This commit is contained in:
martmull
2024-10-17 14:41:38 +02:00
committed by GitHub
parent f26c65fd41
commit ddbfabfc99
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/twenty-server/src/engine/core-modules/open-api/utils/__tests__/parameters.utils.spec.ts
View File

@ -84,7 +84,7 @@ describe('computeParameters', () => {
in: 'query', in: 'query',
description: `Filters objects returned. description: `Filters objects returned.
Should have the following shape: **field_1[COMPARATOR]:value_1,field_2[COMPARATOR]:value_2... Should have the following shape: **field_1[COMPARATOR]:value_1,field_2[COMPARATOR]:value_2...
To filter on nested objects use **field.nestedField[COMPARATOR]:value_1 To filter on composite type fields use **field.subField[COMPARATOR]:value_1
** **
Available comparators are **${Object.values(FilterComparators).join( Available comparators are **${Object.values(FilterComparators).join(
'**, **', '**, **',
@ -106,7 +106,7 @@ describe('computeParameters', () => {
}, },
simpleNested: { simpleNested: {
value: 'emails.primaryEmail[eq]:foo99@example.com', value: 'emails.primaryEmail[eq]:foo99@example.com',
description: 'A simple nested filter param', description: 'A simple composite type filter param',
}, },
complex: { complex: {
value: value:

4
packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts
View File

@ -74,7 +74,7 @@ export const computeFilterParameters = (): OpenAPIV3_1.ParameterObject => {
in: 'query', in: 'query',
description: `Filters objects returned. description: `Filters objects returned.
Should have the following shape: **field_1[COMPARATOR]:value_1,field_2[COMPARATOR]:value_2... Should have the following shape: **field_1[COMPARATOR]:value_1,field_2[COMPARATOR]:value_2...
To filter on nested objects use **field.nestedField[COMPARATOR]:value_1 To filter on composite type fields use **field.subField[COMPARATOR]:value_1
** **
Available comparators are **${Object.values(FilterComparators).join( Available comparators are **${Object.values(FilterComparators).join(
'**, **', '**, **',
@ -97,7 +97,7 @@ export const computeFilterParameters = (): OpenAPIV3_1.ParameterObject => {
}, },
simpleNested: { simpleNested: {
value: 'emails.primaryEmail[eq]:foo99@example.com', value: 'emails.primaryEmail[eq]:foo99@example.com',
description: 'A simple nested filter param', description: 'A simple composite type filter param',
}, },
complex: { complex: {
value: value: