litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Open

#3 941 ouverte le 10 janv. 2025

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métriques du dépôt

Stars
 (8 243 stars)
Métriques de merge PR
 (Merge moyen 2j 22h) (53 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez les deux pages de documentation référencées et l'implémentation du contrôleur OpenAPI pour comprendre comment les fichiers par défaut sont servis. Ajoutez ensuite une section claire dans la documentation d'utilisation d'OpenAPI qui mentionne explicitement la disponibilité de openapi.json, openapi.yaml et openapi.yml au chemin OpenAPI configuré. Envisagez d'inclure une note pour la fonctionnalité d'importation de collection du client API Scalar.
Stack technique
pythonrest api
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Familiarity with Litestar frameworkKnowledge of OpenAPI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90