Skip to content

Conversation

skwowet
Copy link
Member

@skwowet skwowet commented Dec 12, 2023

Changes proposed ✍️

What

🤖[deprecated] Generated by Copilot at 640400c

The pull request adds the ability to query the organization data from the OpenSearch index instead of the relational database, using the findByIdOpensearch method in the OrganizationService and OrganizationRepository classes. It also updates the Organization interface and the organizationFind API endpoint to support the new fields tags and ticker for the organization data.

🤖[deprecated] Generated by Copilot at 640400c

organizationFind
Queries OpenSearch index
Faster than database

Why

How

🤖[deprecated] Generated by Copilot at 640400c

  • Improve the performance and scalability of the organizationFind API endpoint by querying the organization data from the OpenSearch index instead of the relational database (link, link, link)
  • Add the tags and ticker fields to the Organization interface for the OpenSearch index, and index and search them by the OpenSearch engine (link)
  • Update the backend/src/api/organization/organizationFind.ts file to use the findByIdOpensearch method of the OrganizationService class (link)
  • Implement the findByIdOpensearch method in the OrganizationRepository class in the backend/src/database/repositories/organizationRepository.ts file, which performs a filtered query on the OpenSearch index using the opensearch client, translates the OpenSearch fields to the Crowd fields, and throws an Error404 if no organization is found (link)
  • Delegate the call to the findByIdOpensearch method of the OrganizationRepository class in the OrganizationService class in the backend/src/services/organizationService.ts file (link)
  • Add the tags and ticker fields to the Organization interface in the services/libs/opensearch/src/repo/organization.repo.ts file (link)

Checklist ✅

  • Label appropriately with Feature, Improvement, or Bug.
  • Add screenshots to the PR description for relevant FE changes
  • New backend functionality has been unit-tested.
  • API documentation has been updated (if necessary) (see docs on API documentation).
  • Quality standards are met.

@skwowet skwowet self-assigned this Dec 12, 2023
@skwowet skwowet added the Improvement Created by Linear-GitHub Sync label Dec 12, 2023
@skwowet skwowet requested a review from epipav December 12, 2023 13:16
@skwowet skwowet requested review from sausage-todd and removed request for epipav December 18, 2023 12:25
@skwowet skwowet merged commit e113d7e into main Dec 18, 2023
@skwowet skwowet deleted the improvement/C-2792 branch December 18, 2023 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Created by Linear-GitHub Sync
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants