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

[Feature] Custom choices #6169

Merged
merged 10 commits into from
Mar 7, 2024
Merged

[Feature] Custom choices #6169

merged 10 commits into from
Mar 7, 2024

Conversation

hjoaquim
Copy link
Contributor

@hjoaquim hjoaquim commented Mar 6, 2024

  1. Why?:

    • Platform clients need more info on the available choices for certain parameters, which can't use Literal directly.
  2. What?:

    • Adds a way of custom adding choices to the arguments so that Platform clients can leverage this info.
      1. Adds OpenBBCustomChoices which is then used on the statics assets to store the choice information.
      2. By leveraging json_schema_extra this info automatically is set up on the openapi.json.
  3. Impact (1-2 sentences or a bullet point list):

    • Minor change in the UX, only perceivable when navigating to the command implementation (python) or the openapi.json.
    • Also might introduce some maintenance impact as adds a "new" way of adding choices.
    • Impact score: 5
User Experience (UX) Impact: 1 Performance Impact: 0 Compatibility Impact: 1 Security Impact: 0 Scalability Impact: 1 Maintenance Impact: 2 Compliance Impact: 0 Dependency Impact: 0
  1. Testing Done:

    • Running the PackageBuilder
    • Running the Rest API and navigating to /openapi.json

@hjoaquim hjoaquim added platform OpenBB Platform v4 PRs for v4 labels Mar 6, 2024
@hjoaquim hjoaquim requested a review from montezdesousa March 6, 2024 09:23
@github-actions github-actions bot added the enhancement Enhancement label Mar 6, 2024
@hjoaquim hjoaquim changed the title Feature/custom choices [Feature] Custom choices Mar 6, 2024
@hjoaquim hjoaquim added this pull request to the merge queue Mar 6, 2024
@hjoaquim hjoaquim removed this pull request from the merge queue due to a manual request Mar 6, 2024
@hjoaquim hjoaquim enabled auto-merge March 7, 2024 07:25
@hjoaquim hjoaquim added this pull request to the merge queue Mar 7, 2024
Merged via the queue into develop with commit 48c508b Mar 7, 2024
14 checks passed
@hjoaquim hjoaquim deleted the feature/custom-choices branch March 7, 2024 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants