Response example generation for XML and CSV#2347
Response example generation for XML and CSV#2347rishitank wants to merge 16 commits intoRedocly:mainfrom
Conversation
…on-for-redoc' of https://github.com/Adthena/adthena-redoc into feature-FBI-451-implement-xml-response-example-generation-for-redoc
…onse-example-generation-for-redoc FBI-451: Implement XML example code generation for Redoc
…-sample-generation-for-redoc FBI-459: Implement CSV code sample generation for redoc
|
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 |
|
Oh, I'm experiencing the same issue. @lornajane, any updates? |
|
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? |
| * **path-only**: displays a path in the sidebar navigation item. | ||
| * **id-only**: displays the operation id with a fallback to the path in the sidebar navigation item. | ||
| * `showWebhookVerb` - when set to `true`, shows the HTTP request method for webhooks in operations and in the sidebar. | ||
| * `codeSamplesLanguages` - enables code sample generation for the provided list of languages. |
There was a problem hiding this comment.
I wonder why this is needed? Can we not determine this from the content type? (application/json, vs application/xml, vs text/csv)?
There was a problem hiding this comment.
This is used to allow the user to control for which media types they want code examples to show up rather than showing all code examples for all media types supported (in case the user doesn't want code examples for certain media types to show up by default).
7 participants
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.
Reference
Testing
Screenshots (optional)
Check yourself