OpenApiRouteHandlerBuilderExtensions.ProducesValidationProblem Method

Definition

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Routing.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Overloads

ProducesValidationProblem(RouteHandlerBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by builder.
ProducesValidationProblem<TBuilder>(TBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by builder.

ProducesValidationProblem(RouteHandlerBuilder, Int32, String)

Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by builder.

public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder ProducesValidationProblem (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder, int statusCode = 400, string? contentType = default);

static member ProducesValidationProblem : Microsoft.AspNetCore.Builder.RouteHandlerBuilder * int * string -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder

<Extension()>
Public Function ProducesValidationProblem (builder As RouteHandlerBuilder, Optional statusCode As Integer = 400, Optional contentType As String = Nothing) As RouteHandlerBuilder

Parameters

builder

RouteHandlerBuilder

The RouteHandlerBuilder.

statusCode

Int32

The response status code. Defaults to Status400BadRequest.

contentType

String

The response content type. Defaults to "application/problem+json".

Returns

RouteHandlerBuilder

A RouteHandlerBuilder that can be used to further customize the endpoint.

ProducesValidationProblem<TBuilder>(TBuilder, Int32, String)

Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by builder.

public static TBuilder ProducesValidationProblem<TBuilder> (this TBuilder builder, int statusCode = 400, string? contentType = default) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

static member ProducesValidationProblem : 'Builder * int * string -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)

<Extension()>
Public Function ProducesValidationProblem(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, Optional statusCode As Integer = 400, Optional contentType As String = Nothing) As TBuilder

Type Parameters

TBuilder

Parameters

builder

TBuilder

The IEndpointConventionBuilder.

statusCode

Int32

The response status code. Defaults to Status400BadRequest.

contentType

String

The response content type. Defaults to "application/problem+json".

Returns

TBuilder

A IEndpointConventionBuilder that can be used to further customize the endpoint.