Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open

#2,067 opened on 2022年6月30日

GitHub で見る
 (1 comment) (2 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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