Redocly / Redocly/redoc

External dependency: swagger2openapi loses descriptions on complex objects

Open
#2,067 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted investigation p3
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Mermade/oas-kit#597 issue and the conversion behavior described here; no Redoc file or test is named in the report. Done would mean the field descriptions for complex objects retain their own context instead of being replaced by the object definition description, with the fix reflected in Redoc.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.