Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OpenAPI] generates invalid reference for a type #61039

Closed
1 task done
petarvukmirovic opened this issue Mar 20, 2025 · 1 comment
Closed
1 task done

[OpenAPI] generates invalid reference for a type #61039

petarvukmirovic opened this issue Mar 20, 2025 · 1 comment
Labels
area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc feature-openapi

Comments

@petarvukmirovic
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

Given these two classes:

public class NestedPropertyClass
{
    public required string PropertyA { get; init; }
    public required string PropertyB { get; init; }
}

public class TopLevelPropertyClass
{
    public required int IntProp { get; init; }
    public required string StringPropA { get; init; }
    public required string StringPropB { get; init; }
    public required IEnumerable<NestedPropertyClass> NestedPropA { get; init; }
    public required IEnumerable<NestedPropertyClass> NestedPropB { get; init; }
}

OpenAPI will generate the following type definition:

...
"TopLevelPropertyClass": {
      "required": [
        "intProp",
        "stringPropA",
        "stringPropB",
        "nestedPropA",
        "nestedPropB"
      ],
      "type": "object",
      "properties": {
        "intProp": {
          "format": "int32",
          "type": "integer"
        },
        "stringPropA": {
          "type": "string"
        },
        "stringPropB": {
          "type": "string"
        },
        "nestedPropA": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/NestedPropertyClass"
          }
        },
        "nestedPropB": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/#/properties/nestedPropA/items"
          }
        }
      }
    },
...

Notably, nestedPropB will have an inavlid reference string which is different
from the one generated for nestedPropA, and different from expected type
#/definitions/NestedPropertyClass.

Is there a workaround to force OpenAPI to generate
type reference #/definitions/NestedPropertyClass?

Expected Behavior

I expect nestedPropB to have the same type as nestedPropA (#/definitions/NestedPropertyClass).

Steps To Reproduce

Use these classes, add them to a controller and request OpenAPI generation endpoint.

Exceptions (if any)

N/A

.NET Version

9.0.1

Anything else?

.NET SDK:
Version: 9.0.102
Commit: cb83cd4923
Workload version: 9.0.100-manifests.4a54b1a6
MSBuild version: 17.12.18+ed8c6aec5

Runtime Environment:
OS Name: Windows
OS Version: 10.0.22000
OS Platform: Windows
RID: win-x64
Base Path: C:\Program Files\dotnet\sdk\9.0.102\

.NET workloads installed:
[aspire]
Installation Source: VS 17.12.35707.178
Manifest Version: 8.2.2/8.0.100
Manifest Path: C:\Program Files\dotnet\sdk-manifests\8.0.100\microsoft.net.sdk.aspire\8.2.2\WorkloadManifest.json
Install Type: Msi

Configured to use loose manifests when installing new manifests.

Host:
Version: 9.0.1
Architecture: x64
Commit: c8acea2262

.NET SDKs installed:
6.0.428 [C:\Program Files\dotnet\sdk]
8.0.406 [C:\Program Files\dotnet\sdk]
9.0.102 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
Microsoft.AspNetCore.App 6.0.36 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 7.0.20 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 8.0.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 8.0.13 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 9.0.1 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 6.0.36 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 7.0.20 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 8.0.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 8.0.13 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 9.0.1 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 6.0.36 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 7.0.20 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 8.0.12 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 8.0.13 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 9.0.1 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
x86 [C:\Program Files (x86)\dotnet]
registered at [HKLM\SOFTWARE\dotnet\Setup\InstalledVersions\x86\InstallLocation]

Environment variables:
Not set

global.json file:
Not found

@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Mar 20, 2025
@martincostello martincostello added feature-openapi area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Mar 20, 2025
@petarvukmirovic petarvukmirovic changed the title OpenAPI generates invalid reference for a type [OpenAPI] generates invalid reference for a type Mar 20, 2025
@captainsafia
Copy link
Member

@petarvukmirovic Thanks for filing this issue!

I believe what you are seeing is a dupe of #60339. A bug fix for this will ship as part of 9.0.400.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc feature-openapi
Projects
None yet
Development

No branches or pull requests

3 participants