Redocly/redoc

Type: Array and nullable: true does not render nullable

Open

#1.155 geöffnet am 9. Jan. 2020

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)TypeScript (2.272 Forks)batch import
Type: Bughelp wanted

Repository-Metriken

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

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche, wie Redoc nullable für Nicht Array Typen (z. B. Ganzzahlen) rendert, indem du den Quellcode überprüfst, wahrscheinlich in der Schema Komponente. Das Problem zeigt, dass nullable: true nicht angewendet wird, wenn der Typ array ist. Suche nach der Stelle, an der die nullable Annotation zur gerenderten Ausgabe hinzugefügt wird, und stelle sicher, dass sie den Array Typ behandelt. Der Workaround mit oneOf deutet darauf hin, dass die Rendering Logik nullable für Arrays möglicherweise nicht prüft. Siehe Issue #1155 und verwandte Codekommentare.
Tech Stack
typescript
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
TypeScriptJSON Schema
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75