Skip to content

[PHP-SYMFONY] Debug Date and DateTime Assert#16874

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
loicconan:php_symfony_assert_date_datetime
Oct 23, 2023
Merged

[PHP-SYMFONY] Debug Date and DateTime Assert#16874
wing328 merged 1 commit intoOpenAPITools:masterfrom
loicconan:php_symfony_assert_date_datetime

Conversation

@loicconan
Copy link
Contributor

@loicconan loicconan commented Oct 19, 2023

Previously a DateTime properties was generated like that:

/**
 * @var \DateTime|null
 * @SerializedName("shipDate")
 * @Assert\DateTime()
 * @Type("DateTime")
 */
protected ?\DateTime $shipDate = null;

But when in our server base code, if we want to valid our object with Symfony\Component\Validator\Validator\ValidatorInterface (see Symfony doc), we have this error : This value should be of type

When we read this documentation we understand why : our parameter is a DateTime type, not a string like in their example.

So we need to change this assert @Assert\DateTime() by @Assert\Type("\DateTime"))

All of this is similar with Date type.

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
    
    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*.
    For Windows users, please run the script in Git BASH.
  • 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.

@loicconan
Copy link
Contributor Author

loicconan commented Oct 19, 2023

@jebentier (2017/07), @dkarlovi (2017/07), @mandrean (2017/08), @jfastnacht (2017/09), @ybelenko (2018/07), @renepardon (2018/12)

@wing328 wing328 added this to the 7.1.0 milestone Oct 23, 2023
@wing328 wing328 merged commit cb85358 into OpenAPITools:master Oct 23, 2023
@loicconan loicconan deleted the php_symfony_assert_date_datetime branch June 24, 2024 13:13
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.

2 participants