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

Create PoC for generating model docs from open API JSON #342

Merged
merged 5 commits into from
May 13, 2024

Conversation

szuperaz
Copy link
Contributor

@szuperaz szuperaz commented Dec 12, 2023

What's in this PR?

A small PoC to generate model documentation by parsing Open API spec.

Implementation details

  • The video open API file is converted from YAML to JSON
  • A React component parses a given model definition from API JSON and displays the model as an HTML table
  • Model parsing is recursive (for example, if GetOrCreateCallRequest contains a property with CallRequest type, CallRequest is also parsed and displayed)

TODO

  • Automatically update API spec when a new version is available in protocol main -> will be implemented in a follow-up PR

@szuperaz szuperaz force-pushed the open-api-spec-to-docs branch 3 times, most recently from bfe27d1 to 47e2eb0 Compare December 13, 2023 10:19
@szuperaz szuperaz marked this pull request as ready for review December 15, 2023 12:45
@szuperaz szuperaz merged commit ab405cd into main May 13, 2024
3 checks passed
@szuperaz szuperaz deleted the open-api-spec-to-docs branch May 13, 2024 10:12
@github-actions github-actions bot mentioned this pull request May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants