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

feat(typescript): write minimum, maxmimum and default to JSDoc #19707

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

joscha
Copy link
Contributor

@joscha joscha commented Sep 29, 2024

This adds the properties

  • minimum
  • maximum
  • default

to the generated API docs.

I deliberately did not use the @default <value> tag as that describes an assigned value, which is not how the generated code currently works. Defaults are outlined by the API spec but not enforced or provided on client side.

I also noticed that there is no validation in any of the typescript clients - typescript-fetch has a validation map that can be generated optionally, but that's it. Is that a deliberate design decision as minima/maxima can change on the server side, so we don't want to enforce them client side?

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.x.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: @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)

@@ -23,12 +23,14 @@ export interface PetApiAddPetRequest {
export interface PetApiDeletePetRequest {
/**
* Pet id to delete
* Defaults to: undefined
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are a bunch of these. These are technically correct, however read a bit odd especially if the parameter is a required parameter. As mustache is logicless we can't easily exclude them with an undefined check. We could possibly introduce a new template var that is only populated if its not "undefined".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant