Precise wording for api example (#7783)

Enhance composite type filter example in open-api
twentyhq · Oct 17, 2024 · ddbfabf · ddbfabf
1 parent f26c65f
commit ddbfabf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/...s/twenty-server/src/engine/core-modules/open-api/utils/__tests__/parameters.utils.spec.ts b/...s/twenty-server/src/engine/core-modules/open-api/utils/__tests__/parameters.utils.spec.ts
@@ -84,7 +84,7 @@ describe('computeParameters', () => {
         in: 'query',
         description: `Filters objects returned.  
     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(
       '**, **',
@@ -106,7 +106,7 @@ describe('computeParameters', () => {
           },
           simpleNested: {
             value: 'emails.primaryEmail[eq]:[email protected]',
-            description: 'A simple nested filter param',
+            description: 'A simple composite type filter param',
           },
           complex: {
             value:

diff --git a/packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts b/packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts
@@ -74,7 +74,7 @@ export const computeFilterParameters = (): OpenAPIV3_1.ParameterObject => {
     in: 'query',
     description: `Filters objects returned.  
     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(
       '**, **',
@@ -97,7 +97,7 @@ export const computeFilterParameters = (): OpenAPIV3_1.ParameterObject => {
       },
       simpleNested: {
         value: 'emails.primaryEmail[eq]:[email protected]',
-        description: 'A simple nested filter param',
+        description: 'A simple composite type filter param',
       },
       complex: {
         value: