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

chore: add open api spec into the docs #1061

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

commoddity
Copy link
Contributor

@commoddity commoddity commented Feb 7, 2025

Summary

Embed autogenerated Open API Spec into Docusaurus docs under Explore/Open API Spec.

Primary Changes:

  • Introduced OpenAPI component using swagger-ui-react.
  • Created a new markdown file api.md for OpenAPI documentation.
  • Installed swagger-ui and swagger-ui-react as dependencies.

Considerations:

  • The OpenAPI component fetches an OpenAPI specification from a remote URL.

@commoddity commoddity added the documentation Improvements or additions to documentation label Feb 7, 2025
@commoddity commoddity requested a review from Olshansk February 7, 2025 18:54
@commoddity commoddity self-assigned this Feb 7, 2025
@Olshansk Olshansk added this to the Quality of Life milestone Feb 13, 2025
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

Made a few improvements to the docs but should be g2g now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

2 participants