Note

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

Access to this page requires authorization. You can try .

OpenApiRouteHandlerBuilderExtensions.ProducesValidationProblem Method

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Routing.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8

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

ProducesValidationProblem(RouteHandlerBuilder, Int32, String)

Source:
OpenApiRouteHandlerBuilderExtensions.cs

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

statusCode
Int32

The response status code. Defaults to Status400BadRequest.

contentType
String

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

Returns

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

Applies to

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.

Applies to


Feedback

Was this page helpful?