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

Response example generation for XML and CSV #2347

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

Conversation

rishitank
Copy link

What/Why/How?

As part of implementing api-docs at Adthena, we had the need to auto-generate response examples for XML and CSV based on the OpenAPI schema provided.

  • This PR implements XML and CSV response example generation for Redoc if a response example is not provided.
  • The code for XML generation was adapted from RapiDoc's implementation and ported over to TypeScript.
  • The feature can be enabled via a redoc option.

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

@lornajane
Copy link
Contributor

Thank you! It's quite a big pull request, so we're going to need some time to prioritise and review this, but thank you so much for this :)

(if anyone else tries it from the branch, let us know how you get on?)

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.

None yet

2 participants