Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open

#2,067 创建于 2022年6月30日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)TypeScript (21,877 star) (2,272 fork)batch import
help wantedinvestigationp3

描述

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

贡献者指南

技术栈
typescript
领域
apidocumentation
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic understanding of OpenAPI/Swagger specs
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
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.