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

Add Swagger API page #54

Open
akshay196 opened this issue Oct 7, 2022 · 2 comments · May be fixed by #105
Open

Add Swagger API page #54

akshay196 opened this issue Oct 7, 2022 · 2 comments · May be fixed by #105
Assignees
@rustiever
Labels
enhancement New feature or request triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@akshay196
Copy link
Member

Swagger is great way to document, test and consume RESTful Paralus APIs. Let's add the swagger UI page to paralus.io site.

Generated OpenAPI specification available here: https://github.com/paralus/paralus/tree/main/gen/openapi
@akshay196 akshay196 added enhancement New feature or request needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 23, 2023
@akshay196
Copy link
Member Author

An example: https://www.ory.sh/docs/reference/api

@akshay196 akshay196 mentioned this issue Mar 24, 2023
Open
@akshay196 akshay196 added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Nov 9, 2023
@nirav-rafay
Copy link
Contributor

Few frameworks / examples that work well with docusaurus and openapi specs

GHRepo: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
Demo Site: https://docusaurus-openapi.tryingpan.dev/

@nirav-rafay nirav-rafay added this to the v0.2.7 milestone Jan 19, 2024
@rustiever rustiever linked a pull request Jan 22, 2024 that will close this issue
Open
This was referenced Feb 28, 2024
Closed
Closed
@niravparikh05 niravparikh05 removed this from the v0.2.7 milestone Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rustiever rustiever

Labels
enhancement New feature or request triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Openapi spec page paralus/website
4 participants
@akshay196 @niravparikh05 @rustiever @nirav-rafay