Skip to content

Commit 1361dc9

Browse files
committed
Fix various missing comment based help and parameter help test.
1 parent 1f17cae commit 1361dc9

File tree

5 files changed

+34
-5
lines changed

5 files changed

+34
-5
lines changed

HaloAPI.build.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ if ($UpdateHelp) {
5252
Exclude = $ExcludeFiles
5353
Sidebar = 'commandlets'
5454
# MetaDescription = 'Generated cmdlet help for the %1 commandlet.'
55+
NoPlaceHolderExamples = $true
5556
GroupByVerb = $true
5657
UseDescriptionFromHelp = $true
5758
}

Public/Get/Get-HaloAssetType.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ function Get-HaloAssetType {
5555
# Include the last action in the result.
5656
[Parameter( ParameterSetName = 'Single' )]
5757
[Switch]$IncludeDiagramDetails,
58+
# Show all assets, including those that have been deleted.
5859
[Parameter( ParameterSetName = 'Multi')]
5960
[Switch]$ShowAll
6061
)

Public/Get/Get-HaloOutcome.ps1

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,42 @@
1-
# Get-HaloOutcome.ps1
1+
#Requires -Version 7
22
function Get-HaloOutcome {
3+
<#
4+
.SYNOPSIS
5+
Gets outcomes from the Halo API.
6+
.DESCRIPTION
7+
Retrieves outcomes from the Halo API - supports a variety of filtering parameters.
8+
.OUTPUTS
9+
A powershell object containing the response.
10+
#>
311
[CmdletBinding( DefaultParameterSetName = 'Multi' )]
412
[OutputType([Object])]
513
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')]
614
Param(
15+
# The id of the outcome to retrieve.
716
[Parameter( ParameterSetName = 'Single', Mandatory = $True )]
8-
[int64]$OutcomeID,
17+
[int64]$OutcomeId,
18+
# The number of results to return.
919
[Parameter( ParameterSetName = 'Multi' )]
1020
[int64]$Count,
21+
# Enable pagination.
1122
[Parameter( ParameterSetName = 'Multi' )]
1223
[Alias('pageinate')]
1324
[switch]$Paginate,
25+
# The number of results per page.
1426
[Parameter( ParameterSetName = 'Multi' )]
1527
[Alias('page_size')]
1628
[int32]$PageSize,
29+
# The page number to return.
1730
[Parameter( ParameterSetName = 'Multi' )]
1831
[Alias('page_no')]
1932
[int32]$PageNo,
33+
# The field to order results by.
2034
[Parameter( ParameterSetName = 'Multi' )]
2135
[string]$Order,
36+
# Order results in descending order (respects the field choice in '-Order')
2237
[Parameter( ParameterSetName = 'Multi' )]
2338
[switch]$OrderDesc,
39+
# Include details in the response.
2440
[Parameter( ParameterSetName = 'Single' )]
2541
[switch]$IncludeDetails
2642
)

Public/Get/Get-HaloTicketRules.ps1

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ function Get-HaloTicketRules {
1616
[Parameter( ParameterSetName = 'Single', Mandatory = $True )]
1717
[int64]$RuleID,
1818
[Parameter( ParameterSetName = 'Single' )]
19+
# Include details in the response.
1920
[switch]$IncludeDetails,
21+
# Include criteria info in the response.
2022
[Parameter( ParameterSetName = 'Single' )]
2123
[switch]$IncludeCriteriaInfo,
22-
# Include Workflow Step Rules
24+
# Exclude Workflow Step Rules
2325
[Parameter( ParameterSetName = 'Multi')]
2426
[switch]$ExcludeWorkflow,
25-
# ShowAll
27+
# Show all rules, including those that have been deleted.
2628
[Parameter( ParameterSetName = 'Multi' )]
2729
[switch]$ShowAll
2830
)

Public/New/New-HaloOutcome.ps1

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# New-HaloOutcome.ps1
1+
#Requires -Version 7
22
Function New-HaloOutcome {
3+
<#
4+
.SYNOPSIS
5+
Creates one or more outcomes via the Halo API.
6+
.DESCRIPTION
7+
Function to send a outcome creation request to the Halo API
8+
.OUTPUTS
9+
Outputs an object containing the response from the web request.
10+
#>
311
[CmdletBinding( SupportsShouldProcess = $True )]
412
[OutputType([Object[]])]
513
Param (
14+
# Object or array of objects containing properties and values used to create one or more new outcomes.
615
[Parameter( Mandatory = $True )]
716
[Object[]]$Outcome
817
)

0 commit comments

Comments
 (0)