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: add search analysis module #680

Merged
merged 4 commits into from
Jun 12, 2023
Merged

feat: add search analysis module #680

merged 4 commits into from
Jun 12, 2023

Conversation

olamothe
Copy link
Member

@olamothe olamothe commented Jun 6, 2023

KIT-2526

Support for SearchAnalysis endpoints. This is used in the admin currently by the Relevance inspector panel.

While the feature was being developed, and the API being not yet official/documented, we used a pattern to have a temporary platform client in the admin repo: https://github.com/coveo/admin-ui/blob/master/pages/relevance-inspector/src/temporary/TemporaryPlatformClient.ts and https://github.com/coveo/admin-ui/blob/master/pages/relevance-inspector/src/temporary/SearchAnalysisInterface.ts

Since the API is now official, we can remove that temporary code from the admin. First step is to integrate it officially with the platform-client

Acceptance Criteria

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

@olamothe olamothe requested a review from a team June 6, 2023 14:36
@olamothe olamothe requested a review from a team as a code owner June 6, 2023 14:36
@github-actions
Copy link

github-actions bot commented Jun 6, 2023

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Manifest Files

Copy link
Contributor

@y-lakhdar y-lakhdar left a comment

Choose a reason for hiding this comment

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

👍

src/resources/SearchAnalysis/SearchAnalysis.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@louis-bompart louis-bompart left a comment

Choose a reason for hiding this comment

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

Let's avoid dayjs I think, the cost is higher than the benefits IMO.

src/resources/SearchAnalysis/SearchAnalysis.ts Outdated Show resolved Hide resolved
@olamothe olamothe requested a review from louis-bompart June 12, 2023 17:28
@olamothe olamothe enabled auto-merge (squash) June 12, 2023 17:47
@olamothe olamothe merged commit 8b3e74a into master Jun 12, 2023
@olamothe olamothe deleted the KIT-2526 branch June 12, 2023 17:49
@github-actions
Copy link

🎉 This PR is included in version 44.6.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.

6 participants