How to refer to enclosing type definition recursively in OpenAPI / Swagger?

Question

I\'m writing an OpenAPI definition in Swagger Editor.

One of my type definitions contains an array containing child elements of the same type as the parent. I.e. somethi

Answer 1

Your definition is perfectly fine. It's a known issue issue with rendering recursive schemas in Swagger Editor and Swagger UI:

https://github.com/swagger-api/swagger-ui/issues/3325

To work around the null/undefined values in the "Example Value", you can add a custom example to your schema:

definitions:
  TreeNode:
    type: object
    properties:
      name:
        type: string
        description: The name of the tree node.
      children:
        type: array
        items:
          $ref: '#/definitions/TreeNode'
    example:
      name: foo
      children:
        - name: bar
        - name: baz
          children:
            - name: qux