Set-PodeOARouteInfo
SYNOPSIS
Sets metadate for the supplied route.
SYNTAX
Set-PodeOARouteInfo [-Route] <Hashtable[]> [[-Summary] <String>] [[-Description] <String>]
[[-OperationId] <String>] [[-Tags] <String[]>] [-Deprecated] [-PassThru] [<CommonParameters>]
DESCRIPTION
Sets metadate for the supplied route, such as Summary and Tags.
EXAMPLES
EXAMPLE 1
Add-PodeRoute -PassThru | Set-PodeOARouteInfo -Summary 'A quick summary' -Tags 'Admin'
PARAMETERS
-Deprecated
If supplied, the route will be flagged as deprecated.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Description
A longer Description of the route.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OperationId
Sets the OperationId of the route.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
If supplied, the route passed in will be returned for further chaining.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Route
The route to update info, usually from -PassThru on Add-PodeRoute.
Type: Hashtable[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Summary
A quick Summary of the route.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags
An array of Tags for the route, mostly for grouping.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
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.