Redocly/redoc

Description of array items is not appeared on response.

Open

#1179 opened on Feb 19, 2020

View on GitHub
 (3 comments) (13 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

Description

I found that UI would not show the description of items with the referenced schema.

I think this had mentioned In #538, but not fixed?

What swagger-UI showed:

What redoc showed, which lack of description "bar schema description.":

I test it with redoc-cli version 0.9.4, and the example YAML:

openapi: "3.0.0"
info:
  title: test
  version: "0.0.0"
paths:
  /foo:
    get:
      summary: foo
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                description: array of bars
                type: array
                items:
                  $ref: "#/components/schemas/bar"
components:
  schemas:
    bar:
      description: bar schema description.
      type: object
      properties:
        name:
          type: string

Contributor guide

Tech stack
typescriptreact
Domain
documentationapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScriptOpenAPI/Swagger
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the component responsible for rendering array items in response schemas. Look at how the schema description is passed and displayed. Check issue #538 for previous discussion. The fix likely involves ensuring that the description field of array items schema is rendered in the UI. Reference the provided YAML example to reproduce the bug. Examine the relevant code in the repository, possibly in the schema rendering components.