litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Open

#3,941 opened on Jan 10, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (8,243 stars) (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Description

Summary

In https://docs.litestar.dev/latest/usage/openapi we don't really specifically say anything about the availability of $openapi_path/openapi.{json,yaml,yml} except in 2 places, 1 of which says it is deprecated:

It would be nice to document this when people need them e.g., for Scalar API client's collection import feature

Contributor guide

Tech stack
pythonrest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Litestar frameworkKnowledge of OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Examine the two referenced documentation pages and the OpenAPI controller implementation to understand how the default files are served. Then add a clear section in the OpenAPI usage documentation that explicitly mentions the availability of openapi.json, openapi.yaml, and openapi.yml at the configured OpenAPI path. Consider including a note for Scalar API client's collection import feature.