Skip to content

[scala-akka-http-server] model default value when field is not required#12068

Merged
wing328 merged 3 commits intoOpenAPITools:masterfrom
jsoizo:akka-http-default-option-value
May 9, 2022
Merged

[scala-akka-http-server] model default value when field is not required#12068
wing328 merged 3 commits intoOpenAPITools:masterfrom
jsoizo:akka-http-default-option-value

Conversation

@jsoizo
Copy link
Copy Markdown
Contributor

@jsoizo jsoizo commented Apr 6, 2022

fix: #12067

before: non-required fields have no default value

final case class Pet (
  id: Option[Long] = None,
  category: Option[Category] = None,
  name: String,
  photoUrls: Seq[String],
  tags: Option[Seq[Tag]] = None,
  status: Option[String] = None
)

val pet = Pet(name = "Dug", photoUrls = Nil)

after this PR: non-required fields have default value None.

final case class Pet (
  id: Option[Long],
  category: Option[Category],
  name: String,
  photoUrls: Seq[String],
  tags: Option[Seq[Tag]],
  status: Option[String]
)

val pet = Pet(id = None, category = None, name = "Dug", photoUrls = Nil, tags = None, status = None)

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/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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@clasnake (2017/07), @jimschubert (2017/09) ❤️, @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04)

Comment thread bin/configs/scala-akka-http-server.yaml Outdated
@jsoizo jsoizo force-pushed the akka-http-default-option-value branch from e335853 to be9bad9 Compare May 7, 2022 06:00
@wing328
Copy link
Copy Markdown
Member

wing328 commented May 9, 2022

FYI. I've updated the PR description (swapped the sample outputs)

@wing328 wing328 added this to the 6.0.0 milestone May 9, 2022
@wing328 wing328 merged commit d242a98 into OpenAPITools:master May 9, 2022
@jsoizo jsoizo deleted the akka-http-default-option-value branch May 10, 2022 06:11
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.

[REQ] set default value "None" to non-requied field of akka-http-server model

2 participants