Share via

IApiDescriptionVisibilityProvider.IgnoreApi Property

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.ApiExplorer
Assembly:
Microsoft.AspNetCore.Mvc.Core.dll
Package:
Microsoft.AspNetCore.Mvc.Core v1.0.0
Package:
Microsoft.AspNetCore.Mvc.Core v1.1.0
Package:
Microsoft.AspNetCore.Mvc.Core v2.0.0
Package:
Microsoft.AspNetCore.Mvc.Core v2.1.0
Package:
Microsoft.AspNetCore.Mvc.Core 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

If true then no ApiDescription objects will be created for the associated controller or action.

public:
 property bool IgnoreApi { bool get(); };
public bool IgnoreApi { get; }
member this.IgnoreApi : bool
Public ReadOnly Property IgnoreApi As Boolean

Property Value

Boolean

Applies to