Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open

#2067 opened on Jun 30, 2022

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
help wantedinvestigationp3

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

Contributor guide

Tech stack
typescript
Domain
apidocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic understanding of OpenAPI/Swagger specs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the upstream dependency issue Mermade/oas kit#597 to understand how swagger2openlayers loses descriptions. Then trace how Redoc processes descriptions from converted specs, focusing on the display logic for complex objects. Check if Redoc can work around the upstream bug by preserving descriptions from the original Swagger document or by applying a patch.