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

[Docs] - Excel examples from openapi.json #6318

Merged
merged 4 commits into from
Apr 19, 2024
Merged

Conversation

montezdesousa
Copy link
Contributor

@montezdesousa montezdesousa commented Apr 17, 2024

Draft: this can only be merged when openbb v.4.1.6 is deployed to prod and Excel in sync

  1. Why?

    • Examples were generated from generate_excel_markdown.py code
    • They were not tested
    • Few examples
  2. What?

    • Refactor code to create examples from openapi.json
    • Move website related paths to website/.gitignore
  3. Impact (1-2 sentences or a bullet point list):

    • Examples generated from openapi.json => multiple tested examples
    • Any updates on the platform will be reflected here without any change
  4. Testing Done:

    • python generate_excel_markdown.py and npm run dev, check examples and new endpoints are there

image

@github-actions github-actions bot added the docs Code documentation label Apr 17, 2024
@montezdesousa montezdesousa changed the title Docs/update xl examples [Docs] - Excel examples from openapi.json Apr 17, 2024
@montezdesousa montezdesousa marked this pull request as draft April 17, 2024 10:28
@github-actions github-actions bot added the excel label Apr 19, 2024
@montezdesousa montezdesousa marked this pull request as ready for review April 19, 2024 17:14
@montezdesousa montezdesousa merged commit f43c0bc into main Apr 19, 2024
13 of 14 checks passed
@IgorWounds IgorWounds deleted the docs/update_xl_examples branch April 22, 2024 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code documentation excel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants