litestar-org/litestar

Docs: Add information on the default OpenAPI files available

Aberta

#3.941 aberto em 10 de jan. de 2025

Ver no GitHubGuia do colaborador
 (6 comentários) (0 reação) (0 responsável)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métricas do repositório

Stars
 (8.243 estrelas)
Métricas de merge de PR
 (Mesclagem média 13h 27m) (26 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
Revise a documentação OpenAPI atual em https://docs.litestar.dev/latest/usage/openapi e identifique onde adicionar uma seção clara sobre os endpoints de arquivo OpenAPI padrão (openapi.json, openapi.yaml, openapi.yml). Certifique se de mencionar sua disponibilidade e uso, por exemplo, para a importação de coleção do cliente Scalar API.
Pilha de tecnologia
python
Domain
backendapi
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.
1
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85