Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Precise wording for api example #7783

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

martmull
Copy link
Contributor

Enhance composite type filter example in open-api

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

This pull request enhances the clarity of API documentation for filtering on composite type fields in the OpenAPI specification.

  • Updated computeFilterParameters in packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts to replace 'nested objects' with 'composite type fields'
  • Modified example description in parameters.utils.spec.ts to reflect the change from 'nested' to 'composite type'
  • Improved consistency in terminology across both files for better user understanding
  • Enhanced example in parameters.utils.ts to demonstrate filtering on composite type fields more accurately

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@charlesBochet charlesBochet merged commit ddbfabf into main Oct 17, 2024
8 checks passed
@charlesBochet charlesBochet deleted the update-open-api-example branch October 17, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants