Skip to content

Conversation

@sethstoudenmier
Copy link
Contributor

@sethstoudenmier sethstoudenmier commented Jul 15, 2025

Description:

Add the recipient_id field to /api/v2/search/spending_by_transaction to support linking to the Recipient Profile page. Additionally, this limits what a user is allowed to provide for the fields and sort of the request body to only those supported values in order to create a better UX.

Technical Details:

Along with adding the recipient_id this PR breaks out and renames the endpoints defined in the search_elasticsearch.py file since that name is out of date with how much we now use Elasticsearch.

Additionally, the change to limit user input for fields and sort implemented a new pattern using Enums. This pattern isn't something we have to adapt, but I felt it fit better than the current dictionary / lookup approach and only impacts this single endpoint currently.

Requirements for PR Merge:

  1. Unit & integration tests updated
  2. API documentation updated (examples listed below)
    1. API Contracts
    2. API UI
    3. Comments
  3. Data validation completed (examples listed below)
    1. Does this work well with the current frontend? Or is the frontend aware of a needed change?
    2. Is performance impacted in the changes (e.g., API, pipeline, downloads, etc.)?
    3. Is the expected data returned with the expected format?
  4. N/A Appropriate Operations ticket(s) created
  5. Jira Ticket(s)
    1. DEV-12873

Explain N/A in above checklist:

Copy link
Contributor Author

@sethstoudenmier sethstoudenmier left a comment

Choose a reason for hiding this comment

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

Added some points of clarification around files that were renamed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is a direct copy/paste from the search_elasticsearch.py and focuses on only a single endpoint.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is a direct copy/paste from the search_elasticsearch.py and focuses on only a single endpoint.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the file that corresponds to the endpoint that was changed

@sethstoudenmier sethstoudenmier merged commit d9de8d9 into qat Jul 18, 2025
14 checks passed
@sethstoudenmier sethstoudenmier deleted the mod/dev-12873-add-recipient-id branch July 18, 2025 19:38
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.

3 participants