litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Ouverte

#3 941 ouverte le 10 janv. 2025

Voir sur GitHubGuide contributeur
 (6 commentaires) (0 réaction) (0 personne assignée)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métriques du dépôt

Stars
 (8 243 étoiles)
Métriques de merge PR
 (Merge moyen 13h 27m) (26 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
Consultez la documentation OpenAPI actuelle sur https://docs.litestar.dev/latest/usage/openapi et identifiez où ajouter une section claire sur les points de terminaison de fichiers OpenAPI par défaut (openapi.json, openapi.yaml, openapi.yml). Assurez vous de mentionner leur disponibilité et leur utilisation, par exemple pour l'importation de collections du client API Scalar.
Stack technique
python
Domaine
backendapi
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.
1
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85