IApiDescriptionProvider.Order Property

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.ApiExplorer
Assembly:
Microsoft.AspNetCore.Mvc.ApiExplorer.dll
Assembly:
Microsoft.AspNetCore.Mvc.Abstractions.dll
Package:
Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0
Package:
Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.0.0
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
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
IApiDescriptionProvider.cs

Gets the order value for determining the order of execution of providers. Providers execute in ascending numeric value of the Order property.

public:
 property int Order { int get(); };
public int Order { get; }
member this.Order : int
Public ReadOnly Property Order As Integer

Property Value

Int32

Remarks

Providers are executed in an ordering determined by an ascending sort of the Order property. A provider with a lower numeric value of Order will have its OnProvidersExecuting(ApiDescriptionProviderContext) called before that of a provider with a higher numeric value of Order. The OnProvidersExecuted(ApiDescriptionProviderContext) method is called in the reverse ordering after all calls to OnProvidersExecuting(ApiDescriptionProviderContext). A provider with a lower numeric value of Order will have its OnProvidersExecuted(ApiDescriptionProviderContext) method called after that of a provider with a higher numeric value of Order.

If two providers have the same numeric value of Order, then their relative execution order is undefined.

Applies to