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

[BugFix] FMP Screener - Convert sector param choices to lower_snake_case #6432

Merged
merged 8 commits into from
May 18, 2024

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented May 18, 2024

  1. Why?:

    • Valid sector choices to the FMP API include spaces, but in practice we don't want those as parameter choices in the Literals.
    • SEC Form Types also get same treatment.
  2. What?:

    • Defined the SECTORS Literal in lower_snake_case and then converted back before the URL generation.
    • Benzinga aliases as-per -> hotfix/Frontend sync #6327
  3. Impact:

    • This should reduce the chance of unexpected behaviour across all interfaces.
    • The sector parameter will now need to be entered as lower_snake_case, everything else remains the same.
  4. Testing Done:

    • Used the function and params. No change to the response.

@deeleeramone deeleeramone added bug Fix bug platform OpenBB Platform labels May 18, 2024
@github-actions github-actions bot added the v4 PRs for v4 label May 18, 2024
@IgorWounds IgorWounds added this pull request to the merge queue May 18, 2024
Merged via the queue into develop with commit b7b5e40 May 18, 2024
9 checks passed
@IgorWounds IgorWounds deleted the bugfix/literals-with-spaces branch May 20, 2024 12:49
@hjoaquim
Copy link
Contributor

is this a potential breaking change for Platform clients (like PRO)?
cc @andrewkenreich

@@ -163,8 +163,8 @@
"CORRESP",
"CT ORDER",
Copy link
Contributor

Choose a reason for hiding this comment

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

this one got unnoticed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fix bug platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants