Fix OpenAPI types of UNIX timestamp fields #3731
Merged
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
Fields of type
Date
that are not explicitly serialized withIso8601DateSerializer
are automatically serialized as UNIX epoch timestamp in milliseconds. However the OpenAPI spec declared them to be of typestring
indate-time
format, which is incorrect.Instead of changing the field's actual type, causing a breaking change, provide a type hint to the OpenAPI generator.
Addressed Issue
Fixes #1276
Fixes #2591
Additional Details
Checklist
This PR fixes a defect, and I have provided tests to verify that the fix is effectiveThis PR introduces changes to the database model, and I have added corresponding update logicThis PR introduces new or alters existing behavior, and I have updated the documentation accordingly