Skip to content

fix(docs): make layered param cookie optional in example#4500

Merged
provinzkraut merged 1 commit intolitestar-org:mainfrom
Adithya1331:fix/layered-param-example
Nov 28, 2025
Merged

fix(docs): make layered param cookie optional in example#4500
provinzkraut merged 1 commit intolitestar-org:mainfrom
Adithya1331:fix/layered-param-example

Conversation

@Adithya1331
Copy link
Copy Markdown
Contributor

Description

Modified the docs/examples/parameters/layered_parameters.py example to make the app_param cookie parameter optional (required=False).
Previously, running this example would result in 400 Bad Request errors when accessing endpoints (such as the OpenAPI schema) if the special-cookie was not present. This change ensures the example is runnable and the documentation remains accurate.

Closes

Closes #4499

@Adithya1331 Adithya1331 requested review from a team as code owners November 28, 2025 05:22
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: small type/bug pr/external Triage Required 🏥 This requires triage labels Nov 28, 2025
@github-actions
Copy link
Copy Markdown

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4500

Copy link
Copy Markdown
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks 🚀

@provinzkraut provinzkraut merged commit 4b90eb2 into litestar-org:main Nov 28, 2025
28 checks passed
provinzkraut pushed a commit that referenced this pull request Dec 13, 2025
fix: make layered param cookie optional in example
(cherry picked from commit 4b90eb2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs This PR involves changes to the documentation pr/external size: small Triage Required 🏥 This requires triage type/bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Layered param example fails

3 participants