redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Response example generation for XML and CSV

Open rishitank opened this issue 2 years ago • 4 comments

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

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

rishitank avatar Jun 29 '23 08:06 rishitank

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?)

lornajane avatar Jun 29 '23 12:06 lornajane

@lornajane Hello! Could you please provide an update on this PR? I'm experiencing the same issue it solves. Thank you!

LeWolOnline avatar Jun 05 '24 15:06 LeWolOnline

Oh, I'm experiencing the same issue. @lornajane, any updates?

LittleGM avatar Jun 07 '24 08:06 LittleGM

Hi @lornajane, is there any update on this? I can see that there are conflicts on this PR now, I wonder if you are implementing it yourselves?

kamukondiwa avatar Jun 07 '24 09:06 kamukondiwa