Skip to content
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

[typescript-fetch] Add option to generate validation attributes of model properties #19448

Conversation

matthiasschwarz
Copy link
Contributor

Adds a new option to generate validation attributes of model properties. This allows the use of these attributes for schema validation.

The following attributes are exposed via a lookup table of the model property:

  • maxLength
  • minLength
  • pattern
  • maximum
  • exclusiveMaximum
  • minimum
  • exclusiveMinimum
  • multipleOf
  • maxItems
  • minItems
  • uniqueItems

The following attributes are exposed via an object when model has additional properties:

  • maxProperties
  • minProperties

cc @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)

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.6.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.

Copy link
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.

thanks for your contribution, looks good!
can you please change the template according to my comment and then we can merge this?

@@ -157,4 +157,39 @@ export function {{classname}}ToJSON(value?: {{#hasReadOnly}}Omit<{{classname}},
{{^hasVars}}
return value;
{{/hasVars}}
}
}{{#validationAttributes}}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
}{{#validationAttributes}}
}
{{#validationAttributes}}

uniqueItems?: boolean
}
} = { {{#vars}}{{#hasValidation}}
{{name}}: { {{#maxLength}}
Copy link
Member

Choose a reason for hiding this comment

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

you can put the stuff on new lines, like

{{#maxLength}}maxLength: {{maxLength}},{{/maxLength}}
{{#minLength}}minLength: {{minLength}},{{/minLength}}
...

this makes the template nicer to read

This comment was marked as resolved.

@matthiasschwarz matthiasschwarz force-pushed the typescript-fetch-validation-attributes branch from 1f74b0f to ee28ca6 Compare August 26, 2024 21:10
@matthiasschwarz matthiasschwarz force-pushed the typescript-fetch-validation-attributes branch from ee28ca6 to e0d251c Compare August 26, 2024 21:17
@matthiasschwarz
Copy link
Contributor Author

@macjohnny I changed the formatting of the template.

@macjohnny macjohnny merged commit 4330b2f into OpenAPITools:master Aug 27, 2024
15 checks passed
@wing328 wing328 added this to the 7.9.0 milestone Oct 7, 2024
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.

3 participants