HTTP migration writese plugin properties on comment.#223
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the JSDoc comment generation for migrated HTTP routes to surface more OpenAPI metadata (including custom plugin properties) and adds a targeted test, along with a patch version bump.
Changes:
- Refactors
HttpMigrateRouteComposer’s route comment composition to include security, tags, deprecation status, andx-plugin properties in a structured JSDoc-style format. - Adds
test_http_migrate_route_pluginto validate that custom plugin fields (e.g.,x-autobe-specification) are correctly serialized into route comments, including multi-line content. - Bumps the package version from
6.0.0to6.0.1to reflect the added functionality.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/composers/HttpMigrateRouteComposer.ts |
Adjusts description assembly and extends comment tag composition to cover parameters, security, tags, deprecation, and primitive x- plugin properties before finalizing the route JSDoc comment. |
test/src/features/migrate/test_http_migrate_route_plugin.ts |
Introduces a new test that builds an OpenAPI document with a custom x-autobe-specification plugin property and asserts that route.comment() includes and formats the plugin text as expected. |
package.json |
Increments the package version to 6.0.1 to capture the new comment-generation behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
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
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.
This pull request introduces enhancements to the JSDoc comment generation logic in
HttpMigrateRouteComposer, making the generated documentation more comprehensive and extensible, especially for plugin properties. It also adds a new test to verify the correct inclusion and formatting of custom plugin fields in the route comments.Enhancements to JSDoc comment generation:
HttpMigrateRouteComposerto include additional sections such as security, tags, deprecation status, and custom plugin properties (fields starting withx-). This ensures that any relevant OpenAPI extensions are now documented in the generated comments. [1] [2] [3]Testing improvements:
test_http_migrate_route_plugin, to verify that custom plugin fields (e.g.,x-autobe-specification) are correctly included in the generated route comments and formatted as expected.Package version update:
package.jsonfrom6.0.0to6.0.1to reflect the new features and improvements.