Redocly/redoc

Type: Array and nullable: true does not render nullable

Open

#1,155 建立於 2020年1月9日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)TypeScript (21,877 star) (2,272 fork)batch import
Type: Bughelp wanted

描述

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

貢獻者指南

技術棧
typescriptreact
領域
documentationfrontendapi
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JSON Schema knowledgeReact basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Investigate how Redoc renders nullable for non array types (e.g., integers) by examining the source code, likely in the Schema component. The issue shows that nullable: true is not applied when type is array. Look for where the nullable annotation is added to the rendered output and ensure it handles array type. The workaround using oneOf suggests that the rendering logic may not check nullable for arrays. Refer to issue #1155 and any related code comments.