-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathXmlDocument.xml
More file actions
588 lines (588 loc) · 35.2 KB
/
Copy pathXmlDocument.xml
File metadata and controls
588 lines (588 loc) · 35.2 KB
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
<?xml version="1.0"?>
<doc>
<assembly>
<name>TestAPI</name>
</assembly>
<members>
<member name="M:TestAPI.Areas.HelpPage.ApiDescriptionExtensions.GetFriendlyId(System.Web.Http.Description.ApiDescription)">
<summary>
Generates an URI-friendly ID for the <see cref="T:System.Web.Http.Description.ApiDescription"/>. E.g. "Get-Values-id_name" instead of "GetValues/{id}?name={name}"
</summary>
<param name="description">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
<returns>The ID as a string.</returns>
</member>
<member name="T:TestAPI.Areas.HelpPage.HelpPageConfig">
<summary>
Use this class to customize the Help Page.
For example you can set a custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> to supply the documentation
or you can provide the samples for the requests/responses.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.Controllers.HelpController">
<summary>
The controller that will handle requests for the help page.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetDocumentationProvider(System.Web.Http.HttpConfiguration,System.Web.Http.Description.IDocumentationProvider)">
<summary>
Sets the documentation provider for help page.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="documentationProvider">The documentation provider.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleObjects(System.Web.Http.HttpConfiguration,System.Collections.Generic.IDictionary{System.Type,System.Object})">
<summary>
Sets the objects that will be used by the formatters to produce sample requests/responses.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sampleObjects">The sample objects.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
<summary>
Sets the sample request directly for the specified media type and action.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sample">The sample request.</param>
<param name="mediaType">The media type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
<summary>
Sets the sample request directly for the specified media type and action with parameters.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sample">The sample request.</param>
<param name="mediaType">The media type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
<summary>
Sets the sample request directly for the specified media type of the action.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sample">The sample response.</param>
<param name="mediaType">The media type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
<summary>
Sets the sample response directly for the specified media type of the action with specific parameters.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sample">The sample response.</param>
<param name="mediaType">The media type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForMediaType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue)">
<summary>
Sets the sample directly for all actions with the specified media type.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sample">The sample.</param>
<param name="mediaType">The media type.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
<summary>
Sets the sample directly for all actions with the specified type and media type.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sample">The sample.</param>
<param name="mediaType">The media type.</param>
<param name="type">The parameter type or return type of an action.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
<summary>
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
The help page will use this information to produce more accurate request samples.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="type">The type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
<summary>
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
The help page will use this information to produce more accurate request samples.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="type">The type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
<summary>
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> returned as part of the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
The help page will use this information to produce more accurate response samples.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="type">The type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
<summary>
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> returned as part of the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
The help page will use this information to produce more accurate response samples.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="type">The type.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration)">
<summary>
Gets the help page sample generator.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<returns>The help page sample generator.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.SetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration,TestAPI.Areas.HelpPage.HelpPageSampleGenerator)">
<summary>
Sets the help page sample generator.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="sampleGenerator">The help page sample generator.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.GetModelDescriptionGenerator(System.Web.Http.HttpConfiguration)">
<summary>
Gets the model description generator.
</summary>
<param name="config">The configuration.</param>
<returns>The <see cref="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator"/></returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageApiModel(System.Web.Http.HttpConfiguration,System.String)">
<summary>
Gets the model that represents an API displayed on the help page. The model is initialized on the first call and cached for subsequent calls.
</summary>
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
<param name="apiDescriptionId">The <see cref="T:System.Web.Http.Description.ApiDescription"/> ID.</param>
<returns>
An <see cref="T:TestAPI.Areas.HelpPage.Models.HelpPageApiModel"/>
</returns>
</member>
<member name="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelDescription">
<summary>
Describes a type model.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator">
<summary>
Generates model descriptions for given types.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelNameAttribute">
<summary>
Use this attribute to change the name of the <see cref="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelDescription"/> generated for a type.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.Models.HelpPageApiModel">
<summary>
The model that represents an API displayed on the help page.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.#ctor">
<summary>
Initializes a new instance of the <see cref="T:TestAPI.Areas.HelpPage.Models.HelpPageApiModel"/> class.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription">
<summary>
Gets or sets the <see cref="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription"/> that describes the API.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.UriParameters">
<summary>
Gets or sets the <see cref="T:TestAPI.Areas.HelpPage.ModelDescriptions.ParameterDescription"/> collection that describes the URI parameters for the API.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.RequestDocumentation">
<summary>
Gets or sets the documentation for the request.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.RequestModelDescription">
<summary>
Gets or sets the <see cref="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the request body.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.RequestBodyParameters">
<summary>
Gets the request body parameter descriptions.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.ResourceDescription">
<summary>
Gets or sets the <see cref="T:TestAPI.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the resource.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.ResourceProperties">
<summary>
Gets the resource property descriptions.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.SampleRequests">
<summary>
Gets the sample requests associated with the API.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.SampleResponses">
<summary>
Gets the sample responses associated with the API.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.Models.HelpPageApiModel.ErrorMessages">
<summary>
Gets the error messages associated with this model.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.HelpPageSampleGenerator">
<summary>
This class will generate the samples for the help page.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.#ctor">
<summary>
Initializes a new instance of the <see cref="T:TestAPI.Areas.HelpPage.HelpPageSampleGenerator"/> class.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.ActualHttpMessageTypes">
<summary>
Gets CLR types that are used as the content of <see cref="T:System.Net.Http.HttpRequestMessage"/> or <see cref="T:System.Net.Http.HttpResponseMessage"/>.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples">
<summary>
Gets the objects that are used directly as samples for certain actions.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects">
<summary>
Gets the objects that are serialized as samples by the supported formatters.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories">
<summary>
Gets factories for the objects that the supported formatters will serialize as samples. Processed in order,
stopping when the factory successfully returns a non-<see langref="null"/> object.
</summary>
<remarks>
Collection includes just <see cref="M:TestAPI.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)"/> initially. Use
<code>SampleObjectFactories.Insert(0, func)</code> to provide an override and
<code>SampleObjectFactories.Add(func)</code> to provide a fallback.</remarks>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.GetSampleRequests(System.Web.Http.Description.ApiDescription)">
<summary>
Gets the request body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
</summary>
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
<returns>The samples keyed by media type.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.GetSampleResponses(System.Web.Http.Description.ApiDescription)">
<summary>
Gets the response body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
</summary>
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
<returns>The samples keyed by media type.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.GetSample(System.Web.Http.Description.ApiDescription,TestAPI.Areas.HelpPage.SampleDirection)">
<summary>
Gets the request or response body samples.
</summary>
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
<param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
<returns>The samples keyed by media type.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.GetActionSample(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Type,System.Net.Http.Formatting.MediaTypeFormatter,System.Net.Http.Headers.MediaTypeHeaderValue,TestAPI.Areas.HelpPage.SampleDirection)">
<summary>
Search for samples that are provided directly through <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples"/>.
</summary>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
<param name="type">The CLR type.</param>
<param name="formatter">The formatter.</param>
<param name="mediaType">The media type.</param>
<param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
<returns>The sample that matches the parameters.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.GetSampleObject(System.Type)">
<summary>
Gets the sample object that will be serialized by the formatters.
First, it will look at the <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects"/>. If no sample object is found, it will try to create
one using <see cref="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.DefaultSampleObjectFactory(TestAPI.Areas.HelpPage.HelpPageSampleGenerator,System.Type)"/> (which wraps an <see cref="T:TestAPI.Areas.HelpPage.ObjectGenerator"/>) and other
factories in <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories"/>.
</summary>
<param name="type">The type.</param>
<returns>The sample object.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.ResolveHttpRequestMessageType(System.Web.Http.Description.ApiDescription)">
<summary>
Resolves the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
</summary>
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
<returns>The type.</returns>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.ResolveType(System.Web.Http.Description.ApiDescription,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},TestAPI.Areas.HelpPage.SampleDirection,System.Collections.ObjectModel.Collection{System.Net.Http.Formatting.MediaTypeFormatter}@)">
<summary>
Resolves the type of the action parameter or return value when <see cref="T:System.Net.Http.HttpRequestMessage"/> or <see cref="T:System.Net.Http.HttpResponseMessage"/> is used.
</summary>
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
<param name="sampleDirection">The value indicating whether the sample is for a request or a response.</param>
<param name="formatters">The formatters.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleGenerator.WriteSampleObjectUsingFormatter(System.Net.Http.Formatting.MediaTypeFormatter,System.Object,System.Type,System.Net.Http.Headers.MediaTypeHeaderValue)">
<summary>
Writes the sample object using formatter.
</summary>
<param name="formatter">The formatter.</param>
<param name="value">The value.</param>
<param name="type">The type.</param>
<param name="mediaType">Type of the media.</param>
<returns></returns>
</member>
<member name="T:TestAPI.Areas.HelpPage.HelpPageSampleKey">
<summary>
This is used to identify the place where the sample should be applied.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue)">
<summary>
Creates a new <see cref="T:TestAPI.Areas.HelpPage.HelpPageSampleKey"/> based on media type.
</summary>
<param name="mediaType">The media type.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
<summary>
Creates a new <see cref="T:TestAPI.Areas.HelpPage.HelpPageSampleKey"/> based on media type and CLR type.
</summary>
<param name="mediaType">The media type.</param>
<param name="type">The CLR type.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleKey.#ctor(TestAPI.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates a new <see cref="T:TestAPI.Areas.HelpPage.HelpPageSampleKey"/> based on <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
</summary>
<param name="sampleDirection">The <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
</member>
<member name="M:TestAPI.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,TestAPI.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates a new <see cref="T:TestAPI.Areas.HelpPage.HelpPageSampleKey"/> based on media type, <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
</summary>
<param name="mediaType">The media type.</param>
<param name="sampleDirection">The <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
<param name="controllerName">Name of the controller.</param>
<param name="actionName">Name of the action.</param>
<param name="parameterNames">The parameter names.</param>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.ControllerName">
<summary>
Gets the name of the controller.
</summary>
<value>
The name of the controller.
</value>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.ActionName">
<summary>
Gets the name of the action.
</summary>
<value>
The name of the action.
</value>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.MediaType">
<summary>
Gets the media type.
</summary>
<value>
The media type.
</value>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.ParameterNames">
<summary>
Gets the parameter names.
</summary>
</member>
<member name="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.SampleDirection">
<summary>
Gets the <see cref="P:TestAPI.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.ImageSample">
<summary>
This represents an image sample on the help page. There's a display template named ImageSample associated with this class.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.ImageSample.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:TestAPI.Areas.HelpPage.ImageSample"/> class.
</summary>
<param name="src">The URL of an image.</param>
</member>
<member name="T:TestAPI.Areas.HelpPage.InvalidSample">
<summary>
This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.ObjectGenerator">
<summary>
This class will create an object of a given type and populate it with sample data.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)">
<summary>
Generates an object for a given type. The type needs to be public, have a public default constructor and settable public properties/fields. Currently it supports the following types:
Simple types: <see cref="T:System.Int32"/>, <see cref="T:System.String"/>, <see cref="T:System.Enum"/>, <see cref="T:System.DateTime"/>, <see cref="T:System.Uri"/>, etc.
Complex types: POCO types.
Nullables: <see cref="T:System.Nullable`1"/>.
Arrays: arrays of simple types or complex types.
Key value pairs: <see cref="T:System.Collections.Generic.KeyValuePair`2"/>
Tuples: <see cref="T:System.Tuple`1"/>, <see cref="T:System.Tuple`2"/>, etc
Dictionaries: <see cref="T:System.Collections.Generic.IDictionary`2"/> or anything deriving from <see cref="T:System.Collections.Generic.IDictionary`2"/>.
Collections: <see cref="T:System.Collections.Generic.IList`1"/>, <see cref="T:System.Collections.Generic.IEnumerable`1"/>, <see cref="T:System.Collections.Generic.ICollection`1"/>, <see cref="T:System.Collections.IList"/>, <see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> or anything deriving from <see cref="T:System.Collections.Generic.ICollection`1"/> or <see cref="T:System.Collections.IList"/>.
Queryables: <see cref="T:System.Linq.IQueryable"/>, <see cref="T:System.Linq.IQueryable`1"/>.
</summary>
<param name="type">The type.</param>
<returns>An object of the given type.</returns>
</member>
<member name="T:TestAPI.Areas.HelpPage.SampleDirection">
<summary>
Indicates whether the sample is used for request or response
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.TextSample">
<summary>
This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.
</summary>
</member>
<member name="T:TestAPI.Areas.HelpPage.XmlDocumentationProvider">
<summary>
A custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> that reads the API documentation from an XML documentation file.
</summary>
</member>
<member name="M:TestAPI.Areas.HelpPage.XmlDocumentationProvider.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:TestAPI.Areas.HelpPage.XmlDocumentationProvider"/> class.
</summary>
<param name="documentPath">The physical path to XML document.</param>
</member>
<member name="T:TestAPI.Controllers.RecipesController">
<summary>
Controls the API for the recipe management
</summary>
</member>
<member name="M:TestAPI.Controllers.RecipesController.#ctor">
<summary>
Creates a new RecipesController, with the default RecipeProvider
</summary>
</member>
<member name="M:TestAPI.Controllers.RecipesController.Get(System.String)">
<summary>
Gets a list of stored recipes for a specified user. Returns default recipes if the user is first-time user
</summary>
<param name="username">The user on whose behalf we get the recipes</param>
<returns>Collection of recipes, belonging to the user</returns>
</member>
<member name="M:TestAPI.Controllers.RecipesController.Reset(System.String)">
<summary>
Resets the recipes for a specified user to the default recipes
</summary>
<param name="username">The username of the user</param>
<returns>True if the reseting was successfull, false otherwise</returns>
</member>
<member name="M:TestAPI.Controllers.RecipesController.Get(System.String,System.Int32)">
<summary>
Gets a specified recipe for a specified user
</summary>
<param name="username">The username of the user</param>
<param name="id">The id of the recipe</param>
<returns>The recipe with the specified id for the specified user, if it exists, null otherwise</returns>
</member>
<member name="M:TestAPI.Controllers.RecipesController.Post(System.String,TestAPI.Models.Recipe)">
<summary>
Creates or updates a recipe for a specified user
</summary>
<param name="username">The username of the user</param>
<param name="recipe">The recipe to be created or updated</param>
</member>
<member name="M:TestAPI.Controllers.RecipesController.Put(System.String,TestAPI.Models.Recipe)">
<summary>
Creates or updates a recipe for a specified user
</summary>
<param name="username">The username of the user</param>
<param name="recipe">The recipe to be created or updated</param>
</member>
<member name="M:TestAPI.Controllers.RecipesController.Delete(System.String,System.Int32)">
<summary>
Deletes a recipe for a specified user
</summary>
<param name="username">The username of the user</param>
<param name="id">The id of the recipe to be deleted</param>
</member>
<member name="T:TestAPI.Models.Recipe">
<summary>
Represents the recipe
</summary>
</member>
<member name="P:TestAPI.Models.Recipe.Id">
<summary>
Id of the recipe
</summary>
</member>
<member name="P:TestAPI.Models.Recipe.Name">
<summary>
Name of the recipe
</summary>
</member>
<member name="P:TestAPI.Models.Recipe.Source">
<summary>
Source of the recipe
</summary>
</member>
<member name="P:TestAPI.Models.Recipe.Ingredients">
<summary>
Collection of ingredients needed for the recipe
</summary>
</member>
<member name="P:TestAPI.Models.Recipe.Instructions">
<summary>
Instructions on how to prepare the recipe
</summary>
</member>
<member name="P:TestAPI.Models.Recipe.PreparationTime">
<summary>
Time needed to prepare the recipe (in minutes)
</summary>
</member>
<member name="T:TestAPI.Models.Ingredient">
<summary>
Represents the individual ingredients of a recipe
</summary>
</member>
<member name="P:TestAPI.Models.Ingredient.Name">
<summary>
The name of the ingredient
</summary>
</member>
<member name="P:TestAPI.Models.Ingredient.Quantity">
<summary>
The quantity needed
</summary>
</member>
</members>
</doc>