OpenAPITools / OpenAPITools/openapi-generator
[BUG][PYTHON] should only allow timezone-aware datetime
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- [] Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
As described in https://github.com/OAI/OpenAPI-Specification/issues/1498#issuecomment-369680369, OpenAPI date-time strings must contain time-zone information.
In the Python client generator, the Pydantic fields are annotated with datetime, which allows timezone-naive objects to be passed. When serialized to strings, these do not contain time-zone information like a trailing Z or +00:00. This violates the OpenAPI spec.
openapi-generator version
7.7.0
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix
I would change the type annotations for date-time format string to pydantic.types.AwareDatetime, to require the time-zone information that the OpenAPI spec asks for when objects are constructed in Python.
This can be a breaking change to users using lenient REST APIs with the generated client. It might also be annoying if server responses contain "incorrect" timezone-naive timestamps and client-side validation fails.
Looking forward to feedback on how this should be best handled, to correctly represent the OpenAPI spec but not be annoying to users.
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
The issue names no source file or test. Start by generating a Python client with version 7.7.0 and checking how its Pydantic date-time fields handle naive and timezone-aware values; done means the generated client enforces timezone information consistently with the OpenAPI date-time requirement, with the compatibility impact resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100