New-KrOpenApiHeader

SYNOPSIS

Creates a new OpenAPI Header object.

SYNTAX

Schema (Default)

New-KrOpenApiHeader [-Server <KestrunHost>] [-Description <string>] [-Required] [-Deprecated]
 [-AllowEmptyValue] [-Explode] [-AllowReserved] [-Style <ParameterStyle>] [-Example <Object>]
 [-Examples <hashtable>] [-Schema <Object>] [-Extensions <IDictionary>] [<CommonParameters>]

Content

New-KrOpenApiHeader [-Server <KestrunHost>] [-Description <string>] [-Required] [-Deprecated]
 [-AllowEmptyValue] [-Explode] [-AllowReserved] [-Style <ParameterStyle>] [-Example <Object>]
 [-Examples <hashtable>] [-Content <IDictionary>] [-Extensions <IDictionary>] [<CommonParameters>]

ALIASES

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

DESCRIPTION

This cmdlet creates a new OpenAPI Header object that can be used in OpenAPI specifications.

EXAMPLES

EXAMPLE 1

$header = New-KrOpenApiHeader -Description “Custom Header” -Required -Schema [string] This example creates a new OpenAPI Header object with a description, marks it as required, and sets its schema to string.

EXAMPLE 2

$content = @{ “application/json” = New-KrOpenApiMediaType -Schema [hashtable] } $header = New-KrOpenApiHeader -Description “JSON Header” -Content $content This example creates a new OpenAPI Header object with a description and sets its content to application/json with a hashtable schema.

EXAMPLE 3

$examples = @{ “example1” = New-KrOpenApiExample -Summary “Example 1” -Value “Value1” “example2” = New-KrOpenApiExample -Summary “Example 2” -Value “Value2” } $header = New-KrOpenApiHeader -Description “Header with Examples” -Examples $examples -Schema [string] This example creates a new OpenAPI Header object with a description, multiple examples, and sets its schema to string.

PARAMETERS

-AllowEmptyValue

Indicates whether the header allows empty values.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AllowReserved

Indicates whether the header allows reserved characters.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Content

A dictionary representing the content of the header, mapping media types to OpenAPI MediaType objects.

Type: System.Collections.IDictionary
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Content
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Deprecated

Indicates whether the header is deprecated.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Description

A brief description of the header.

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

-Example

A single example of the header value.

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

-Examples

A dictionary of multiple examples for the header.

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

-Explode

Indicates whether the header should be exploded.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Extensions

A dictionary of OpenAPI extensions to add to the header.

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

-Required

Indicates whether the header is required.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Schema

The schema defining the type of the header value. This can be a .NET type literal (e.g., [string], [int], etc.).

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Schema
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Server

The Kestrun server instance to use. If not specified, the default server instance is used.

Type: Kestrun.Hosting.KestrunHost
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Style

The style of the header (e.g., simple, matrix, label, etc.).

Type: System.Nullable`1[Microsoft.OpenApi.ParameterStyle]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  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

Kestrun.Hosting.KestrunHost

{{ Fill in the Description }}

OUTPUTS

Microsoft.OpenApi.OpenApiHeader

{{ Fill in the Description }}

NOTES

This function is part of the Kestrun PowerShell module for working with OpenAPI specifications.

RELATED LINKS

{{ Fill in the related links here }}