title: add from annotation #1810
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
|
Wasn't this issue closed with: #1657? |
Author
|
#1657 doesn't handle references and merges Also the test in that was added in the PR was a title to Property and not Schema (or ref schema / property) I use Tsoa and |
Author
|
@jefflembeck what do you think we should do next? |
Contributor
|
@orgoro I'm gonna be honest, man. I have an internal fork of TSOA for my company. YMMV if that's the appropriate avenue to take for you. I don't have the overhead time to even attempt forking this project as a whole. |
WoH
reviewed
Dec 14, 2025
| import { versionMajorMinor } from 'typescript'; | ||
| import { getDefaultExtendedOptions } from '../../fixtures/defaultOptions'; | ||
| import { EnumDynamicPropertyKey, TestModel } from '../../fixtures/testModel'; | ||
| import { title } from 'process'; |
Collaborator
|
Does this intentionally omit refEnums? |
…erty, with corresponding tests
Collaborator
|
I think this should now be complete. Lmk if I missed something, but I think we want to pass through property titles, not silently swallow them. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds support for extracting and including
@titleJSDoc annotations from TypeScript models and properties into the generated OpenAPI/Swagger schema definitions. It does so by updating the metadata generation pipeline to read thetitleannotation and propagate it through all relevant types, transformers, and spec generators. Comprehensive tests are added to verify that thetitleannotation appears correctly in the output schemas.These changes ensure that descriptive
titleannotations are preserved from source code to API documentation, improving schema clarity for consumers.All Submissions:
Closing issues
closes #1656
Put
closes #XXXX(where XXXX is the issue number) in your comment to auto-close the issue that your PR fixes.If this is a new feature submission:
Potential Problems With The Approach
Test plan
TestModelWithAnnotationsfixture with@titleJSDoc annotations at both model and property levels to verify extraction and propagation. (tests/fixtures/testModel.ts, [1]; [2]titlefor models and properties, including OpenAPI 3 specific checks. (tests/unit/swagger/schemaDetails3.spec.ts, [1]; [2]; [3]; [4]