New-PodeJsonSchemaString
SYNOPSIS
Creates a String JSON Schema type definition.
SYNTAX
Dynamic (Default)
New-PodeJsonSchemaString [-Pattern <String>] [-MinLength <Int32>] [-MaxLength <Int32>] [-Description <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Constant
New-PodeJsonSchemaString [-Constant <String>] [-Description <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Enum
New-PodeJsonSchemaString [-Enum <String[]>] [-Description <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
This function creates a JSON Schema type definition for a String type.
EXAMPLES
EXAMPLE 1
New-PodeJsonSchemaString
EXAMPLE 2
New-PodeJsonSchemaString -Pattern '^[a-zA-Z0-9]+$' -Description 'A string that must be alphanumeric'
EXAMPLE 3
New-PodeJsonSchemaString -MinLength 5 -MaxLength 10 -Description 'A string that must be between 5 and 10 characters long'
EXAMPLE 4
New-PodeJsonSchemaString -Enum 'red', 'green', 'blue' -Description 'A string that must be one of the specified colours'
EXAMPLE 5
New-PodeJsonSchemaString -Constant 'fixed value' -Description 'A string that must be exactly "fixed value"'
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 string can be.
Type: String[]
Parameter Sets: Enum
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxLength
An optional maximum length for the string.
Type: Int32
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-MinLength
An optional minimum length for the string.
Type: Int32
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Pattern
An optional regular expression pattern that the string must match.
Type: String
Parameter Sets: Dynamic
Aliases:
Required: False
Position: Named
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.