MATGONZALEZ: define default None in non required params in Routes for… #693
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
… Play taking into account the default cannot be defined by api definition
gheine
reviewed
Mar 22, 2024
| @@ -108,6 +108,11 @@ private[models] case class Play2Route( | |||
| case ScalaDatatype.Option(_) => None | |||
| case p: ScalaPrimitive => Some("?= " + defaultForPrimitive(p, d)) | |||
| } | |||
| ).orElse( | |||
| param.datatype match { | |||
| case ScalaDatatype.Option(_) => Some("?= None") | |||
There was a problem hiding this comment.
Not sure we want to provide a default for all Options here (unsure if/what this might break). How about we only provide the default for ScalaDatatype.Option(ScalaDatatype.List(_)) and ScalaDatatype.Option(ScalaDatatype.Map(_))
There was a problem hiding this comment.
i tested it with a Optional[Long] and there is no need to force the default to None, so as you say only keeping it to List and Map on the meantime,
… it the forcing default is not needed for scalars
gheine
approved these changes
Mar 22, 2024
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.
The issue is the following
When looking to define non required params, the api builder doesn't give the option to define a default, so on some methods, the params are taking different than expect
Example:
when param is defined with
{ "name": "values","type": "[string]", "required": false}The route generation is:values: root.scala.Option[List[String]And if in the call the param is not passed, the values red side the Controller code isSome(List())instead ofNone`The fix will add as default for every non required param a None as default in the route using the
?= Nonepart