New-PodeOABoolProperty
SYNOPSIS
Creates a new OpenAPI boolean property.
SYNTAX
New-PodeOABoolProperty [[-Name] <String>] [[-Default] <Boolean>] [[-Description] <String>]
[[-Enum] <Boolean[]>] [-Required] [-Deprecated] [-Array] [-Object] [<CommonParameters>]
DESCRIPTION
Creates a new OpenAPI boolean property, for Schemas or Parameters.
EXAMPLES
EXAMPLE 1
New-PodeOABoolProperty -Name 'enabled' -Required
PARAMETERS
-Array
If supplied, the boolean will be treated as an array of booleans.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Default
The default value of the property. (Default: $false)
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Deprecated
If supplied, the object will be treated as Deprecated where supported.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Description
A Description of the property.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Enum
An optional array of values that this property can only be set to.
Type: Boolean[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The Name of the property.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Object
If supplied, the boolean will be automatically wrapped in an object.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Required
If supplied, the object will be treated as Required where supported.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.