ApiResponseType.IsDefaultResponse Property

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:: Microsoft.AspNetCore.Mvc.Abstractions.dll

Package:: Microsoft.AspNetCore.Mvc.Abstractions v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Abstractions v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

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

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

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

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

Source:: ApiResponseType.cs

Source:: ApiResponseType.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.

Gets or sets a value indicating whether the response type represents a default response.

public:
 property bool IsDefaultResponse { bool get(); void set(bool value); };

public bool IsDefaultResponse { get; set; }

member this.IsDefaultResponse : bool with get, set

Public Property IsDefaultResponse As Boolean

Property Value

Boolean

Remarks

If an ApiDescription has a default response, then the StatusCode property should be ignored. This response will be used when a more specific response format does not apply. The common use of a default response is to specify the format for communicating error conditions.

Applies to