Response example generation for XML and CSV by rishitank · Pull Request #2347 · Redocly/redoc

rishitank · 2023-06-29T08:49:34Z

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

…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

lornajane · 2023-06-29T12:45:07Z

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

LeWolOnline · 2024-06-05T15:26:32Z

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

ndmitrys · 2024-06-07T08:29:20Z

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

kamukondiwa · 2024-06-07T09:29:51Z

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?

adamaltman · 2024-10-09T01:45:03Z

  * **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.


I wonder why this is needed? Can we not determine this from the content type? (application/json, vs application/xml, vs text/csv)?

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

AlexVarchuk · 2026-10-14T12:28:14Z

@rishitank Thank you for the contribution! 🙏
We've just shipped Redoc v3.0.0, which reworked a large part of the codebase, so older PRs no longer apply cleanly. We're closing them to keep the queue manageable. If you think this is still relevant for v3, please rebase onto main and reopen, and we'll happily review it.

For text/csv (and application/csv, +csv, x-csv, comma-separated-values) media types, PayloadDisplay now renders a flat record, or an array of flat records, as CSV: a header row plus RFC 4180-quoted rows. Payloads that are not tabular keep the previous rendering. String CSV examples are shown as plain text instead of C-like highlighting. Re-contributes the CSV half of Redocly#2347 for v3. The format is derived from the media type, so the codeSamplesLanguages option is no longer needed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL

rishitank · 2026-10-14T16:08:44Z

Thanks @AlexVarchuk! I can't reopen this one, because its branch lived in a fork I no longer have access to. So I've opened a new PR rebased onto v3 main: #2869.

v3 already generates XML examples, so #2869 covers only the CSV half. It works the format out from the content type rather than adding the codeSamplesLanguages option, as @adamaltman suggested. While comparing the XML output, I also found a few bugs in openapi-sampler's XML mode and fixed them in Redocly/openapi-sampler#223.

* feat: render CSV request and response examples For text/csv (and application/csv, +csv, x-csv, comma-separated-values) media types, PayloadDisplay now renders a flat record, or an array of flat records, as CSV: a header row plus RFC 4180-quoted rows. Payloads that are not tabular keep the previous rendering. String CSV examples are shown as plain text instead of C-like highlighting. Re-contributes the CSV half of #2347 for v3. The format is derived from the media type, so the codeSamplesLanguages option is no longer needed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL * feat: wire CSV rendering into PayloadDisplay and add tests Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL * feat: render CSV payloads in PayloadDisplay Completes the previous commit, which only added the CSV unit tests: PayloadDisplay now uses jsonToCsv for CSV media types, with tests. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL * fix: show CSV examples untruncated; correct the changeset Generated CSV tables are no longer cut at MAX_DISPLAYED_STRING_LENGTH, matching the XML and form-urlencoded views. The changeset no longer claims string CSV examples changed: clike already rendered as plain text. Documents LF row separators and the absence of formula-injection escaping, and tests an own __proto__ key. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

Redocly/redoc#2347 (2023) was closed when Redoc v3 shipped. Its CSV half was re-raised against v3 as Redocly/redoc#2869 and merged on 15 Oct 2026; the XML half became fixes to openapi-sampler, Redocly/openapi-sampler#223, still in review. Same wording as the portfolio's open-source card. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL

…es await review (#2) The Redoc line still described the 2023 PR (Redocly/redoc#2347) as open. It now says the examples were first proposed in 2023 and later requested by other developers, CSV is merged into v3 for the next release (Redocly/redoc#2869, merged 15 Oct 2026, after redoc@3.0.1), and the XML fixes to openapi-sampler await review (Redocly/openapi-sampler#223). Reviewed by CodeRabbit (approved 564170d) and an independent Claude fact-check of every claim. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL

rishitank added 15 commits June 13, 2023 09:39

FBI-451: Implement XML example code generation for Redoc

00256a8

random commit

b13b139

FBI-451: Improve example ID

18aadd5

FBI-451: Provide codeSamplesLanguage as an option

eee14dd

FBI-451: Provide codeSamplesLanguage as an option

d1b54be

Merge branch 'feature-FBI-451-implement-xml-response-example-generati…

7eac7e8

…on-for-redoc' of https://github.com/Adthena/adthena-redoc into feature-FBI-451-implement-xml-response-example-generation-for-redoc

FBI-451: clean up

8e56a3b

FBI-451: clean up

f29b7ae

FBI-451: address CR comments

69c7fc4

Merge pull request #3 from Adthena/feature-FBI-451-implement-xml-resp…

55c66f6

…onse-example-generation-for-redoc FBI-451: Implement XML example code generation for Redoc

FBI-459: Implement CSV code sample generation for redoc

068ba23

FBI-459: improvements

c4133cf

FBI-459: improvements

1d4c0dc

Merge pull request #5 from Adthena/feature-FBI-459-implement-csv-code…

8080b33

…-sample-generation-for-redoc FBI-459: Implement CSV code sample generation for redoc

FBI-287: update readme

2ef6a02

rishitank requested a review from a team as a code owner June 29, 2023 08:49

rishitank mentioned this pull request Jun 29, 2023

Latest Redoc doesn't generate XML request bodies #492

Closed

FBI-287: update readme

33f167e

rishitank mentioned this pull request Jul 23, 2024

xml example cannot be generated for response type of array swagger-api/swagger-ui#4650

Open

adamaltman reviewed Oct 9, 2024

View reviewed changes

alokthakur142 approved these changes Mar 27, 2025

View reviewed changes

AlexVarchuk closed this Oct 14, 2026

rishitank mentioned this pull request Oct 14, 2026

fix: xml root element, root arrays and allOf composition Redocly/openapi-sampler#223

Open

5 tasks done

rishitank mentioned this pull request Oct 14, 2026

feat: render CSV request and response examples #2869

Merged

3 tasks done

rishitank mentioned this pull request Oct 15, 2026

docs: Redoc CSV examples merged into v3; XML fixes in review rishitank/rishitank#2

Merged

Navigation Menu

Repository navigation

Response example generation for XML and CSV - #2347

Response example generation for XML and CSV#2347
rishitank wants to merge 16 commits into
Redocly:mainfrom
Adthena:epic-FBI-287-response-example-generation-for-xml-and-csv

rishitank commented Jun 29, 2023

Uh oh!

lornajane commented Jun 29, 2023

Uh oh!

LeWolOnline commented Jun 5, 2024

Uh oh!

ndmitrys commented Jun 7, 2024

Uh oh!

kamukondiwa commented Jun 7, 2024

Uh oh!

adamaltman Oct 9, 2024

Uh oh!

rishitank Oct 9, 2024

Uh oh!

AlexVarchuk commented Oct 14, 2026

Uh oh!

rishitank commented Oct 14, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

rishitank commented Jun 29, 2023

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Uh oh!

lornajane commented Jun 29, 2023

Uh oh!

LeWolOnline commented Jun 5, 2024

Uh oh!

ndmitrys commented Jun 7, 2024

Uh oh!

kamukondiwa commented Jun 7, 2024

Uh oh!

adamaltman Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

rishitank Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

AlexVarchuk commented Oct 14, 2026

Uh oh!

rishitank commented Oct 14, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants