OpenApiOptions.AddSchemaTransformer Method
Definition
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.
Overloads
| AddSchemaTransformer(IOpenApiSchemaTransformer) |
Registers a given instance of IOpenApiOperationTransformer on the current OpenApiOptions instance. |
| AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>) |
Registers a given delegate as a schema transformer on the current OpenApiOptions instance. |
| AddSchemaTransformer<TTransformerType>() |
Registers a new schema transformer on the current OpenApiOptions instance. |
AddSchemaTransformer(IOpenApiSchemaTransformer)
- Source:
- OpenApiOptions.cs
Registers a given instance of IOpenApiOperationTransformer on the current OpenApiOptions instance.
public Microsoft.AspNetCore.OpenApi.OpenApiOptions AddSchemaTransformer (Microsoft.AspNetCore.OpenApi.IOpenApiSchemaTransformer transformer);member this.AddSchemaTransformer : Microsoft.AspNetCore.OpenApi.IOpenApiSchemaTransformer -> Microsoft.AspNetCore.OpenApi.OpenApiOptionsPublic Function AddSchemaTransformer (transformer As IOpenApiSchemaTransformer) As OpenApiOptionsParameters
- transformer
- IOpenApiSchemaTransformer
The IOpenApiOperationTransformer instance to use.
Returns
The OpenApiOptions instance for further customization.
Applies to
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)
- Source:
- OpenApiOptions.cs
Registers a given delegate as a schema transformer on the current OpenApiOptions instance.
public Microsoft.AspNetCore.OpenApi.OpenApiOptions AddSchemaTransformer (Func<Microsoft.OpenApi.Models.OpenApiSchema,Microsoft.AspNetCore.OpenApi.OpenApiSchemaTransformerContext,System.Threading.CancellationToken,System.Threading.Tasks.Task> transformer);member this.AddSchemaTransformer : Func<Microsoft.OpenApi.Models.OpenApiSchema, Microsoft.AspNetCore.OpenApi.OpenApiSchemaTransformerContext, System.Threading.CancellationToken, System.Threading.Tasks.Task> -> Microsoft.AspNetCore.OpenApi.OpenApiOptionsPublic Function AddSchemaTransformer (transformer As Func(Of OpenApiSchema, OpenApiSchemaTransformerContext, CancellationToken, Task)) As OpenApiOptionsParameters
The delegate representing the schema transformer.
Returns
The OpenApiOptions instance for further customization.
Applies to
AddSchemaTransformer<TTransformerType>()
- Source:
- OpenApiOptions.cs
Registers a new schema transformer on the current OpenApiOptions instance.
public Microsoft.AspNetCore.OpenApi.OpenApiOptions AddSchemaTransformer<TTransformerType> () where TTransformerType : Microsoft.AspNetCore.OpenApi.IOpenApiSchemaTransformer;member this.AddSchemaTransformer : unit -> Microsoft.AspNetCore.OpenApi.OpenApiOptions (requires 'ransformerType :> Microsoft.AspNetCore.OpenApi.IOpenApiSchemaTransformer)Public Function AddSchemaTransformer(Of TTransformerType As IOpenApiSchemaTransformer) () As OpenApiOptionsType Parameters
- TTransformerType
The type of the IOpenApiSchemaTransformer to instantiate.
Returns
The OpenApiOptions instance for further customization.