Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Open
spamshaker wants to merge2 commits intoopenapi-ts:main
base:main
Choose a base branch
Loading
fromspamshaker:main

Conversation

spamshaker
Copy link

@spamshakerspamshaker commentedJun 29, 2025
edited
Loading

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:

  • Addedparameters option to ApiOperationOptions type
  • Updated OperationMetadata to include parameters property
  • Modified@apioperation decorator to accept and store parameter metadata
  • Added tests to verify parameter handling

This 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

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

…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
@spamshakerspamshaker requested a review froma team as acode ownerJune 29, 2025 15:48
@netlifyNetlify
Copy link

netlifybot commentedJun 29, 2025
edited
Loading

👷 Deploy request foropenapi-ts pending review.

Visit the deploys page to approve it

NameLink
🔨 Latest commit3539d83

@changeset-botchangeset-bot
Copy link

changeset-botbot commentedJun 29, 2025
edited
Loading

🦋 Changeset detected

Latest commit:3539d83

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
openapi-metadataPatch

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.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@duncanbeeversduncanbeeversAwaiting requested review from duncanbeeversduncanbeevers is a code owner automatically assigned from openapi-ts/maintainers

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Parameters storage is not fulfilled by parameters provided in ApiOperation
1 participant
@spamshaker

[8]ページ先頭

©2009-2025 Movatter.jp