Redocly / Redocly/redoc

Support for application/merge-patch+json content-type payload in automated samples

Open
#2,217 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the problem to be solved
Support for application/merge-patch+json content-type payload in automated samples (Try It). Today it shows as [object Object] (the default javascript "toString()" output for Objects)

Describe the solution you'd like
Should behave as if it was application/json from stand point of automated samples.

Describe alternatives you've considered
We need this specific content-type to distinguish PATCH processing. We could probably write all our samples by hand but the automatic generation is what we wanted really.

Additional context
image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named in the issue. Start by locating the automated sample generation and content-type handling used by Try It, then compare the output for application/merge-patch+json with application/json. Done means merge-patch payloads are generated as JSON rather than [object Object].

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.