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(swagger-options): add persistAuthorization to SwaggerUiOptions #3306

Merged
merged 1 commit into from
Feb 19, 2025

Conversation

do-not-do-that
Copy link
Contributor

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: Type definition improvement (developer experience)

What is the current behavior?

Currently, SwaggerUiOptions does not include the persistAuthorization property, which is a valid option in Swagger UI.
This causes TypeScript users to not receive autocomplete and type safety for this option.

Issue Number: N/A

What is the new behavior?

This PR adds persistAuthorization to the SwaggerUiOptions interface, allowing TypeScript users to use this option with proper type inference.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Swagger UI documentation confirms that persistAuthorization is a valid option.
Reference: https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

@kamilmysliwiec kamilmysliwiec merged commit 109b7ea into nestjs:master Feb 19, 2025
1 check passed
@kamilmysliwiec
Copy link
Member

LGTM

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

Successfully merging this pull request may close these issues.

2 participants