Redocly/redoc

Array of enums ignores enum's schema description when rendered

Open

#905 opened on May 8, 2019

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

Description

Example array schema:

{
  "description": "Роли пользователя.",
  "items": {
    "description": "Роль пользователя.\n\n* `ROLE_DEVELOPER`. Разработчик (имеет все возможные права).\n* `ROLE_MANAGER`. Менеджер (на данный момент является синонимом слова \"админ\").\n* `ROLE_MEDICAL_REPRESENTATIVE`. Медицинский представитель.",
    "example": "ROLE_DEVELOPER",
    "title": "Role",
    "type": "string",
    "nullable": false,
    "readOnly": false,
    "writeOnly": false,
    "enum": [
      "ROLE_DEVELOPER",
      "ROLE_MANAGER",
      "ROLE_MEDICAL_REPRESENTATIVE"
    ]
  },
  "maxItems": 3,
  "minItems": 0,
  "uniqueItems": true,
  "type": "array",
  "nullable": false
}

That's how ReDoc renders it in response section:

image

That's how ReDoc renders it in parameters section:

image

As you may see, ReDoc ignores description of enum schema. I didn't tested how ReDoc renders it in request section, but I'm sure result will be the same as in response section.

Contributor guide

Tech stack
typescriptreact
Domain
documentation
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.
1-3 hours
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
Understand ReDoc schema rendering component structureBasic familiarity with OpenAPI/Swagger and enums
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate how ReDoc renders array items in both response and parameters sections. Likely the issue is in the rendering logic for enum arrays—the description from the items schema is not passed to the Enum component. Check files like src/components/Schema/SchemaSample.tsx or src/components/Schema/Enum.tsx (or similar) to trace where the item schema description is dropped. Look at the sample rendering preview shown in screenshots and compare with expected behavior. The fix would involve ensuring that when an array's items has an enum and a description, the description is displayed alongside the enum values.