Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open

#2.067 geöffnet am 30. Juni 2022

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)TypeScript (2.272 Forks)batch import
help wantedinvestigationp3

Repository-Metriken

Stars
 (21.877 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche das Upstream Abhängigkeitsproblem Mermade/oas kit#597, um zu verstehen, wie swagger2openlayers Beschreibungen verliert. Verfolge dann, wie Redoc Beschreibungen aus konvertierten Spezifikationen verarbeitet, mit Fokus auf die Anzeigelogik für komplexe Objekte. Prüfe, ob Redoc den Upstream Bug umgehen kann, indem Beschreibungen aus dem ursprünglichen Swagger Dokument beibehalten oder ein Patch angewendet wird.
Tech Stack
typescript
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
OpenAPIJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60