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

fix(): Updated types for Specific ApiResponse decorator options to omit status #2877

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

Cellule
Copy link
Contributor

@Cellule Cellule commented Mar 12, 2024

Decorators like ApiOkResponse always override the status to a specific code.
Devs might think they are overriding the status but it's actually a no-op.
Updated the types of the options to raise an error if status is passed.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

Someone specifying a method like

@Controller('tests/:testId')
class TestAppController {
  @Get()
  @ApiOkResponse({ status: 201 })
  public get(@Param('testId') testId: string): string {
    return testId;
  }
}

Might think it will return a 201 response, But it's easy to miss the Ok in ApiOkResponse vs ApiResponse

What is the new behavior?

The code above will not compile because status is no longer an accepted option for Response decorators that override the status

Does this PR introduce a breaking change?

  • Yes
  • No

Migration path is to remove status options on affected Response decorators as they were unused.
If the Response needed to have a different status, instead replace the decorator with ApiResponse

Other information

An alternative would be to change the decorators to

export const ApiOkResponse = (options: ApiResponseOptions= {}) =>
  ApiResponse({
    status: HttpStatus.OK,
    ...options,
  });

Allowing to override the status, but that sounds even more dangerous because it would change the runtime of existing code instead of just having a compile error

…it status

Decorators like ApiOkResponse always override the status to a specific code.
Devs might think they are overriding the status but it's actually a no-op.
Updated the types of the options to raise an error if status is passed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants