swagger-api / swagger-api/swagger-ui
Swagger example json adds \n in the request
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
We are using @apimodelproperty in our rest project. When we execute our sample request which is populated by swagger api, it adds \n in every parameter. But in server side, we have some validation against this \n.
So how we can overcome this?
this example json looks like,
{"value":\n{
"value1":"abc",\n
"value2":"def",\n}}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the sample request generated from the @apimodelproperty example JSON and inspect Swagger UI's request-generation path. Confirm whether literal \n characters are added to parameters, then verify that the generated request no longer contains them and passes the reported server-side validation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100