Skip to content

Commit

Permalink
Fix help for Set-UDCookie.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdriscoll committed Dec 19, 2019
1 parent 7ef9108 commit 3d884af
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
49 changes: 40 additions & 9 deletions src/UniversalDashboard/Help/Set-UDCookie.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] <Object> [<CommonParameters>]
Set-UDContentType -Name <string> -Value <string> [-CookieOptions] <Microsoft.AspNetCore.Http.CookieOptions> [<CommonParameters>]
```

## 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:

Expand All @@ -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).
Expand Down

0 comments on commit 3d884af

Please sign in to comment.