Redocly/redoc

Type: Array and nullable: true does not render nullable

Open

#1,155 opened on Jan 9, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (2,272 forks)batch import
Type: Bughelp wanted

Repository metrics

Stars
 (21,877 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Contributor guide

Research direction
Investigate how Redoc handles the nullable property combined with type: array in JSON Schema. Look at the schema processing code, particularly where nullable is checked and rendered for different types. Compare with how nullable works for primitive types like integer. The workaround using oneOf suggests the rendering logic may not correctly infer nullability for arrays.
Tech stack
typescript
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75