15 | @Html.ActionLink("Help Page Home", "Index") 16 |
17 |@controllerDocumentation
18 | } 19 |API | Description |
---|---|
@api.HttpMethod.Method @api.RelativePath | 28 |
29 | @if (api.Documentation != null)
30 | {
31 | @api.Documentation 32 | } 33 | else 34 | { 35 |No documentation available. 36 | } 37 | |
38 |
Possible enumeration values:
5 | 6 |Name | Value | Description |
---|---|---|
@value.Name | 15 |
16 | @value.Value 17 | |
18 |
19 | @value.Documentation 20 | |
21 |
@description.Documentation
13 | 14 |@Model.RequestDocumentation
22 | 23 | @if (Model.RequestModelDescription != null) 24 | { 25 | @Html.DisplayFor(m => m.RequestModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.RequestModelDescription }) 26 | if (Model.RequestBodyParameters != null) 27 | { 28 | @Html.DisplayFor(m => m.RequestBodyParameters, "Parameters") 29 | } 30 | } 31 | else 32 | { 33 |None.
34 | } 35 | 36 | @if (Model.SampleRequests.Count > 0) 37 | { 38 |@description.ResponseDescription.Documentation
47 | 48 | @if (Model.ResourceDescription != null) 49 | { 50 | @Html.DisplayFor(m => m.ResourceDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ResourceDescription }) 51 | if (Model.ResourceProperties != null) 52 | { 53 | @Html.DisplayFor(m => m.ResourceProperties, "Parameters") 54 | } 55 | } 56 | else 57 | { 58 |None.
59 | } 60 | 61 | @if (Model.SampleResponses.Count > 0) 62 | { 63 |Sample not available.
13 | } -------------------------------------------------------------------------------- /GDMS/Areas/HelpPage/Views/Help/DisplayTemplates/KeyValuePairModelDescription.cshtml: -------------------------------------------------------------------------------- 1 | @using GDMS.Areas.HelpPage.ModelDescriptions 2 | @model KeyValuePairModelDescription 3 | Pair of @Html.DisplayFor(m => Model.KeyModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.KeyModelDescription }) [key] 4 | and @Html.DisplayFor(m => Model.ValueModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ValueModelDescription }) [value] -------------------------------------------------------------------------------- /GDMS/Areas/HelpPage/Views/Help/DisplayTemplates/ModelDescriptionLink.cshtml: -------------------------------------------------------------------------------- 1 | @using GDMS.Areas.HelpPage.ModelDescriptions 2 | @model Type 3 | @{ 4 | ModelDescription modelDescription = ViewBag.modelDescription; 5 | if (modelDescription is ComplexTypeModelDescription || modelDescription is EnumTypeModelDescription) 6 | { 7 | if (Model == typeof(Object)) 8 | { 9 | @:Object 10 | } 11 | else 12 | { 13 | @Html.ActionLink(modelDescription.Name, "ResourceModel", "Help", new { modelName = modelDescription.Name }, null) 14 | } 15 | } 16 | else if (modelDescription is CollectionModelDescription) 17 | { 18 | var collectionDescription = modelDescription as CollectionModelDescription; 19 | var elementDescription = collectionDescription.ElementDescription; 20 | @:Collection of @Html.DisplayFor(m => elementDescription.ModelType, "ModelDescriptionLink", new { modelDescription = elementDescription }) 21 | } 22 | else 23 | { 24 | @Html.DisplayFor(m => modelDescription) 25 | } 26 | } -------------------------------------------------------------------------------- /GDMS/Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml: -------------------------------------------------------------------------------- 1 | @using System.Collections.Generic 2 | @using System.Collections.ObjectModel 3 | @using System.Web.Http.Description 4 | @using System.Threading 5 | @using GDMS.Areas.HelpPage.ModelDescriptions 6 | @model IListName | Description | Type | Additional information |
---|---|---|---|
@parameter.Name | 20 |
21 | @parameter.Documentation 22 | |
23 | 24 | @Html.DisplayFor(m => modelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = modelDescription }) 25 | | 26 |
27 | @if (parameter.Annotations.Count > 0)
28 | {
29 | foreach (var annotation in parameter.Annotations)
30 | {
31 | @annotation.Documentation 32 | } 33 | } 34 | else 35 | { 36 |None. 37 | } 38 | |
39 |
None.
47 | } 48 | 49 | -------------------------------------------------------------------------------- /GDMS/Areas/HelpPage/Views/Help/DisplayTemplates/Samples.cshtml: -------------------------------------------------------------------------------- 1 | @using System.Net.Http.Headers 2 | @model DictionarySample not available.
22 | } 23 | else 24 | { 25 | @Html.DisplayFor(s => sample); 26 | } 27 | } 28 |5 | @Model.Text 6 |-------------------------------------------------------------------------------- /GDMS/Areas/HelpPage/Views/Help/Index.cshtml: -------------------------------------------------------------------------------- 1 | @using System.Web.Http 2 | @using System.Web.Http.Controllers 3 | @using System.Web.Http.Description 4 | @using System.Collections.ObjectModel 5 | @using GDMS.Areas.HelpPage.Models 6 | @model Collection
28 | Provide a general description of your APIs here. 29 |
30 |10 | @Html.ActionLink("Help Page Home", "Index") 11 |
12 |@Model.Documentation
16 |