| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Writes an object to the HTTP response body as YAML. |
| | | 4 | | |
| | | 5 | | .DESCRIPTION |
| | | 6 | | Serializes the provided object to YAML using the underlying C# helper and |
| | | 7 | | sets the specified status code on the response. |
| | | 8 | | .PARAMETER InputObject |
| | | 9 | | The object to serialize and write to the response body. This can be any |
| | | 10 | | PowerShell object, including complex types. |
| | | 11 | | .PARAMETER StatusCode |
| | | 12 | | The HTTP status code to set for the response. Defaults to 200 (OK). |
| | | 13 | | .PARAMETER ContentType |
| | | 14 | | The content type of the response. If not specified, defaults to "application/yaml". |
| | | 15 | | .EXAMPLE |
| | | 16 | | Write-KrYamlResponse -InputObject $myObject -StatusCode 200 -ContentType "application/x-yaml" |
| | | 17 | | Writes the $myObject serialized as YAML to the response with a 200 status code |
| | | 18 | | and content type "application/x-yaml". |
| | | 19 | | .NOTES |
| | | 20 | | This function is designed to be used in the context of a Kestrun server response. |
| | | 21 | | #> |
| | | 22 | | function Write-KrYamlResponse { |
| | | 23 | | [KestrunRuntimeApi('Route')] |
| | | 24 | | [CmdletBinding()] |
| | | 25 | | param( |
| | | 26 | | [Parameter(Mandatory = $true, ValueFromPipeline = $true)] |
| | | 27 | | [object]$InputObject, |
| | | 28 | | [Parameter()] |
| | | 29 | | [int]$StatusCode = 200, |
| | | 30 | | [Parameter()] |
| | | 31 | | [string]$ContentType |
| | | 32 | | ) |
| | | 33 | | begin { |
| | | 34 | | # Collect all piped items |
| | 0 | 35 | | $items = [System.Collections.Generic.List[object]]::new() |
| | | 36 | | } |
| | | 37 | | process { |
| | | 38 | | # Accumulate; no output yet |
| | 0 | 39 | | $items.Add($InputObject) |
| | | 40 | | } |
| | | 41 | | end { |
| | | 42 | | # Only works inside a route script block where $Context is available |
| | 0 | 43 | | if ($null -eq $Context -or $null -eq $Context.Response) { |
| | 0 | 44 | | Write-KrOutsideRouteWarning |
| | | 45 | | return |
| | | 46 | | } |
| | | 47 | | # - single item by default when only one was piped |
| | | 48 | | # - array if multiple items were piped |
| | 0 | 49 | | $payload = if ($items.Count -eq 1) { $items[0] } else { $items.ToArray() } |
| | | 50 | | |
| | | 51 | | # Write the YAML response |
| | 0 | 52 | | $Context.Response.WriteYamlResponse($payload, $StatusCode, $ContentType) |
| | | 53 | | } |
| | | 54 | | } |
| | | 55 | | |