litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Open

#3.941 aberto em 10 de jan. de 2025

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métricas do repositório

Stars
 (8.243 stars)
Métricas de merge de PR
 (Mesclagem média 2d 22h) (53 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Examine as duas páginas de documentação referenciadas e a implementação do controlador OpenAPI para entender como os arquivos padrão são servidos. Em seguida, adicione uma seção clara na documentação de uso do OpenAPI que mencione explicitamente a disponibilidade de openapi.json, openapi.yaml e openapi.yml no caminho OpenAPI configurado. Considere incluir uma nota para o recurso de importação de coleção do cliente Scalar API.
Pilha de tecnologia
pythonrest api
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with Litestar frameworkKnowledge of OpenAPI
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90