OpenAPI: ICollection should generate as readOnly:true but does not.

[niemyjski]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Not in the sample but public ICollection OAuthAccounts { get; } = new Collection(); should generate readOnly: true but does not.

Expected Behavior

These should just work out of the box.

Steps To Reproduce

Clone https://github.com/exceptionless/aspnet-core-net10-issues# and run it, hit the open api json endpoint.

Exceptions (if any)

No response

.NET Version

10 preview 6

Anything else?

MacOS Latest, Rider/VS Code

#62150

[martincostello]

Not in the sample but public ICollection OAuthAccounts { get; } = new Collection(); should generate readOnly: true but does not.

I'm not sure whether this would be correct behaviour or not. While the C# model inside your application may be a read-only property, the OpenAPI specification isn't intended to be a full mirror of your C# object model as it is language agnostic.

From the OpenAPI specification, the intention is that the value indicates whether the property supports being specified in a write operation (e.g. a POST) or not.

Relevant only for Schema Object properties definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.

What is the use case for this model (as it's not in your sample repro)?