Redocly/redoc

Description of array items is not appeared on response.

Open

#1 179 ouverte le 19 févr. 2020

Voir sur GitHub
 (3 commentaires) (13 réactions) (0 assignés)TypeScript (2 272 forks)batch import
Type: Enhancementhelp wanted

Métriques du dépôt

Stars
 (21 877 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Examinez comment Redoc traite le champ `description` pour les éléments de tableau dans les schémas OpenAPI, en particulier lors de l'utilisation de `$ref`. Le problème réside probablement dans le composant de rendu du schéma qui ne propage pas la description du schéma référencé pour les éléments de tableau.
Stack technique
typescriptreact
Domaine
apidocumentationfrontend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptTypeScriptReactOpenAPI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60