Property or indexer 'IOpenApiMediaType.Example' cannot be assigned to -- it is read only

[jacobrillema]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Latest dotnet SDK 10, running on macOS M1/ARM. Getting this build error.

net10.0/generated/Microsoft.AspNetCore.OpenApi.SourceGenerators/Microsoft.AspNetCore.OpenApi.SourceGenerators.XmlCommentGenerator/OpenApiXmlCommentSupport.generated.cs(399,41): error CS0200: Property or indexer 'IOpenApiMediaType.Example' cannot be assigned to -- it is read only

Happened after I upgraded this morning. This is the error of code in the generated file

foreach (var mediaType in content)
{
mediaType.Example = jsonString.Parse();
}

Expected Behavior

No response

Steps To Reproduce

No response

Exceptions (if any)

No response

.NET Version

No response

Anything else?

No response

[martincostello]

Did you upgrade to Microsoft.OpenApi 3.0.0?

It isn't compatible with ASP.NET Core 10 unfortunately due to various breaking changes made (upgrade guide), you need to use a version of 2.x.

[jacobrillema]

@martincostello ah yes I did, sorry I didn't realize that. Thanks for the quick feedback! So we are early green field project still. What is the path to using Open API 3.2+ with ASP.NET Core 10?

[martincostello]

As far as I'm aware, I'm afraid there isn't one. OpenAPI 3.2 won't be available to use with Microsoft.AspNetCore.OpenApi until .NET 11.

[baywet]

out of curiosity @jacobrillema was the upgrade of Microsoft.OpenAPI to v3 triggered manually (Visual Studio UI, dotnet CLI, or similar), or through some kind of bot (like dependabot)?

[jacobrillema]

Hi @baywet, pretty sure dotnet outdated did not update it. The change occurred while working with vscode via the Directory.Packages.prop file. There is the ability to see what packages are not the current, and you can upgrade packages from there. I noticed Microsoft.OpenApi 3.0.0 was available so I updated do it.

[baywet]

Thank you for the additional information.
I've never used that UI, does it also give you the change notes? or simply the version indicator?