-
Notifications
You must be signed in to change notification settings - Fork 112
/
ApiResponseType.xml
299 lines (299 loc) · 18.6 KB
/
ApiResponseType.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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<Type Name="ApiResponseType" FullName="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType">
<TypeSignature Language="C++ CLI" Value="public ref class ApiResponseType" />
<TypeSignature Language="C#" Value="public class ApiResponseType" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ApiResponseType extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType" />
<TypeSignature Language="VB.NET" Value="Public Class ApiResponseType" />
<TypeSignature Language="F#" Value="type ApiResponseType = class" />
<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>
<AssemblyVersion>9.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" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="9.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="9.0.0.0" FrameworkAlternate="aspnetcore-9.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Possible type of the response body which is formatted by <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ApiResponseFormats" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 ApiResponseType();" />
<MemberSignature Language="C#" Value="public ApiResponseType ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApiResponseFormats">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IList<Microsoft::AspNetCore::Mvc::ApiExplorer::ApiResponseFormat ^> ^ ApiResponseFormats { System::Collections::Generic::IList<Microsoft::AspNetCore::Mvc::ApiExplorer::ApiResponseFormat ^> ^ get(); void set(System::Collections::Generic::IList<Microsoft::AspNetCore::Mvc::ApiExplorer::ApiResponseFormat ^> ^ value); };" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat> ApiResponseFormats { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat> ApiResponseFormats" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ApiResponseFormats" />
<MemberSignature Language="VB.NET" Value="Public Property ApiResponseFormats As IList(Of ApiResponseFormat)" />
<MemberSignature Language="F#" Value="member this.ApiResponseFormats : System.Collections.Generic.IList<Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat> with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ApiResponseFormats" />
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(1)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[set: System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the response formats supported by this type.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsDefaultResponse">
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsDefaultResponse { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool IsDefaultResponse { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsDefaultResponse" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.IsDefaultResponse" />
<MemberSignature Language="VB.NET" Value="Public Property IsDefaultResponse As Boolean" />
<MemberSignature Language="F#" Value="member this.IsDefaultResponse : bool with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.IsDefaultResponse" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</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>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether the response type represents a default response.
</summary>
<value>To be added.</value>
<remarks>
If an <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription" /> has a default response, then the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.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.
</remarks>
</Docs>
</Member>
<Member MemberName="ModelMetadata">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Mvc::ModelBinding::ModelMetadata ^ ModelMetadata { Microsoft::AspNetCore::Mvc::ModelBinding::ModelMetadata ^ get(); void set(Microsoft::AspNetCore::Mvc::ModelBinding::ModelMetadata ^ value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata ModelMetadata { get; set; }" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata ModelMetadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ModelMetadata" />
<MemberSignature Language="VB.NET" Value="Public Property ModelMetadata As ModelMetadata" />
<MemberSignature Language="F#" Value="member this.ModelMetadata : Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ModelMetadata" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata? ModelMetadata { get; set; }" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata" /> for the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type" /> or null.
</summary>
<value>To be added.</value>
<remarks>
Will be null if <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type" /> is null or void.
</remarks>
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C++ CLI" Value="public:
 property int StatusCode { int get(); void set(int value); };" />
<MemberSignature Language="C#" Value="public int StatusCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.StatusCode" />
<MemberSignature Language="VB.NET" Value="Public Property StatusCode As Integer" />
<MemberSignature Language="F#" Value="member this.StatusCode : int with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.StatusCode" />
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the HTTP response status code.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C++ CLI" Value="public:
 property Type ^ Type { Type ^ get(); void set(Type ^ value); };" />
<MemberSignature Language="C#" Value="public Type Type { get; set; }" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type" />
<MemberSignature Language="VB.NET" Value="Public Property Type As Type" />
<MemberSignature Language="F#" Value="member this.Type : Type with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type" />
<MemberSignature Language="C#" Value="public Type? Type { get; set; }" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the CLR data type of the response or null.
</summary>
<value>To be added.</value>
<remarks>
Will be null if the action returns no response, or if the response type is unclear. Use
<c>Microsoft.AspNetCore.Mvc.ProducesAttribute</c> or <c>Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute</c> on an action method
to specify a response type.
</remarks>
</Docs>
</Member>
</Members>
</Type>