| | | 1 | | /// <summary> |
| | | 2 | | /// OpenAPI Parameter metadata for query/path/header/cookie items. |
| | | 3 | | /// Apply on properties inside a class marked with <see cref="OpenApiModelKindAttribute"/> = Parameters. |
| | | 4 | | /// </summary> |
| | | 5 | | [AttributeUsage(AttributeTargets.Property | AttributeTargets.Parameter, AllowMultiple = false)] |
| | | 6 | | public sealed class OpenApiParameterAttribute : KestrunAnnotation |
| | | 7 | | { |
| | | 8 | | /// <summary>Where the parameter lives (query/header/path/cookie).</summary> |
| | 0 | 9 | | public string In { get; set; } = OaParameterLocation.Query.ToString(); |
| | | 10 | | /// <summary>Override the parameter name (default: property name).</summary> |
| | 0 | 11 | | public string? Name { get; set; } |
| | | 12 | | /// <summary> |
| | | 13 | | /// Optional description for the parameter. |
| | | 14 | | /// </summary> |
| | 0 | 15 | | public string? Description { get; set; } |
| | | 16 | | /// <summary>Override the parameter name (default: property name).</summary> |
| | 0 | 17 | | public string? Key { get; set; } |
| | | 18 | | /// <summary>Marks the parameter as required.</summary> |
| | 0 | 19 | | public bool Required { get; set; } |
| | | 20 | | /// <summary>Marks the parameter as deprecated.</summary> |
| | 0 | 21 | | public bool Deprecated { get; set; } |
| | | 22 | | /// <summary>Allow empty value (query only).</summary> |
| | 0 | 23 | | public bool AllowEmptyValue { get; set; } |
| | | 24 | | /// <summary>Serialization style hint.</summary> |
| | 0 | 25 | | public OaParameterStyle? Style { get; set; } |
| | | 26 | | /// <summary>Explode hint for structured values.</summary> |
| | 0 | 27 | | public bool Explode { get; set; } |
| | | 28 | | /// <summary>Allow reserved characters unescaped (query only).</summary> |
| | 0 | 29 | | public bool AllowReserved { get; set; } |
| | | 30 | | /// <summary>Example value (single example).</summary> |
| | 0 | 31 | | public object? Example { get; set; } |
| | | 32 | | } |