New-PodeJsonSchemaNumber
SYNOPSIS
Creates a Number JSON Schema type definition.
SYNTAX
Dynamic (Default)
New-PodeJsonSchemaNumber [-MultipleOf <Double>] [-Minimum <Double>] [-Maximum <Double>] [-ExclusiveMinimum]
[-ExclusiveMaximum] [-Description <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Constant
New-PodeJsonSchemaNumber [-Constant <String>] [-Description <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Enum
New-PodeJsonSchemaNumber [-Enum <Double[]>] [-Description <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
This function creates a JSON Schema type definition for a Number type.
EXAMPLES
EXAMPLE 1
New-PodeJsonSchemaNumber
EXAMPLE 2
New-PodeJsonSchemaNumber -Minimum 0.0 -Maximum 1.0 -Description 'A ratio between 0 and 1'
EXAMPLE 3
New-PodeJsonSchemaNumber -Enum 3.14, 2.718, 1.618 -Description 'Some famous mathematical constants'
EXAMPLE 4
New-PodeJsonSchemaNumber -MultipleOf 0.01 -Description 'A value that must be a multiple of 0.01'
EXAMPLE 5
New-PodeJsonSchemaNumber -Minimum 0.0 -ExclusiveMinimum -Description 'A value that must be greater than 0.0'
EXAMPLE 6
New-PodeJsonSchemaNumber -Maximum 100.0 -ExclusiveMaximum -Description 'A value that must be less than 100.0'
PARAMETERS
-Constant
An optional Constant value.
Type: String
Parameter Sets: Constant
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
An optional Description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Enum
An optional array of values that the number can be.
Type: Double[]
Parameter Sets: Enum
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExclusiveMaximum
An optional switch to indicate if the maximum value is exclusive.
Type: SwitchParameter
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ExclusiveMinimum
An optional switch to indicate if the minimum value is exclusive.
Type: SwitchParameter
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Maximum
An optional maximum value for the number.
Type: Double
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Minimum
An optional minimum value for the number.
Type: Double
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-MultipleOf
An optional value that the number must be a multiple of.
Type: Double
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: 0
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.