litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Open

#3.941 geöffnet am 10. Jan. 2025

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (550 Forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Repository-Metriken

Stars
 (8.243 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 2T 22h) (53 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche die beiden referenzierten Dokumentationsseiten und die OpenAPI Controller Implementierung, um zu verstehen, wie die Standarddateien bereitgestellt werden. Füge dann im OpenAPI Nutzungsdokument einen klaren Abschnitt hinzu, der ausdrücklich die Verfügbarkeit von openapi.json, openapi.yaml und openapi.yml unter dem konfigurierten OpenAPI Pfad erwähnt. Erwäge, einen Hinweis für die Sammlungsimportfunktion des Scalar API Clients aufzunehmen.
Tech Stack
pythonrest api
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Familiarity with Litestar frameworkKnowledge of OpenAPI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90