Write-KrYamlResponse

SYNOPSIS

Writes an object to the HTTP response body as YAML.

SYNTAX

__AllParameterSets

Write-KrYamlResponse [-InputObject] <Object> [[-StatusCode] <int>] [[-ContentType] <string>]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Serializes the provided object to YAML using the underlying C# helper and sets the specified status code on the response.

EXAMPLES

EXAMPLE 1

Write-KrYamlResponse -InputObject $myObject -StatusCode 200 -ContentType “application/x-yaml” Writes the $myObject serialized as YAML to the response with a 200 status code and content type “application/x-yaml”.

PARAMETERS

-ContentType

The content type of the response. If not specified, defaults to “application/yaml”.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

The object to serialize and write to the response body. This can be any PowerShell object, including complex types.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-StatusCode

The HTTP status code to set for the response. Defaults to 200 (OK).

Type: System.Int32
DefaultValue: 200
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Object

OUTPUTS

NOTES

This function is designed to be used in the context of a Kestrun server response.