From 3d884aff3ed425af7f9bf084d848dc83cc912040 Mon Sep 17 00:00:00 2001 From: Adam Driscoll Date: Thu, 19 Dec 2019 07:19:33 -0700 Subject: [PATCH] Fix help for Set-UDCookie. --- CHANGELOG.md | 1 + src/UniversalDashboard/Help/Set-UDCookie.md | 49 +++++++++++++++++---- 2 files changed, 41 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a8e97ac..fac7a8fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Improved Error message when access the $Session scope outside of an endpoint (#1369) by [adamdriscoll](https://github.com/adamdriscoll) - Fixed warning about missing folder when starting dashboard (#1373) by [adamdriscoll](https://github.com/adamdriscoll) - Fixed issue where Enable-UDLogging would not work after running Disable-UDLogging (#1389) by [adamdriscoll](https://github.com/adamdriscoll) +- Fixed the help for Set-UDCookie by [adamdriscoll](https://github.com/adamdriscoll) ### Changed (Enterprise) diff --git a/src/UniversalDashboard/Help/Set-UDCookie.md b/src/UniversalDashboard/Help/Set-UDCookie.md index 36f62ebb..71d9d4dc 100644 --- a/src/UniversalDashboard/Help/Set-UDCookie.md +++ b/src/UniversalDashboard/Help/Set-UDCookie.md @@ -5,36 +5,36 @@ online version: schema: 2.0.0 --- -# Set-UDContentType +# Set-UDCookie ## SYNOPSIS -Sets the content-type HTTP header for a HTTP response. +Sets a response cookie in the UD response. ## SYNTAX ``` -Set-UDContentType [-ContentType] [] +Set-UDContentType -Name -Value [-CookieOptions] [] ``` ## DESCRIPTION -Sets the content-type HTTP header for a HTTP response. This should be in control's Endpoint script blocks. +Sets a response cookie in the UD response. ## EXAMPLES ### Example 1 ``` -PS C:\> Set-UDContentType -ContentType "application/xml" +PS C:\> Set-UDCookie -Name 'MyCookie' -Value 'CookieValue' ``` -Sets the content type to XML if an endpoint wanted to return XML. +Sets a response cookie. ## PARAMETERS -### -ContentType -The content type to set. +### -Name +The name of the cookie ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: @@ -45,6 +45,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Value +The value of the cookie + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CookieOptions +Additional cookie options to set. + +```yaml +Type: Microsoft.AspNetCore.Http.CookieOptions +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +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 (http://go.microsoft.com/fwlink/?LinkID=113216).