Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

OpenApiOptions.CreateSchemaReferenceId Property

Definition

Namespace:
Microsoft.AspNetCore.OpenApi
Assembly:
Microsoft.AspNetCore.OpenApi.dll
Package:
Microsoft.AspNetCore.OpenApi v10.0.0
Package:
Microsoft.AspNetCore.OpenApi v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.OpenApi v9.0.8
Source:
OpenApiOptions.cs
Source:
OpenApiOptions.cs
Source:
OpenApiOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A delegate to determine how reference IDs should be created for schemas associated with types in the given OpenAPI document.

public Func<System.Text.Json.Serialization.Metadata.JsonTypeInfo,string?> CreateSchemaReferenceId { get; set; }
member this.CreateSchemaReferenceId : Func<System.Text.Json.Serialization.Metadata.JsonTypeInfo, string> with get, set
Public Property CreateSchemaReferenceId As Func(Of JsonTypeInfo, String)

Property Value

Remarks

The default implementation uses the CreateDefaultSchemaReferenceId(JsonTypeInfo) method to generate reference IDs. When the provided delegate returns null, the schema associated with the JsonTypeInfo will always be inlined.

Applies to


Feedback

Was this page helpful?