OpenApiRouteHandlerBuilderExtensions.ProducesValidationProblem Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

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.

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.

Applies to