Skip to content

docs: document default OpenAPI schema endpoints#4908

Closed
Brohammad wants to merge 8 commits into
litestar-org:mainfrom
Brohammad:docs-openapi-endpoints
Closed

docs: document default OpenAPI schema endpoints#4908
Brohammad wants to merge 8 commits into
litestar-org:mainfrom
Brohammad:docs-openapi-endpoints

Conversation

@Brohammad

@Brohammad Brohammad commented Jul 12, 2026

Copy link
Copy Markdown

Summary

  • Adds a Default schemas section to the OpenAPI usage docs explaining where to download the generated schema
  • Documents that GET /schema/openapi.json is always available by default (via automatic JsonRenderPlugin registration)
  • Clarifies that YAML endpoints require explicit YamlRenderPlugin configuration and the litestar[yaml] extra
  • Cross-links to the UI plugins docs for custom schema paths and YAML setup
  • Notes route conflict behavior, 404 handling for unknown schema paths, and programmatic access via app.openapi_schema

Fixes #3941

Context

This addresses the same issue as #4830 with corrections for factual accuracy (YAML is not served by default, which is covered by test_openapi_yaml_not_allowed in the test suite). Happy to close this in favor of updating #4830 if maintainers prefer.

Test plan

  • pre-commit run --files docs/usage/openapi/index.rst
  • pre-commit run --all-files
  • sphinx-build -b html -n docs docs/_build/html (no warnings on changed page)
  • CI green on GitHub

📚 Documentation preview 📚: https://litestar-org.github.io/litestar-docs-preview/4908

Gemini Worker and others added 4 commits July 12, 2026 17:42
Fixes pre-commit validate failure on PR litestar-org#4830.

Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify JSON is served by default, YAML requires YamlRenderPlugin,
and document custom paths, route conflicts, and programmatic access.

Fixes litestar-org#3941

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@Brohammad

Copy link
Copy Markdown
Author

@all-contributors please add @Brohammad for doc

@allcontributors

Copy link
Copy Markdown
Contributor

@Brohammad

I've put up a pull request to add @Brohammad! 🎉

Comment thread docs/usage/openapi/index.rst Outdated
Co-authored-by: Janek Nouvertné <provinzkraut@posteo.de>
@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.29%. Comparing base (bd18fd4) to head (4a05808).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4908   +/-   ##
=======================================
  Coverage   67.29%   67.29%           
=======================================
  Files         293      293           
  Lines       15228    15228           
  Branches     1728     1728           
=======================================
  Hits        10248    10248           
  Misses       4833     4833           
  Partials      147      147           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Brohammad

Copy link
Copy Markdown
Author

@all-contributors please add @Brohammad for doc

@allcontributors

Copy link
Copy Markdown
Contributor

@Brohammad

@Brohammad already contributed before to doc

@Brohammad

Copy link
Copy Markdown
Author

All checks pass, no conflicts, and review feedback is applied. Ready to merge when convenient.

@Brohammad

Copy link
Copy Markdown
Author

@codex please review this PR.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Delightful!

Reviewed commit: ca081072e5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@provinzkraut

Copy link
Copy Markdown
Member

@Brohammad Your behaviour of opening, closing, re-opening PRs, not taking into account feedback, and submitting redundant PR is highly disruptive. Furthermore, you repeatedly ignore our AI policy. You'll be blocked from further contributions in this organisation

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.

Docs: Add information on the default OpenAPI files available

5 participants