litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Open

#3,941 opened on Jan 10, 2025

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Repository metrics

Stars
 (8,243 stars)
PR merge metrics
 (Avg merge 13h 27m) (26 merged PRs in 30d)

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

Research direction
Review the current OpenAPI documentation at https://docs.litestar.dev/latest/usage/openapi and identify where to add a clear section about the default OpenAPI file endpoints (openapi.json, openapi.yaml, openapi.yml). Ensure to mention their availability and usage, e.g., for Scalar API client's collection import.
Tech stack
python
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85