Skip to content

[typescript-fetch] remove @type and @memberof from model docs - #24514

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
babariviere:chore/remove-type-memberof
Jul 29, 2026
Merged

[typescript-fetch] remove @type and @memberof from model docs#24514
macjohnny merged 1 commit into
OpenAPITools:masterfrom
babariviere:chore/remove-type-memberof

Conversation

@babariviere

@babariviere babariviere commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Drop the @type and @memberof JSDoc annotations from the generated model interfaces and regenerate the samples.

This is a follow-up of this comment:
#24510 (comment)

PR checklist

  • Read the contribution guidelines.
  • 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
    
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

cc @macjohnny


Summary by cubic

Remove @type and @memberof JSDoc tags from generated typescript-fetch model interfaces to simplify field docs and rely on TypeScript types for accuracy.

  • Refactors
    • Updated modelGenericInterfaces.mustache to stop emitting @type and @memberof on model fields.
    • Regenerated typescript-fetch samples to reflect the new doc comments.

Written for commit 66b27f2. Summary will update on new commits.

Review in cubic

Drop the @type and @memberof JSDoc annotations from the generated model
interfaces and regenerate the samples.

This is a follow-up of this comment:
OpenAPITools#24510 (comment)

@macjohnny macjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks for the cleanup

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 214 files

Note: This PR contains a large number of files. cubic only reviews up to 200 files per PR, so some files may not have been reviewed. cubic prioritizes the most important files to review.

Re-trigger cubic

@macjohnny
macjohnny merged commit 3c3d3df into OpenAPITools:master Jul 29, 2026
21 of 23 checks passed
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.

2 participants