Fix datetime object handling in OpenAPI schema generation #1134
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add special handling for datetime.datetime and datetime.date types - Add schema generation tests for datetime types - Fix AttributeError when generating schema for datetime return types Fixes sparckles#1124
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
sansyrox
reviewed
Mar 6, 2025
| if param_type.__module__ == "typing": | ||
| properties["anyOf"] = [{"type": self.get_openapi_type(param_type.__args__[0])}, {"type": "null"}] | ||
| from typing import Optional, Union |
There was a problem hiding this comment.
@Soroushsrd , thanks for the PR but we can move the imports to the top of the file, right?
|
Hey @Soroushsrd 👋 One more thing
Lint PR is failing as well |
|
Thank you for the comments. Will fix it ASAP |
|
Hi @Soroushsrd, some of the test for python 3.9 and 3.10 failing, can you fix them? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes #1124
Summary
This PR fixes the OpenAPI schema generation for endpoints that return datetime objects. Previously, the application would fail to start with an AttributeError when attempting to generate OpenAPI documentation for endpoints returning datetime.datetime or datetime.date objects.
Changes made:
datetime.datetimeanddatetime.datetypes in schema generationPR Checklist
Please ensure that:
Pre-Commit Instructions: