feat(openapi-typescript): add transformProperty hook for property signature modification #2449
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
added 2 commits
September 16, 2025 07:24
…nature modification Adds a new transformProperty hook that allows users to modify individual property signatures within Schema Objects. This enables adding JSDoc validation annotations and other property-level modifications that can't be achieved with existing transform/postTransform hooks. Features: - New transformProperty option in OpenAPITSOptions - Hook integration in schema-object transformer - Comprehensive documentation with JSDoc validation examples - Test coverage for JSDoc annotations and edge cases Resolves openapi-ts#2448
❌ Deploy Preview for openapi-ts failed.
|
🦋 Changeset detectedLatest commit: fcd7122 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
- Format transformProperty type definition for better readability - Apply biome formatting to feature-related test code - Keep changes focused only on transformProperty feature files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
Adds a new
transformPropertyhook that allows users to modify individual property signatures within Schema Objects. This enables adding JSDoc validation annotations and other property-level modifications that can't be achieved with existingtransform/postTransformhooks.Related Issue: Resolves #2448
Features Added:
transformPropertyoption inOpenAPITSOptionsHow to Review
src/transform/schema-object.tsfor hook integrationsrc/types.tsfor the new interfacedocs/node.mdfor examples and explanationspnpm testto verify new test cases passKey files to focus on:
src/transform/schema-object.ts- Main implementationdocs/node.md- Documentation with examplestest/node-api.test.ts- Test coverageChecklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)