Merge pull request #155 from snazy2000/develop

Corrected examples
snazy2000 · Jun 10, 2021 · a69a583 · a69a583
2 parents 19fb68f + 0d201e6
commit a69a583
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/SnipeitPS/Public/New-SnipeitAsset.ps1 b/SnipeitPS/Public/New-SnipeitAsset.ps1
@@ -61,7 +61,7 @@ New-SnipeitAsset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
 Specifying asset tag when creating asset
 
 .EXAMPLE
-New-SnipeitAsset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
+New-SnipeitAsset -status_id 1 -model_id 1 -name "Machine1" -customfields = @{ "_snipeit_os_5" = "Windows 10 Pro" }
 Using customfields when creating asset.
 #>
 
@@ -120,6 +120,7 @@ function New-SnipeitAsset()
         [parameter(mandatory = $true)]
         [string]$apiKey,
 
+        [Alias('CustomValues')]
         [hashtable] $customfields
     )
 

diff --git a/SnipeitPS/Public/Set-SnipeitAsset.ps1 b/SnipeitPS/Public/Set-SnipeitAsset.ps1
@@ -69,7 +69,7 @@
     Set-SnipeitAsset -id 1 -status_id 1 -model_id 1 -name "Machine1"
 
     .EXAMPLE
-    Set-SnipeitAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
+    Set-SnipeitAsset -id 1 -name "Machine1" -customfields =  @{ "_snipeit_os_5" = "Windows 10 Pro" ; "_snipeit_os_version" = "1909" }
 
     .EXAMPLE
     Get-SnipeitAsset -serial 12345678 | Set-SnipeitAsset -notes 'Just updated'
@@ -101,7 +101,6 @@ function Set-SnipeitAsset()
 
         [string]$serial,
 
-
         [string]$order_number,
 
         [int]$warranty_months,
@@ -127,6 +126,7 @@ function Set-SnipeitAsset()
         [parameter(mandatory = $true)]
         [string]$apiKey,
 
+        [Alias('CustomValues')]
         [hashtable] $customfields
     )
     begin{

diff --git a/docs/New-SnipeitAsset.md b/docs/New-SnipeitAsset.md
@@ -97,7 +97,7 @@ Use internal field names from snipeit .You can use Get-CustomField to get intern
 ```yaml
 Type: Hashtable
 Parameter Sets: (All)
-Aliases:
+Aliases: CustomValues
 
 Required: False
 Position: 16

diff --git a/docs/Set-SnipeitAsset.md b/docs/Set-SnipeitAsset.md
@@ -110,7 +110,7 @@ Hastable of custom fields and extra fields that need passing through to Snipeit
 ```yaml
 Type: Hashtable
 Parameter Sets: (All)
-Aliases:
+Aliases: CustomValues
 
 Required: False
 Position: 20