| | | 1 | | |
| | | 2 | | /// <summary> |
| | | 3 | | /// Specifies metadata for an OpenAPI response object. |
| | | 4 | | /// Can be attached to PowerShell or C# classes representing reusable responses. |
| | | 5 | | /// </summary> |
| | | 6 | | [AttributeUsage(AttributeTargets.Method | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = true, Inhe |
| | | 7 | | public sealed class OpenApiResponseAttribute : KestrunAnnotation, IOpenApiResponseAttribute |
| | | 8 | | { |
| | | 9 | | /// <summary> |
| | | 10 | | /// Optional component name override for components.responses key. |
| | | 11 | | /// If omitted, the generator will name by member (Class.Property) when used on members, |
| | | 12 | | /// or by class name when applied at class-level. |
| | | 13 | | /// </summary> |
| | 0 | 14 | | public string? Key { get; set; } |
| | | 15 | | |
| | | 16 | | /// <summary> |
| | | 17 | | /// The HTTP status code (e.g., "200", "400", "404"). |
| | | 18 | | /// </summary> |
| | 0 | 19 | | public string StatusCode { get; set; } = "default"; |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// A short description of the response (required in OpenAPI spec). |
| | | 23 | | /// </summary> |
| | 0 | 24 | | public string? Description { get; set; } |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Optional CLR type for the response schema. |
| | | 28 | | /// When set, this takes precedence over Schema and is |
| | | 29 | | /// mapped via InferPrimitiveSchema / PrimitiveSchemaMap. |
| | | 30 | | /// </summary> |
| | 0 | 31 | | public Type? Schema { get; set; } |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Optional CLR type for the response schema items when the response is an array. |
| | | 35 | | /// When set, this takes precedence over ItemSchema and is |
| | | 36 | | /// is mapped via InferPrimitiveSchema / PrimitiveSchemaMap. |
| | | 37 | | /// </summary> |
| | 0 | 38 | | public Type? SchemaItem { get; set; } |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// MIME type of the response payload (default: "application/json"). |
| | | 42 | | /// </summary> |
| | 0 | 43 | | public string[] ContentType { get; set; } = ["application/json"]; |
| | | 44 | | |
| | | 45 | | /// <summary> |
| | | 46 | | /// If true, the schema will be inlined rather than referenced. |
| | | 47 | | /// </summary> |
| | 0 | 48 | | public bool Inline { get; set; } |
| | | 49 | | } |