/
IApiDescriptionProvider.xml
196 lines (196 loc) · 14.2 KB
/
IApiDescriptionProvider.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<Type Name="IApiDescriptionProvider" FullName="Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider">
<TypeSignature Language="C++ CLI" Value="public interface class IApiDescriptionProvider" />
<TypeSignature Language="C#" Value="public interface IApiDescriptionProvider" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IApiDescriptionProvider" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider" />
<TypeSignature Language="VB.NET" Value="Public Interface IApiDescriptionProvider" />
<TypeSignature Language="F#" Value="type IApiDescriptionProvider = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IApiDescriptionProvider" FrameworkAlternate="aspnetcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="2.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="2.0.0.0" FrameworkAlternate="aspnetcore-2.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="2.1.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="2.1.0.0" FrameworkAlternate="aspnetcore-2.1" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="2.2.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="2.2.0.0" FrameworkAlternate="aspnetcore-2.2" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="3.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="3.0.0.0" FrameworkAlternate="aspnetcore-3.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="3.1.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="3.1.0.0" FrameworkAlternate="aspnetcore-3.1" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="5.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="5.0.0.0" FrameworkAlternate="aspnetcore-5.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="6.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="6.0.0.0" FrameworkAlternate="aspnetcore-6.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="7.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="7.0.0.0" FrameworkAlternate="aspnetcore-7.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="8.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="8.0.0.0" FrameworkAlternate="aspnetcore-8.0" />
</TypeForwardingChain>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Defines a contract for specifying <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription" /> instances.
</summary>
<remarks>
<para>
On the first query for <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor" />, MVC invokes all registered instances of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider" />
in the ascending sort order of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" />.
</para>
<para>
Each provider has its <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" /> method
called in sequence and given the same instance of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext" />. Then each
provider has its <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" /> method called in the reverse order. Each instance has
an opportunity to add or modify <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext.Results" />.
</para>
<para>
As providers are called in a predefined sequence, each provider has a chance to observe and decorate the
result of the providers that have already run.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="OnProvidersExecuted">
<MemberSignature Language="C++ CLI" Value="public:
 void OnProvidersExecuted(Microsoft::AspNetCore::Mvc::ApiExplorer::ApiDescriptionProviderContext ^ context);" />
<MemberSignature Language="C#" Value="public void OnProvidersExecuted (Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnProvidersExecuted(class Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" />
<MemberSignature Language="VB.NET" Value="Public Sub OnProvidersExecuted (context As ApiDescriptionProviderContext)" />
<MemberSignature Language="F#" Value="abstract member OnProvidersExecuted : Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext -> unit" Usage="iApiDescriptionProvider.OnProvidersExecuted context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext" />
</Parameters>
<Docs>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext" />.</param>
<summary>
Called after <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider" /> implementations with higher <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" /> values have been called.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnProvidersExecuting">
<MemberSignature Language="C++ CLI" Value="public:
 void OnProvidersExecuting(Microsoft::AspNetCore::Mvc::ApiExplorer::ApiDescriptionProviderContext ^ context);" />
<MemberSignature Language="C#" Value="public void OnProvidersExecuting (Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnProvidersExecuting(class Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" />
<MemberSignature Language="VB.NET" Value="Public Sub OnProvidersExecuting (context As ApiDescriptionProviderContext)" />
<MemberSignature Language="F#" Value="abstract member OnProvidersExecuting : Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext -> unit" Usage="iApiDescriptionProvider.OnProvidersExecuting context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext" />
</Parameters>
<Docs>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext" />.</param>
<summary>
Creates or modifies <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription" />s.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Order">
<MemberSignature Language="C++ CLI" Value="public:
 property int Order { int get(); };" />
<MemberSignature Language="C#" Value="public int Order { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Order" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Order As Integer" />
<MemberSignature Language="F#" Value="member this.Order : int" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the order value for determining the order of execution of providers. Providers execute in
ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" /> property.
</summary>
<value>To be added.</value>
<remarks>
<para>
Providers are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" /> property.
A provider with a lower numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" /> will have its
<see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" /> called before that of a provider with a higher numeric value of
<see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" />. The <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" /> method is called in the reverse ordering after
all calls to <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" />. A provider with a lower numeric value of
<see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" /> will have its <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)" /> method called after that of a provider
with a higher numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" />.
</para>
<para>
If two providers have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order" />, then their relative execution order
is undefined.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>