Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@Hidden of An Endpoint Doesn't Hide the Parameter Types #1450

Open
2 of 4 tasks
dolevl opened this issue Jul 13, 2023 · 4 comments
Open
2 of 4 tasks

@Hidden of An Endpoint Doesn't Hide the Parameter Types #1450

dolevl opened this issue Jul 13, 2023 · 4 comments

Comments

@dolevl
Copy link

dolevl commented Jul 13, 2023

Sorting

  • I'm submitting a ...

    • bug report
    • feature request
    • support request
  • I confirm that I

    • used the search to make sure that a similar issue hasn't already been submit

Expected Behavior

When hiding an endpoint using @hidden the endpoint and its unique parameter types shouldn't be exposed.
For example given the following endpoint:

@Hidden()
@Post('/publish')
async publish(@Body() request: PublishRequest): Promise<PublishResponse> {

The publish endpoint together with PublishRequest and PublishResponse are expected not to appear in the swagger.json file.

Current Behavior

The endpoint itself wasn't exposed but its parameter types that are unique to it are exposed in the swagger.json file.

Context (Environment)

Version of the library: 5.1.1
Version of NodeJS: 16.14.0

  • Confirm you were using yarn not npm: yes
@github-actions
Copy link

Hello there dolevl 👋

Thank you for opening your very first issue in this project.

We will try to get back to you as soon as we can.👀

@github-actions
Copy link

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

@github-actions github-actions bot added the Stale label Aug 13, 2023
@dolevl
Copy link
Author

dolevl commented Aug 13, 2023

any news about this?

@github-actions github-actions bot removed the Stale label Aug 14, 2023
@WoH
Copy link
Collaborator

WoH commented Aug 14, 2023

Seems like a bug, do you want to send a PR? Remember to add tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants