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] Patch for refactored examples in platform markdown generator #6181

Merged
merged 2 commits into from
Mar 11, 2024

Conversation

the-praxs
Copy link
Contributor

[BugFix] Patch for refactored examples in platform markdown generator

  1. Why?

    To patch the breaking changes for the examples in the openbb core package

  2. What?

    • Added a new function get_endpoint_examples to get the examples as a formatted string
    • Removed the create_reference_markdown_examples function due to redundant use
    • Modified code to check for json_schema_extra in the field and extract multiple_items_allowed if present.
  3. Impact

    • Impact Score = 14 (Moderate)
    • Not backwards compatible due to breaking changes in the openbb core package
    • Added internal dependency might affect performance notably
  4. Testing Done

    Markdown files generated and tested locally on npm server

  5. Reviewer Notes

    Please carefully check the generated docs to ensure they are similar to the deployed ones.

@the-praxs the-praxs added v4 PRs for v4 platform OpenBB Platform labels Mar 11, 2024
@the-praxs the-praxs added this pull request to the merge queue Mar 11, 2024
@the-praxs the-praxs removed this pull request from the merge queue due to a manual request Mar 11, 2024
@the-praxs the-praxs added this pull request to the merge queue Mar 11, 2024
Merged via the queue into develop with commit 782f8d1 Mar 11, 2024
19 of 24 checks passed
@the-praxs the-praxs deleted the bugfix/generator-new-examples branch March 11, 2024 10:54
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.

2 participants