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.

Sign up for GitHub

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

Jump to bottom

[Feature Request] Add OpenAPI spec and Redoc to doc site #15

Open
justinh-rahb opened this issue Nov 11, 2023 · 0 comments
Open

[Feature Request] Add OpenAPI spec and Redoc to doc site #15

justinh-rahb opened this issue Nov 11, 2023 · 0 comments
Assignees
@justinh-rahb
Labels
documentation Improvements or additions to documentation

Comments

@justinh-rahb
Copy link
Collaborator

Problem

Our current API documentation lacks interactive elements, making it less user-friendly and harder for developers to quickly understand.

Proposed Solution

Integrate an OpenAPI specification for our API and include a Redoc page on the documentation site. This will provide a standardized, interactive, and visually appealing way to understand the API.
@justinh-rahb justinh-rahb added the documentation Improvements or additions to documentation label Nov 11, 2023
@justinh-rahb justinh-rahb self-assigned this Nov 11, 2023
@justinh-rahb justinh-rahb changed the title Add OpenAPI spec and Redoc to doc site [Feature Request] Add OpenAPI spec and Redoc to doc site Nov 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@justinh-rahb justinh-rahb

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@justinh-rahb