Redocly/redoc

Description of array items is not appeared on response.

Open

#1.179 geöffnet am 19. Feb. 2020

Auf GitHub ansehen
 (3 Kommentare) (13 Reaktionen) (0 zugewiesene Personen)TypeScript (2.272 Forks)batch import
Type: Enhancementhelp wanted

Repository-Metriken

Stars
 (21.877 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuchen Sie, wie Redoc das `description` Feld für Array Elemente in OpenAPI Schemata verarbeitet, insbesondere bei Verwendung von `$ref`. Das Problem liegt wahrscheinlich in der Schema Rendering Komponente, die die Beschreibung des referenzierten Schemas nicht an Array Elemente weitergibt.
Tech Stack
typescriptreact
Domain
apidocumentationfrontend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptTypeScriptReactOpenAPI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60