Fixed issue #208 (#220)

MethodsAndPractices · Nov 9, 2019 · 55f4d4d · 55f4d4d
1 parent 5f97cfc
commit 55f4d4d
Show file tree

Hide file tree

Showing 12 changed files with 192 additions and 229 deletions.
diff --git a/.docs/Add-VSTeamVariableGroup.md b/.docs/Add-VSTeamVariableGroup.md
@@ -79,7 +79,7 @@ if ($toVariableGroupObject) {
    Update-VSTeamVariableGroup -Body $body -ProjectName $ToProject -Id $toVariableGroupObject.id
 }
 else {
-   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject   
+   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject
 }
 
 ```
@@ -97,7 +97,7 @@ Type: String
 Parameter Sets: ByHashtable
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)

diff --git a/.docs/Update-VSTeamVariableGroup.md b/.docs/Update-VSTeamVariableGroup.md
@@ -72,7 +72,7 @@ if ($toVariableGroupObject) {
    Update-VSTeamVariableGroup -Body $body -ProjectName $ToProject -Id $toVariableGroupObject.id
 }
 else {
-   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject   
+   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject
 }
 
 ```
@@ -153,7 +153,7 @@ Type: String
 Parameter Sets: ByHashtable
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 6.4.1
+
+Fixed issue [Description on variable groups is not a required field #208](https://github.com/DarqueWarrior/vsteam/issues/208).
+
 ## 6.4.0
 
 Merged [Pull Request](https://github.com/DarqueWarrior/vsteam/pull/214) from [Louis Tourtellotte](https://github.com/quintessential5) which included the following:

diff --git a/Source/Public/Add-VSTeamVariableGroup.ps1 b/Source/Public/Add-VSTeamVariableGroup.ps1
@@ -3,7 +3,7 @@ function Add-VSTeamVariableGroup {
       [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
       [string] $Name,
 
-      [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
+      [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
       [string] $Description,
 
       [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $true, ValueFromPipelineByPropertyName = $true)]

diff --git a/Source/Public/Update-VSTeamVariableGroup.ps1 b/Source/Public/Update-VSTeamVariableGroup.ps1
@@ -7,7 +7,7 @@ function Update-VSTeamVariableGroup {
       [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
       [string] $Name,
 
-      [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
+      [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
       [string] $Description,
 
       [Parameter(ParameterSetName = 'ByHashtable', Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
@@ -39,7 +39,7 @@ function Update-VSTeamVariableGroup {
       # Bind the parameter to a friendly variable
       $ProjectName = $PSBoundParameters["ProjectName"]
 
-      
+
       if ([string]::IsNullOrWhiteSpace($Body))
       {
          $bodyAsHashtable = @{

diff --git a/Source/VSTeam.psd1 b/Source/VSTeam.psd1
@@ -12,7 +12,7 @@
    RootModule        = 'VSTeam.psm1'
 
    # Version number of this module.
-   ModuleVersion     = '6.4.0'
+   ModuleVersion     = '6.4.1'
 
    # Supported PSEditions
    # CompatiblePSEditions = @()

diff --git a/Source/en-US/VSTeam-Help.xml b/Source/en-US/VSTeam-Help.xml
diff --git a/docs/Add-VSTeamVariableGroup.md b/docs/Add-VSTeamVariableGroup.md
@@ -80,7 +80,7 @@ if ($toVariableGroupObject) {
    Update-VSTeamVariableGroup -Body $body -ProjectName $ToProject -Id $toVariableGroupObject.id
 }
 else {
-   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject   
+   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject
 }
 
 ```
@@ -112,7 +112,7 @@ Type: String
 Parameter Sets: ByHashtable
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)

diff --git a/docs/Get-VSTeamWorkItem.md b/docs/Get-VSTeamWorkItem.md
@@ -18,7 +18,7 @@ Returns one or more a work items from your project.
 ### -------------------------- EXAMPLE 1 --------------------------
 
 ```PowerShell
-PS C:\> Get-VSTeamWorkItem -Ids 47,48
+PS C:\> Get-VSTeamWorkItem -Id 47,48
 ```
 
 This command gets work items with IDs 47 and 48 by using the IDs parameter.
@@ -27,18 +27,7 @@ This command gets work items with IDs 47 and 48 by using the IDs parameter.
 
 ### -Id
 
-The id of the work item.
-
-```yaml
-Type: Int32
-Parameter Sets: ByID
-Required: True
-Accept pipeline input: true (ByPropertyName, ByValue)
-```
-
-### -Ids
-
-The id of the work item.
+The id of one or more work items.
 
 ```yaml
 Type: Int32[]
@@ -58,7 +47,7 @@ The flag to control error policy in a bulk get work items request.  The acceptab
 Type: String
 Parameter Sets: List
 Required: True
-Default value: Omit
+Default value: omit
 ```
 
 ### -Fields

diff --git a/docs/Remove-VSTeamVariableGroup.md b/docs/Remove-VSTeamVariableGroup.md
@@ -45,38 +45,6 @@ Remove-VSTeamVariableGroup @methodParameters
 
 ## PARAMETERS
 
-### -Confirm
-
-Prompts you for confirmation before running the cmdlet.
-
-```yaml
-Type: SwitchParameter
-Aliases: cf
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -Force
-
-Does not prompt
-
-```yaml
-Type: SwitchParameter
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -ProjectName
-
 ### -ProjectName
 
 Specifies the team project for which this function operates.
@@ -93,20 +61,43 @@ Required: True
 Accept pipeline input: true (ByPropertyName)
 ```
 
-### -WhatIf
-
-Shows what would happen if the cmdlet runs.
-The cmdlet is not run.
+### -Force
+
+Forces the function without confirmation
+
+```yaml
+Type: SwitchParameter
+Required: false
+Position: Named
+Accept pipeline input: false
+Parameter Sets: (All)
+```
 
-```yaml
-Type: SwitchParameter
-Aliases: wi
+### -Confirm
+
+Prompts you for confirmation before running the function.
+
+```yaml
+Type: SwitchParameter
+Required: false
+Position: Named
+Accept pipeline input: false
+Parameter Sets: (All)
+Aliases: cf
+```
 
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
+### -WhatIf
+
+Shows what would happen if the function runs.
+The function is not run.
+
+```yaml
+Type: SwitchParameter
+Required: false
+Position: Named
+Accept pipeline input: false
+Parameter Sets: (All)
+Aliases: wi
 ```
 
 ### -Id

diff --git a/docs/Remove-VSTeamWorkItem.md b/docs/Remove-VSTeamWorkItem.md
@@ -18,7 +18,7 @@ Deletes the specified work item and sends it to the Recycle Bin, so that it can
 ### -------------------------- EXAMPLE 1 --------------------------
 
 ```PowerShell
-PS C:\> Remove-VSTeamWorkItem -Ids 47,48
+PS C:\> Remove-VSTeamWorkItem -Id 47,48 -Force
 ```
 
 This command deletes work items with IDs 47 and 48 by using the IDs parameter.
@@ -34,7 +34,7 @@ This command deletes the work item with ID 47 by using the ID parameter.
 ### -------------------------- EXAMPLE 3 --------------------------
 
 ```PowerShell
-PS C:\> Remove-VSTeamWorkItem -Ids 47 -Destroy
+PS C:\> Remove-VSTeamWorkItem -Id 47 -Destroy -Force
 ```
 
 This command deletes work item with IDs 47 **permanently** by using the Destroy parameter.
@@ -43,18 +43,7 @@ This command deletes work item with IDs 47 **permanently** by using the Destroy
 
 ### -Id
 
-The id of the work item.
-
-```yaml
-Type: Int32
-Parameter Sets: ByID
-Required: True
-Accept pipeline input: true (ByPropertyName, ByValue)
-```
-
-### -Ids
-
-The id of the work item.
+The id of one or more work items.
 
 ```yaml
 Type: Int32[]
@@ -71,6 +60,45 @@ Optional parameter, if set to true, the work item is deleted permanently. **Plea
 Type: Switch
 ```
 
+### -Force
+
+Forces the function without confirmation
+
+```yaml
+Type: SwitchParameter
+Required: false
+Position: Named
+Accept pipeline input: false
+Parameter Sets: (All)
+```
+
+### -Confirm
+
+Prompts you for confirmation before running the function.
+
+```yaml
+Type: SwitchParameter
+Required: false
+Position: Named
+Accept pipeline input: false
+Parameter Sets: (All)
+Aliases: cf
+```
+
+### -WhatIf
+
+Shows what would happen if the function runs.
+The function is not run.
+
+```yaml
+Type: SwitchParameter
+Required: false
+Position: Named
+Accept pipeline input: false
+Parameter Sets: (All)
+Aliases: wi
+```
+
 ## INPUTS
 
 ### System.String

diff --git a/docs/Update-VSTeamVariableGroup.md b/docs/Update-VSTeamVariableGroup.md
@@ -73,7 +73,7 @@ if ($toVariableGroupObject) {
    Update-VSTeamVariableGroup -Body $body -ProjectName $ToProject -Id $toVariableGroupObject.id
 }
 else {
-   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject   
+   Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject
 }
 
 ```
@@ -168,7 +168,7 @@ Type: String
 Parameter Sets: ByHashtable
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)