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

feat(fields): add params to FieldModel for Facet Generator #687

Merged
merged 2 commits into from
Jun 15, 2023

Conversation

aboissinot-coveo
Copy link
Contributor

@aboissinot-coveo aboissinot-coveo commented Jun 15, 2023

SEARCHAPI-8362

Adding two new attributes to FieldModel for the Facet Generator feature:

  • automaticFacetsCandidate: Whether this field is to be considered by the facet generator feature.
  • label: A displayable label for the field when used by the facet generator.

See those attributes in Swagger.

For more context on the feature, refer to the Figma components.

Acceptance Criteria

  • My changes are publicly available, documented, and deployed in production. (i.e. on Swagger)
    • Yes. See the endpoint in Swagger.
  • JSDoc annotates each property added in the exported interfaces
  • The proposed changes are covered by unit tests
    • Not applicable
  • Commits containing breaking changes a properly identified as such
    • Not applicable
  • README.md is adjusted to reflect the proposed changes (if relevant)
    • Not applicable
  • My merge commit message will be conventional (See Conventional Commit)

@github-actions
Copy link

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Manifest Files

@aboissinot-coveo aboissinot-coveo marked this pull request as ready for review June 15, 2023 12:51
@aboissinot-coveo aboissinot-coveo requested a review from a team June 15, 2023 12:51
@aboissinot-coveo aboissinot-coveo requested a review from a team as a code owner June 15, 2023 12:51
Copy link
Contributor

@FelixBlaisThon FelixBlaisThon left a comment

Choose a reason for hiding this comment

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

:GG: on adding the JSDoc

@FelixBlaisThon FelixBlaisThon merged commit 53d455d into master Jun 15, 2023
@FelixBlaisThon FelixBlaisThon deleted the SEARCHAPI-8362/facet-generator-fields branch June 15, 2023 14:31
@github-actions
Copy link

🎉 This PR is included in version 44.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants