Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

开放

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

 (1 条评论) (2 个反应) (0 位负责人)TypeScript (2,272 个派生)batch import
help wantedinvestigationp3

仓库指标

星标
 (21,877 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南