[rishitank]

What/Why/How?

This picks up #2347 (Response example generation for XML and CSV), which @AlexVarchuk closed after the v3.0.0 release with a request to rebase onto main. The original branch lived in my former employer's fork, which I can no longer push to, so this is a new PR. The rewrite meant a straight rebase wasn't possible, so this is a port to v3's code.

What's left of #2347 for v3

• XML is already covered in v3. v3 samples every media type, and XML goes through openapi-sampler's XML mode, which handles xml.name, attribute, prefix, namespace and wrapped. I didn't port the old XML generator: it would duplicate that work and give worse output (no attributes, no escaping). I found a few bugs in the sampler's XML mode while comparing, and proposed fixes upstream in fix: xml root element, root arrays and allOf composition openapi-sampler#223.
• CSV is still missing. A text/csv response shows its generated sample as pretty-printed JSON. This PR adds that.
• No codeSamplesLanguages option. @adamaltman asked on Response example generation for XML and CSV #2347 whether the format could be worked out from the content type instead of an option. v3 now does that, and so does this PR.

Behaviour

• In PayloadDisplay, an object payload for a CSV media type is shown as CSV when it is a flat record or an array of flat records. CSV media types are text/csv, application/csv, *+csv, and the legacy x-csv / comma-separated-values, with any parameters. The CSV has a header row (the union of keys across records, in JavaScript property order: first seen, except that integer-like keys such as 10 come first), then one row per record, quoted per RFC 4180.
• The CSV table is shown in full, like the XML and form-urlencoded views: it isn't cut off at 1,000 characters.
• This applies to both generated samples and object examples written in the spec. It also covers oneOf variants, through the existing variant picker.
• Payloads that aren't tabular (nested objects or arrays, primitives, empty) keep the current rendering, so nothing gets worse.
• String CSV examples are shown as written, as before. langFromMime returns text for CSV, so the code block and copy telemetry report text rather than clike (rendering is unchanged).
• Edge cases handled:
  • A missing cell under a column named like an Object.prototype member (e.g. constructor) stays empty, and an own __proto__ key is an ordinary column.
  • An empty cell in a single-column table is written as "", so the row doesn't become a blank line.

Example (text/csv, schema array of {date, keyword, clicks} where keyword has the example shoes, red):

date,keyword,clicks
2019-08-24,"shoes, red",0

Before this change, the same response showed [ { "date": "2019-08-24", "keyword": "shoes, red", "clicks": 0 } ].

Reference

• Supersedes Response example generation for XML and CSV #2347, including @adamaltman's review question on it.
• XML follow-up in the sampler: fix: xml root element, root arrays and allOf composition openapi-sampler#223.

Tests

• New src/utils/__tests__/csv.test.ts (21 tests):
  • quoting, header union and missing cells
  • null/undefined values
  • prototype-named columns (including an own __proto__ key) and single-column empty cells
  • every non-tabular fallback
  • the allOf/oneOf/$ref fixtures from Response example generation for XML and CSV #2347, run through openapi-sampler
• media-type.test.ts: isCsvMediaType (case, parameters, +csv, legacy aliases, negatives) and langFromMime for CSV.
• PayloadDisplay.test.tsx: CSV for text/csv (with charset), application/csv and +csv; a long table shown untruncated; the JSON fallback for nested data; string CSV as plain text.
• npm run lint, npm run ts:check and npm run unit pass: 3,286 tests.
• npm run e2e: 310 passed, 2 failed. The two failures (download.spec.ts › GraphQL: should download schema and scroll-anchoring.spec.ts › Scroll-spy URL sync) also fail on an unmodified main in my environment, where outbound requests to cdn.redoc.ly are blocked. Neither touches examples.
• Checked by hand in a standalone build in Chromium: the text/csv response renders as above.

Check yourself

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

🤖 Generated with Claude Code

https://claude.ai/code/session_01117LuacuBxMJUn1wJkfdyL

[makare11a]

lgtm

[makare11a]

Merged! Thank you for your contribution @rishitank. The changes will be available in the next release