Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open

#2.067 aberto em 30 de jun. de 2022

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (2.272 forks)batch import
help wantedinvestigationp3

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Mesclagem média 3h 40m) (11 fundiu PRs em 30d)

Description

I've created an issue Mermade/oas-kit#597 over at swagger2openapi regarding an anomaly with converting field descriptions on swagger 2.0 documents.

I wanted to lodge it here as well in the advent of a fix.

The the descriptions on fields for complex objects are overwritten with the description of the object definition itself, and losing context for the user e.g. instead of displaying "The weight (in kg)..." and "The volume (in m3)..." of a reusable measurement object definition, it displays "A generic measurement." for both fields.

image

(I'll come back to update this as the issue progresses, if this is the right way to handle things?)

Guia do colaborador

Direção de pesquisa
Investigue o problema de dependência upstream Mermade/oas kit#597 para entender como o swagger2openlayers perde descrições. Em seguida, rastreie como o Redoc processa descrições de especificações convertidas, focando na lógica de exibição para objetos complexos. Verifique se o Redoc pode contornar o bug upstream preservando descrições do documento Swagger original ou aplicando um patch.
Pilha de tecnologia
typescript
Domain
documentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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
OpenAPIJavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60