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.
External dependency: swagger2openapi loses descriptions on complex objects · Redocly/redoc#2067 | Good First Issue