Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork552
fix(#2364): Add support for passing parameters to @ApiOperation#2365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
…tionThis commit introduces the ability to pass parameters directly to the@apioperation decorator, allowing developers to define path parameters within the decorator itself. This simplifies OpenAPI schema generation and improves developer experience by reducing boilerplate code.Changes include:- Added `parameters` option to ApiOperationOptions type- Updated OperationMetadata to include parameters property- Modified@apioperation decorator to accept and store parameter metadata- Added tests to verify parameter handlingThis change aligns with common usage patterns for OpenAPI specifications and provides a more intuitive way to define API operations with required parameters.#closesopenapi-ts#2364
netlifybot commentedJun 29, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
👷 Deploy request foropenapi-ts pending review.Visit the deploys page to approve it
|
changeset-botbot commentedJun 29, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
🦋 Changeset detectedLatest commit:3539d83 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
This commit fixes issueopenapi-ts#2364 by enabling developers to specify parameters directly within the@apioperation decorator. This streamlines OpenAPI schema generation and improves developer experience with a more concise syntax for defining API operations that require specific input parameters.
Uh oh!
There was an error while loading.Please reload this page.
This commit introduces the ability to pass parameters directly to the@apioperation decorator, allowing developers to define path parameters within the decorator itself. This simplifies OpenAPI schema generation and improves developer experience by reducing boilerplate code.
Changes include:
parameters
option to ApiOperationOptions typeThis change aligns with common usage patterns for OpenAPI specifications and provides a more intuitive way to define API operations with required parameters.
Changes
closes#2364
How to Review
How can a reviewer review your changes? What should be kept in mind for this review?
Checklist
docs/
updated (if necessary)pnpm run update:examples
run (only applicable for openapi-typescript)