| | | 1 | | /// <summary> |
| | | 2 | | /// Specifies metadata for an OpenAPI Example object. Can be applied to classes |
| | | 3 | | /// to contribute entries under components.examples. |
| | | 4 | | /// </summary> |
| | | 5 | | [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)] |
| | | 6 | | public sealed class OpenApiExampleComponent : KestrunAnnotation |
| | | 7 | | { |
| | | 8 | | /// <summary> |
| | | 9 | | /// Optional component name override for components.examples key. |
| | | 10 | | /// If omitted, generator uses class name (class-level) or member name (member-level), |
| | | 11 | | /// possibly prefixed by class name depending on JoinClassName. |
| | | 12 | | /// </summary> |
| | 12 | 13 | | public string? Key { get; set; } |
| | | 14 | | |
| | | 15 | | /// <summary>Short summary for the example.</summary> |
| | 8 | 16 | | public string? Summary { get; set; } |
| | | 17 | | |
| | | 18 | | /// <summary>Longer description for the example.</summary> |
| | 8 | 19 | | public string? Description { get; set; } |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// External example URI. If provided, Value is usually omitted per spec. |
| | | 23 | | /// </summary> |
| | 4 | 24 | | public string? ExternalValue { get; set; } |
| | | 25 | | } |