marshmallow-code / marshmallow-code/apispec
Date and DateTime with format argument not rendered correctly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 202
- Avg merge
- 3h 38m
- Merged PRs (30d)
- 3
Description
When a Marshmallow `Date` or `DateTime` has a non-default `format` argument the output APISpec for the field has a `format: null` instead of `format: date` and `format: date-time` respectively.
The expected behaviour should be the latter as it was happening for versions of `apispec` before 6.4.
Created a draft PR https://github.com/marshmallow-code/apispec/pull/937 to showcase the fix.
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 reviewing draft PR #937 and reproducing the issue with Marshmallow Date and DateTime fields that use non-default format arguments. Done means the generated APISpec output reports format: date and format: date-time instead of format: null.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 30/100