Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open

#2067 aperta il 30 giu 2022

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)TypeScript (2272 fork)batch import
help wantedinvestigationp3

Metriche repository

Star
 (21.877 star)
Metriche merge PR
 (Merge medio 3h 40m) (11 PR mergiate in 30 g)

Descrizione

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?)

Guida contributor

Direzione di ricerca
Indaga sul problema della dipendenza upstream Mermade/oas kit#597 per capire come swagger2openlayers perda le descrizioni. Quindi traccia come Redoc elabora le descrizioni dalle specifiche convertite, concentrandosi sulla logica di visualizzazione per oggetti complessi. Verifica se Redoc può aggirare il bug upstream preservando le descrizioni dal documento Swagger originale o applicando una patch.
Tech stack
typescript
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
OpenAPIJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60