Skip to content

New-PodeJsonSchemaBoolean

SYNOPSIS

Creates a Boolean JSON Schema type definition.

SYNTAX

New-PodeJsonSchemaBoolean [[-Constant] <Boolean>] [[-Description] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function creates a JSON Schema type definition for a Boolean type.

EXAMPLES

EXAMPLE 1

New-PodeJsonSchemaBoolean

EXAMPLE 2

New-PodeJsonSchemaBoolean -Constant $true -Description 'Some property that must be true'

PARAMETERS

-Constant

An optional Constant value.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

An optional Description.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

System.Collections.Hashtable

NOTES