Add-PodeOATag
SYNOPSIS
Creates a OpenAPI Tag reference property.
SYNTAX
Add-PodeOATag [-Name] <String> [[-Description] <String>] [[-ExternalDoc] <OrderedDictionary>]
[[-DefinitionTag] <String[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Creates a new OpenAPI tag reference.
EXAMPLES
EXAMPLE 1
Add-PodeOATag -Name 'store' -Description 'Access to Petstore orders' -ExternalDoc 'SwaggerDocs'
PARAMETERS
-DefinitionTag
An Array of strings representing the unique tag for the API specification. This tag helps distinguish 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: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
A Description of the tag.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExternalDoc
If supplied, the tag references an existing external documentation reference. The parameter is created by Add-PodeOAExternalDoc
Type: OrderedDictionary
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The Name of the tag.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
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.