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

No documentation on how to enable interactivity with REST service for OpenAPI spec #2377

Closed
adriansuarez opened this issue Aug 5, 2023 · 2 comments · Fixed by #2460
Closed
Assignees

Comments

@adriansuarez
Copy link

Describe the bug

I spent some time creating a Helm chart for the Redoc that should allow to deploy it alongside the actual REST service that it is documenting and allow the user to interact with the actual REST API.

But there is no documentation on how to enable interactivity, and it does not seem to work by default, even though my spec contains the base URL that the server is reachable by. I am expecting Redoc to have the same functionality as Swagger UI, where I am able to interact with the REST service... Does this not work?

Expected behavior

I expect Redoc to allow me to issue requests to the REST service.
Otherwise, creating a web server for Redoc does not add any value beyond what I get from just generating the single page documentation using redocly CLI.

@adriansuarez
Copy link
Author

adriansuarez commented Aug 5, 2023

After searching through some older issues, it looks like the "Try It" thing is a paid feature. I'm not the first person to be confused about this, so it would be good to make the docs clearer.

I think it's a very misleading to have a README in GitHub with the title "Generate interactive API documentation from OpenAPI definitions", and you cannot actually access that functionality via any of the code made available.

@lornajane
Copy link
Contributor

Thanks for raising this. To be clear, you are correct and the "Try It" is only available on our hosted platform, not in the open source product. We're working on some changes and docs updates, getting feedback like this really helps!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants