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

[Enhancement] Improve FRED Search #6785

Merged
merged 10 commits into from
Oct 17, 2024
Merged

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented Oct 16, 2024

  1. Why?:

    • The full-text search returns too many results and we can make it a little more targeted.
  2. What?:

    • Implements a post-request regex in transform_data that filters rows for the query term(s).
    • Adds the order_by enums with asc desc for the sort order.
    • Reconfigures is_release to be search_type with choices: ["full_text", "series_id", "release"]
    • Adds query validators to help prevent bad input and communicate the error.
    • Applies "limit" post-request as opposed to part of the request.
      • Allows for the post-request filtering to narrow the field.
  3. Impact:

    • Does not impact any Pro implementations.
    • is_release is now a choice ("release") in search_type.
    • Enhanced search function with higher quality results.
    • Improved error handling and validation.
    • Default state is:
      • No user input: Returns the list of all Releases ~ 400 results.
      • No parameters other than "query": Full text search, in descending order by "observation_end".
      • No parameters other than "release_id": Returns the list of all series within that specific release.
      • "release_id" & "query": Applies the regex post-request filter.
      • No parameters other than "series_id" (needs to have geo data associated with it - "NYICLAIMS"): Returns the series group metadata.
    • No parameters other than "query" and "search_type" set to "series_id":
      • Filters for series IDs specifically
  4. Testing Done:

    • Updates integration and unit tests.
    • Various combinations of all the params.

@deeleeramone deeleeramone added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 labels Oct 16, 2024
@IgorWounds IgorWounds added this pull request to the merge queue Oct 17, 2024
Merged via the queue into develop with commit ad634e2 Oct 17, 2024
14 checks passed
@deeleeramone deeleeramone deleted the feature/improve-fred-search branch October 18, 2024 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking_change enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants