Problem with recursive

[PolarTango]

Description

when i'm trying to define class:

public record Item
{
public Item? TopItem;
public IEnumerable? SubItems;
}

openapi definition is:
"Item": {
"type": "object"
},

dot

Page URL

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/aspnetcore-openapi?view=aspnetcore-9.0&tabs=visual-studio%2Cvisual-studio-code

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/fundamentals/openapi/aspnetcore-openapi.md

Document ID

27bad30c-e0b4-10fb-b202-a29d4f8fad24

Platform Id

11e029f8-4c25-d943-fe65-31bfcaf35e2b

Article author

@captainsafia

Metadata

• ID: 27bad30c-e0b4-10fb-b202-a29d4f8fad24
• PlatformId: 11e029f8-4c25-d943-fe65-31bfcaf35e2b
• Service: aspnet-core
• Sub-service: fundamentals

Related Issues

[timdeschryver]

I think this isn't a documentation issue, or did you find that example in the docs?
To fix this, the class properties should be getters for the OpenAPI to pick it up correctly.

public record Item()
{
public Item? TopItem { get;  }
public IEnumerable<Item>? SubItems { get;  }
}

Or, you can use the shorthand syntax:

public record Item(Item? TopItem, IEnumerable<Item>? SubItems);

[PolarTango]

Sorry, my fold about getters, but my main question was about definition of:

1. "topItem": is it possible to set it as nullable in openapi doc
2. "subItems": it can't be interpreted in auto generate openapi client (I've tried "dotnet openapi" and "refitter" for that)

      "Item": {
        "type": "object",
        "properties": {
          "topItem": {
            "$ref": "#/components/schemas/Item"
          },
          "subItems": {
            "$ref": "#/components/schemas/#/properties/topItem/properties/subItems"
          }
        }
      }

[timdeschryver]

Have you tried updating to the latest version @PolarTango ?
It seems this is resolved in dotnet/aspnetcore#60339

For me the document looks correct:

  "components": {
    "schemas": {
      "Item": {
        "type": "object",
        "properties": {
          "topItem": {
            "$ref": "#/components/schemas/Item"
          },
          "subItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Item"
            },
            "nullable": true
          }
        }
      }
    }
  },

[guardrex]

Thanks @timdeschryver!

@PolarTango, we don't have too many eyes on our issues here because we mostly just work on documentation issues on this repo. There aren't many product support discussions taking place here. Try public support channels for general development questions. We recommend the usual places ...

• Stack Overflow
• ASP.NET Core Slack
• ASP.NET Gitter