Skip to content

Conversation

scarf005
Copy link
Contributor

@scarf005 scarf005 commented Aug 20, 2025

typescript axios template had redundant JSDoc tags. made generated openapi client much slimmer by

  • only keeping information that cannot be expressed in typescript.
  • conditionally rendering JSDoc iff it has elements to render (description and @deprecated)

resolves #21717

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@scarf005 scarf005 force-pushed the feat/21717-typescript-axios-slim-down-jsdoc branch from f8b24e1 to 0c11661 Compare August 20, 2025 02:15
@scarf005 scarf005 force-pushed the feat/21717-typescript-axios-slim-down-jsdoc branch from 0c11661 to bd843a3 Compare August 20, 2025 02:18
@macjohnny
Copy link
Member

FYI this would supersede #21754

@@ -1 +1 @@
7.15.0-SNAPSHOT
7.13.0-SNAPSHOT
Copy link
Member

Choose a reason for hiding this comment

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

please merge the latest master to re-generate all samples. that should revert this line

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated and force-pushed in 85aa155 (#21776)

@scarf005 scarf005 force-pushed the feat/21717-typescript-axios-slim-down-jsdoc branch from bd843a3 to 85aa155 Compare August 20, 2025 07:48
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!

@macjohnny macjohnny merged commit 8c0f867 into OpenAPITools:master Aug 20, 2025
18 checks passed
@scarf005 scarf005 deleted the feat/21717-typescript-axios-slim-down-jsdoc branch August 20, 2025 08:48
@wing328 wing328 added this to the 7.15.0 milestone Aug 22, 2025
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][typescript-axios] slim down jsdoc
3 participants