Skip to content

[typescript-node] Set model default values#10262

Merged
macjohnny merged 5 commits intoOpenAPITools:masterfrom
sarumont:ts_node_default_values
Sep 30, 2021
Merged

[typescript-node] Set model default values#10262
macjohnny merged 5 commits intoOpenAPITools:masterfrom
sarumont:ts_node_default_values

Conversation

@sarumont
Copy link
Copy Markdown
Contributor

@sarumont sarumont commented Aug 25, 2021

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.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • 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)

@wing328
Copy link
Copy Markdown
Member

wing328 commented Sep 9, 2021

Can you please follow step 3 in the PR checklist to update the samples so that the CI can verify the change?

@sarumont sarumont force-pushed the ts_node_default_values branch from 813b541 to 04d987b Compare September 9, 2021 15:19
@sarumont
Copy link
Copy Markdown
Contributor Author

sarumont commented Sep 9, 2021

Updated - thought I had done that already!

@macjohnny
Copy link
Copy Markdown
Member

macjohnny commented Sep 28, 2021

This change seems to set undefined als a default value for fields that are not optional, see the circle CI failure

@sarumont
Copy link
Copy Markdown
Contributor Author

sarumont commented Sep 29, 2021

Ah, yes...there was another mod we have in our fork of these templates. There are two options here, though:

  1. set the default for defaultValue to Java null in the generator code, causing {{#defaultValue}} to only hit when it is specified in the OAPI spec.
  2. only set the default value for non-required fields

We went with the first approach, which I think is the cleaner option (as you may want to set defaults for required fields). I'll make that mod here and revert later if the latter option is preferred.

@macjohnny
Copy link
Copy Markdown
Member

macjohnny commented Sep 29, 2021

Option 1 sounds good

macjohnny
macjohnny approved these changes Sep 30, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

@macjohnny macjohnny merged commit 8c059a8 into OpenAPITools:master Sep 30, 2021
@macjohnny macjohnny added this to the 5.3.0 milestone Sep 30, 2021
@sarumont sarumont deleted the ts_node_default_values branch October 2, 2021 02:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@macjohnny macjohnny macjohnny approved these changes

Assignees

No one assigned

Labels

Client: TypeScript

Projects

None yet

Milestone

5.3.0

Development

Successfully merging this pull request may close these issues.

3 participants

@sarumont @wing328 @macjohnny