-
Notifications
You must be signed in to change notification settings - Fork 112
/
CompatibilityVersion.xml
265 lines (263 loc) · 15.5 KB
/
CompatibilityVersion.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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<Type Name="CompatibilityVersion" FullName="Microsoft.AspNetCore.Mvc.CompatibilityVersion">
<TypeSignature Language="C++ CLI" Value="public enum class CompatibilityVersion" />
<TypeSignature Language="C#" Value="public enum CompatibilityVersion" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed CompatibilityVersion extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.CompatibilityVersion" />
<TypeSignature Language="VB.NET" Value="Public Enum CompatibilityVersion" />
<TypeSignature Language="F#" Value="type CompatibilityVersion = " />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.", DiagnosticId="ASP5001", UrlFormat="https://aka.ms/aspnetcore-warnings/{0}")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.", DiagnosticId="ASP5001", UrlFormat="https://aka.ms/aspnetcore-warnings/{0}")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Specifies the version compatibility of runtime behaviors configured by <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions" />.
</summary>
<remarks>
<para>
The best way to set a compatibility version is by using
<see cref="M:Microsoft.Extensions.DependencyInjection.MvcCoreMvcBuilderExtensions.SetCompatibilityVersion(Microsoft.Extensions.DependencyInjection.IMvcBuilder,Microsoft.AspNetCore.Mvc.CompatibilityVersion)" /> or
<see cref="M:Microsoft.Extensions.DependencyInjection.MvcCoreMvcCoreBuilderExtensions.SetCompatibilityVersion(Microsoft.Extensions.DependencyInjection.IMvcCoreBuilder,Microsoft.AspNetCore.Mvc.CompatibilityVersion)" /> in your application's
<c>ConfigureServices</c> method.
<example>
Setting the compatibility version using <see cref="T:Microsoft.Extensions.DependencyInjection.IMvcBuilder" />:
<code>
public class Startup
{
...
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_3_0);
}
...
}
</code></example></para>
<para>
Setting compatibility version to a specific version will change the default values of various
settings to match a particular minor release of ASP.NET Core MVC.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="Latest">
<MemberSignature Language="C++ CLI" Value="Latest" />
<MemberSignature Language="C#" Value="Latest" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.AspNetCore.Mvc.CompatibilityVersion Latest = int32(2147483647)" />
<MemberSignature Language="DocId" Value="F:Microsoft.AspNetCore.Mvc.CompatibilityVersion.Latest" />
<MemberSignature Language="VB.NET" Value="Latest" />
<MemberSignature Language="F#" Value="Latest = 2147483647" Usage="Microsoft.AspNetCore.Mvc.CompatibilityVersion.Latest" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Mvc.CompatibilityVersion</ReturnType>
</ReturnValue>
<MemberValue>2147483647</MemberValue>
<Docs>
<summary>
Sets the default value of settings on <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions" /> to match the latest release. Use this
value with care, upgrading minor versions will cause breaking changes when using <see cref="F:Microsoft.AspNetCore.Mvc.CompatibilityVersion.Latest" />.
</summary>
</Docs>
</Member>
<Member MemberName="Version_2_0">
<MemberSignature Language="C++ CLI" Value="Version_2_0" />
<MemberSignature Language="C#" Value="Version_2_0" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.AspNetCore.Mvc.CompatibilityVersion Version_2_0 = int32(0)" />
<MemberSignature Language="DocId" Value="F:Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_0" />
<MemberSignature Language="VB.NET" Value="Version_2_0" />
<MemberSignature Language="F#" Value="Version_2_0 = 0" Usage="Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_0" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete. The recommended alternatives are Version_3_0 or later.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete. The recommended alternatives are Version_3_0 or later.")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Mvc.CompatibilityVersion</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>
Sets the default value of settings on <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions" /> to match the behavior of
ASP.NET Core MVC 2.0.
</summary>
</Docs>
</Member>
<Member MemberName="Version_2_1">
<MemberSignature Language="C++ CLI" Value="Version_2_1" />
<MemberSignature Language="C#" Value="Version_2_1" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.AspNetCore.Mvc.CompatibilityVersion Version_2_1 = int32(1)" />
<MemberSignature Language="DocId" Value="F:Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_1" />
<MemberSignature Language="VB.NET" Value="Version_2_1" />
<MemberSignature Language="F#" Value="Version_2_1 = 1" Usage="Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_1" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete. The recommended alternatives are Version_3_0 or later.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete. The recommended alternatives are Version_3_0 or later.")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Mvc.CompatibilityVersion</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>
Sets the default value of settings on <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions" /> to match the behavior of
ASP.NET Core MVC 2.1.
</summary>
<remarks>
ASP.NET Core MVC 2.1 introduced a compatibility switch for
<c>MvcJsonOptions.AllowInputFormatterExceptionMessages</c>. This is now a regular property.
</remarks>
</Docs>
</Member>
<Member MemberName="Version_2_2">
<MemberSignature Language="C++ CLI" Value="Version_2_2" />
<MemberSignature Language="C#" Value="Version_2_2" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.AspNetCore.Mvc.CompatibilityVersion Version_2_2 = int32(2)" />
<MemberSignature Language="DocId" Value="F:Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_2" />
<MemberSignature Language="VB.NET" Value="Version_2_2" />
<MemberSignature Language="F#" Value="Version_2_2 = 2" Usage="Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_2" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete. The recommended alternatives are Version_3_0 or later.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete. The recommended alternatives are Version_3_0 or later.")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Mvc.CompatibilityVersion</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>
Sets the default value of settings on <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions" /> to match the behavior of
ASP.NET Core MVC 2.2.
</summary>
<remarks>
ASP.NET Core MVC 2.2 introduced compatibility switches for the following:
<list type="bullet"><item><description><c>ApiBehaviorOptions.SuppressMapClientErrors</c></description></item><item><description><see cref="P:Microsoft.AspNetCore.Mvc.MvcOptions.EnableEndpointRouting" /></description></item><item><description><see cref="P:Microsoft.AspNetCore.Mvc.MvcOptions.MaxValidationDepth" /></description></item></list>
All of the above are now regular properties.
</remarks>
</Docs>
</Member>
<Member MemberName="Version_3_0">
<MemberSignature Language="C++ CLI" Value="Version_3_0" />
<MemberSignature Language="C#" Value="Version_3_0" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.AspNetCore.Mvc.CompatibilityVersion Version_3_0 = int32(3)" />
<MemberSignature Language="DocId" Value="F:Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_3_0" />
<MemberSignature Language="VB.NET" Value="Version_3_0" />
<MemberSignature Language="F#" Value="Version_3_0 = 3" Usage="Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_3_0" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("This CompatibilityVersion value is obsolete.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This CompatibilityVersion value is obsolete.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Mvc.CompatibilityVersion</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>
Sets the default value of settings on <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions" /> and other <c>Options</c> types to match
the behavior of ASP.NET Core MVC 3.0.
</summary>
</Docs>
</Member>
</Members>
</Type>