litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Open

#3941 aperta il 10 gen 2025

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Python (550 fork)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Metriche repository

Star
 (8243 star)
Metriche merge PR
 (Merge medio 2g 22h) (53 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina le due pagine di documentazione citate e l'implementazione del controller OpenAPI per capire come vengono serviti i file predefiniti. Quindi aggiungi una sezione chiara nella documentazione sull'uso di OpenAPI che menzioni esplicitamente la disponibilità di openapi.json, openapi.yaml e openapi.yml al percorso OpenAPI configurato. Considera di includere una nota per la funzione di importazione della collezione del client API Scalar.
Tech stack
pythonrest api
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Familiarity with Litestar frameworkKnowledge of OpenAPI
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90