| | | 1 | | // Licensed to the .NET Foundation under one or more agreements. |
| | | 2 | | // The .NET Foundation licenses this file to you under the MIT license. |
| | | 3 | | |
| | | 4 | | using System; |
| | | 5 | | using System.Collections.Generic; |
| | | 6 | | using Microsoft.OpenApi.Models; |
| | | 7 | | |
| | | 8 | | namespace CoreWCF.OpenApi |
| | | 9 | | { |
| | | 10 | | /// <summary> |
| | | 11 | | /// Top level information about the API. |
| | | 12 | | /// </summary> |
| | | 13 | | public sealed class OpenApiOptions |
| | | 14 | | { |
| | | 15 | | /// <summary> |
| | | 16 | | /// Version of the API. |
| | | 17 | | /// </summary> |
| | 44 | 18 | | public string Version { get; set; } |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Description of the API. |
| | | 22 | | /// </summary> |
| | 44 | 23 | | public string Description { get; set; } |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Title of the API. |
| | | 27 | | /// </summary> |
| | 44 | 28 | | public string Title { get; set; } |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Terms of service of the API. |
| | | 32 | | /// </summary> |
| | 43 | 33 | | public Uri TermsOfService { get; set; } |
| | | 34 | | |
| | | 35 | | /// <summary> |
| | | 36 | | /// Name of the contact. |
| | | 37 | | /// </summary> |
| | 45 | 38 | | public string ContactName { get; set; } |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Url with contact information. |
| | | 42 | | /// </summary> |
| | 44 | 43 | | public string ContactEmail { get; set; } |
| | | 44 | | |
| | | 45 | | /// <summary> |
| | | 46 | | /// Email used for contact. |
| | | 47 | | /// </summary> |
| | 43 | 48 | | public Uri ContactUrl { get; set; } |
| | | 49 | | |
| | | 50 | | /// <summary> |
| | | 51 | | /// Name of the license used for the API. |
| | | 52 | | /// </summary> |
| | 45 | 53 | | public string LicenseName { get; set; } |
| | | 54 | | |
| | | 55 | | /// <summary> |
| | | 56 | | /// URL of the license for the API. |
| | | 57 | | /// </summary> |
| | 2 | 58 | | public Uri LiceneUrl { get; set; } |
| | | 59 | | |
| | | 60 | | /// <summary> |
| | | 61 | | /// Description of an external document for the API. |
| | | 62 | | /// </summary> |
| | 3 | 63 | | public string ExternalDocumentDescription { get; set; } |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// URL of an external document for an API. |
| | | 67 | | /// </summary> |
| | 44 | 68 | | public Uri ExternalDocumentUrl { get; set; } |
| | | 69 | | |
| | | 70 | | /// <summary> |
| | | 71 | | /// Any tags to hide. |
| | | 72 | | /// </summary> |
| | 88 | 73 | | public IEnumerable<string> TagsToHide { get; set; } = new List<string>(); |
| | | 74 | | |
| | | 75 | | /// <summary> |
| | | 76 | | /// Optional callback to sort tags. |
| | | 77 | | /// </summary> |
| | 44 | 78 | | public IComparer<OpenApiTag> TagsSorter { get; set; } |
| | | 79 | | } |
| | | 80 | | } |