Skip to content

[typescript-axios]: align jsdoc for @deprecated#21778

Merged
macjohnny merged 2 commits intoOpenAPITools:masterfrom
scarf005:refactor/simplify-jsdoc
Aug 21, 2025
Merged

[typescript-axios]: align jsdoc for @deprecated#21778
macjohnny merged 2 commits intoOpenAPITools:masterfrom
scarf005:refactor/simplify-jsdoc

Conversation

@scarf005
Copy link
Copy Markdown
Contributor

followup to #21776, where i've accidently removed whitespace in the PR. this change now properly aligns whitespace, and also simplifies mustache template for @deprecated.

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

Copy link
Copy Markdown
Contributor

@joscha joscha left a comment

Choose a reason for hiding this comment

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

Just one q about the deprecated oddity, rest looks good!

@macjohnny macjohnny merged commit 96b44ce into OpenAPITools:master Aug 21, 2025
18 checks passed
@scarf005 scarf005 deleted the refactor/simplify-jsdoc branch August 21, 2025 06:50
@wing328 wing328 added this to the 7.15.0 milestone Aug 22, 2025
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
* refactor: simplify `description` OR `deprecated` template

* chore: update generator output

---------

Co-authored-by: nocontribute <>
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.

4 participants