描述

This is feature request.

Currently, redoc@2.0.0-rc.30 can show nullable: true field(s) on properties like below: This is great !!

I have API requests/responses that uses oneOf operator, and some of schemas used in oneOf is nullable: true like below:

   Foo:
      oneOf:
        - $ref: "#/components/schemas/Foo1"
        - $ref: "#/components/schemas/Foo2"
    Foo1:
      type: object
      properties: ...
    Foo2:
      type: object
      nullable: true
      properties: ...

I think this is valid schema definition to express object could be null, according to OpenAPI 3.0 specs.

OpenAPI 3.0 does not have an explicit null type as in JSON Schema, but you can use nullable: true to specify that the value may be null. https://swagger.io/docs/specification/data-models/data-types/#null

So, it would be great if ReDoc can render such objects as nullable.

UI Suggestions

Example OpenAPI file

openapi: "3.0.0"
info:
  version: "1.2.3"
  title: "My API"
paths:
  /foo:
    post:
      operationId: postFoo
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Foo"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Foo"
  /bar:
    post:
      operationId: postBar
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Foo2"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Foo2"

components:
  schemas:
    Foo:
      oneOf:
        - $ref: "#/components/schemas/Foo1"
        - $ref: "#/components/schemas/Foo2"
    Foo1:
      type: object
      properties:
        foo1:
          type: string
          nullable: true
        bar:
          type: object
          nullable: true
          properties:
            x:
              type: int
            y:
              type: int
    Foo2:
      type: object
      nullable: true
      properties:
        bar:
          type: string
          nullable: true

贡献者指南

技术栈: typescriptreact
领域: documentationdeveloper experience
议题类型: feature
难度: 3
预计时间: half day
活动状态: stale
清晰度: mostly clear
前置要求: OpenAPI 3.0 knowledgeTypeScriptReact basics
新手友好度: 30
研究方向: The issue requests nullable support in oneOf operator for ReDoc. The relevant source files likely include OpenAPI schema parsing and rendering components. The example OpenAPI file should be used to reproduce and understand the current behavior. The maintainers may have discussed approaches in the comments. A potential approach is to check how nullable is handled for regular properties and extend to oneOf schemas, possibly by modifying the schema component or adding a null option in the UI.