Redocly/redoc

Type: Array and nullable: true does not render nullable

Open

#1 155 ouverte le 9 janv. 2020

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)TypeScript (2 272 forks)batch import
Type: Bughelp 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 have a response which either returns an array or null. I specify the return json schema with:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "array",
    "uniqueItems": true,
    "items": {
      ....
    }
  "nullable": true
}

But redoc does not render this like for other types e.g. integers.

I currently use the following workaround:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "oneOf": [
    {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "../shared/id.json#"
      }
    },
    {
      "type": "any"
      "nullable":true
    }
  ]
}

grafik

Guide contributeur

Direction de recherche
Étudiez comment Redoc rend nullable pour les types non tableaux (ex. : entiers) en examinant le code source, probablement dans le composant Schema. Le problème montre que nullable: true n'est pas appliqué lorsque le type est tableau. Cherchez où l'annotation nullable est ajoutée à la sortie rendue et assurez vous qu'elle gère le type tableau. Le contournement utilisant oneOf suggère que la logique de rendu ne vérifie peut être pas nullable pour les tableaux. Référez vous à l'issue #1155 et à tout commentaire de code associé.
Stack technique
typescript
Domaine
documentation
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
TypeScriptJSON Schema
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75