Skip to content

Test-PodeOAVersion

SYNOPSIS

Check the OpenAPI version

SYNTAX

Test-PodeOAVersion [-Version] <Decimal> [-DefinitionTag] <String[]> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Check the OpenAPI version for a specific OpenAPI Definition

EXAMPLES

EXAMPLE 1

Test-PodeOAVersion -Version 3.1 -DefinitionTag 'default'

PARAMETERS

-DefinitionTag

An Array of strings representing the unique tag for the API specification. This tag helps in distinguishing between different versions or types of API specifications within the application. You can use this tag to reference the specific API documentation, schema, or version that your function interacts with.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
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

-Version

The version number to compare

Type: Decimal
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: 0
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

NOTES