swagger-api / swagger-api/swagger-ui
3xx status codes as depicted as errors
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Using latest 3.x version.
When an endpoint sends a 304, Swagger UI says in the "Details" column: "Error: ". The issue is that 3xx are not error codes. See https://tools.ietf.org/html/rfc7231#section-6.4 and https://tools.ietf.org/html/rfc7232#section-4.1. They should be treated as 2xx, but with optional followup requests required (intermediate).
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 issue in Swagger UI with an endpoint returning HTTP 304, then trace how the response is classified and displayed in the Details column. Compare the behavior with RFC 7231 section 6.4 and RFC 7232 section 4.1; done means 3xx responses are no longer presented as errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100