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.

Sign up for GitHub

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

Jump to bottom

[Feature] - Redefined standard fields & multiple_items_allowed property changes #6377

Merged
merged 29 commits into from
May 9, 2024
Merged

[Feature] - Redefined standard fields & multiple_items_allowed property changes #6377

merged 29 commits into from
May 9, 2024

Conversation

montezdesousa
Copy link
Contributor

@montezdesousa montezdesousa commented May 8, 2024 •
edited
Loading

Pull Request Template for OpenBB Developers

  1. Why?

    • Standard fields redefined in the provider model were ignored
    • No information about these fields in the website
    • Parameters with commas could not be blocked explicitly since multiple_items_allowed is a list item

  2. What?

    • Include redefined standard fields in the RegistryMap. This is done in _extract_info function by looking into __annotations__ to distinguish inherited from defined class attributes.
    • Change multiple_items_allowed to dictionary. {"multiple_items_allowed": False} will block items with commas

  3. Impact

    • Python package
    • reference.json
    • website
    • cli: will fix auto complete for redefined standard fields

  4. Testing Done:

    • Regenerate platform website documentation
    • Setting {"multiple_items_allowed": False} and checking if it blocks
Screenshot 2024-05-08 at 14 07 41 Screenshot 2024-05-08 at 14 09 45 Screenshot 2024-05-08 at 14 10 10

image

@montezdesousa montezdesousa added the v4 PRs for v4 label May 8, 2024
@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform labels May 8, 2024
@montezdesousa montezdesousa changed the title feat: add field annotation and replace multiple items by dict [Feature] - Redefined standard fields & multiple_items_allowed property changes May 8, 2024
@montezdesousa montezdesousa requested a review from hjoaquim May 8, 2024 13:32
@montezdesousa montezdesousa added the do not merge Label to prevent pull request merge label May 8, 2024
@montezdesousa montezdesousa removed the do not merge Label to prevent pull request merge label May 8, 2024
hjoaquim
hjoaquim approved these changes May 9, 2024
View reviewed changes
Copy link
Contributor

@hjoaquim hjoaquim left a comment

Choose a reason for hiding this comment

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

Delivers what's promised. I don't have any suggestion, looking good!

@montezdesousa montezdesousa added this pull request to the merge queue May 9, 2024
Merged via the queue into develop with commit 0b9b12d May 9, 2024
10 checks passed
@IgorWounds IgorWounds deleted the feature/field-json-extra branch May 10, 2024 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoaquim hjoaquim hjoaquim approved these changes

Assignees
No one assigned
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@montezdesousa @hjoaquim