Add support for replacing binary multipart data with placeholder content

Open
#264 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, spring
Domain
documentation

Research direction

Start by locating the core preprocessor and multipart snippet-generation entry points in Spring REST Docs. Determine how a preprocessor can select multipart parts and replace binary content with a placeholder while preserving other parts; done means binary multipart data no longer produces garbled snippet output.

Written by the indexing model from the issue text.

Description

type: enhancement

You can see in this Stack Overflow question, that when posting Multipart data, often there is binary data, which causes the resulting snippet to be a large amount of garbled data. It would be nice to have a core preprocessor that allows us to replace that binary content with a placeholder, like <<binary data>>. The component should allow for selecting which parts should be replaced, as not all parts will be binary data.

Dominant language
Java
Stars
1.2k
Forks
731
No merged PRs in 30d

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.

More from spring-projects/spring-restdocs

All issues in spring-projects/spring-restdocs

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.