Skip to content

docs(swagger): add ui/raws description, hint #3206

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

Merged

Conversation

mag123c
Copy link
Contributor

@mag123c mag123c commented Feb 19, 2025

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
  • Docs
  • Other... Please describe:

What is the current behavior?

Currently, the Swagger documentation does not provide a clear explanation of how the ui and raw options work independently. Users might assume that disabling the Swagger UI (ui: false) also disables JSON/YAML documentation or vice versa.

Issue Number: N/A

What is the new behavior?

This PR is an document update for the changes below.

nestjs/swagger#3185
nestjs/swagger@675a027

  • Added a new section under Setup options explaining how ui and raw interact.
  • Provided an example configuration demonstrating a case where the UI is disabled but JSON definitions remain available.
  • Clarified Swagger UI and JSON/YAML accessibility behavior when different combinations of ui and raw are used.
  • Improved readability by structuring explanations in a more user-friendly way.

Does this PR introduce a breaking change?

  • Yes
  • No

@kamilmysliwiec kamilmysliwiec merged commit b6062c1 into nestjs:master Feb 19, 2025
4 checks 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