[typescript-rxjs] Feat: Add @deprecated JSDoc tag to API operations #22378
+1,308
−27
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 commit introduces the JSDoc
@deprecatedtag to API methods generated by thetypescript-rxjsgenerator when the corresponding operation is marked as deprecated in the OpenAPI specification (deprecated: true).The change aims to improve developer experience (DX) and code quality by providing immediate feedback on API usage.
Details
deprecated: truein the spec, the@deprecatedtag is inserted into the JSDoc block preceding the method signature in the generatedapi.service.tsfile.Files Modified
modules/openapi-generator/src/main/resources/typescript-rxjs/apis.mustachemodules/openapi-generator/src/main/resources/typescript-rxjs/modelGeneric.mustachemodules/openapi-generator/src/main/resources/typescript-rxjs/modelAllOf.mustachemodules/openapi-generator/src/main/resources/typescript-rxjs/modelOneOf.mustachemodules/openapi-generator/src/main/resources/typescript-rxjs/modelEnum.mustache