marshmallow-code / marshmallow-code/flask-smorest
Add header to 340 response
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 717
- Forks
- 77
- Avg merge
- 7h 49m
- Merged PRs (30d)
- 3
Description
See https://github.com/marshmallow-code/flask-smorest/issues/233#issuecomment-787909415.
https://httpstatuses.com/304
> The server generating a 304 response MUST generate any of the following header fields that would have been sent in a 200 OK response to the same request: Cache-Control, Content-Location, Date, ETag, Expires, and Vary.
In our case, flask-smorest returns 304 due to ETag so that would be a ETag header.
TODO:
- [ ] Add ETag header to 304 response
- [ ] Document that header in 304 response doc
Users returning 304 through automatic mechanisms would be free to override.
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
Start by tracing flask-smorest's automatic ETag handling and the path that produces a 304 response, using the linked issue discussion for context. Check the existing 304 response documentation, then confirm that the ETag header is included while allowing users to override automatically generated 304 responses; completion covers both TODO items.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask, python
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100