Skip to content

Fix for incorrect Date serialization for format: date #17284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

a-ignatov-parc
Copy link
Contributor

Fix for #17272

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

day = day < 10 ? "0" + day.toString() : day.toString();

return data.getFullYear() + "-" + month + "-" + day;
return data.toISOString().substring(0,10);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this change, IIRC this caused troubles in the past when someone uses a local date and expects the local representation to be transferred over the wire, as opposed to a full iso string where the time zone information is there.

@TiFu any opinion here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@macjohnny, thank you for sharing your concern. While I'm confident that the dates should be transferred between the client and server with the UTC timezone, the main problem that I explained in #17272 is that the serialize and deserialize methods are incompatible. This is because the current deserialize method implementation expects the date with the UTC timezone.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TiFu @macjohnny, hi guys. Do you have any updates on this issue?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akehir @amakhrov what is your take on this?

@a-ignatov-parc a-ignatov-parc force-pushed the date-serialization-fix branch from 9fd0af5 to 1818502 Compare January 4, 2024 18:28
@mbcltd
Copy link

mbcltd commented Jan 26, 2024

We are also having the same issue where the openapi spec file has fields of type 'string', format 'date' the generated typescript models have fields of type Date but the API returns objects with fields of type string. Currently the type of the data returned from the api differs from the type in the Interface/Class file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants