From 69ac809fb0fd64d06aa5eeb71e72373b85694159 Mon Sep 17 00:00:00 2001
From: Petri Asikainen <petri.asikainen@sataedu.fi>
Date: Mon, 24 May 2021 11:06:17 +0300
Subject: [PATCH] Helper function to update existing SnipeItPS scripts

---
 SnipeitPS/Public/Update-SnipeItAlias.ps1 | 20 +++++-
 docs/SnipeItPS.md                        |  3 +
 docs/Update-SnipeItAlias.md              | 91 ++++++++++++++++++++++++
 3 files changed, 113 insertions(+), 1 deletion(-)
 create mode 100644 docs/Update-SnipeItAlias.md

diff --git a/SnipeitPS/Public/Update-SnipeItAlias.ps1 b/SnipeitPS/Public/Update-SnipeItAlias.ps1
index dcc23bf..865f7da 100644
--- a/SnipeitPS/Public/Update-SnipeItAlias.ps1
+++ b/SnipeitPS/Public/Update-SnipeItAlias.ps1
@@ -1,3 +1,21 @@
+<#
+.SYNOPSIS
+Replaces old SnipeItPS commands with new ones
+
+.DESCRIPTION
+Replaces old SnipeItPS commands with new ones
+
+.PARAMETER String
+Input string
+
+.EXAMPLE
+Get-Content [your-script.ps1] | Update-SnipeItAlias | Out-File [new-script-name.ps1]
+Replaces old command from file "your-script.ps1" and creates new script "new-script-name.ps1"
+After testing new file you can replace old file with new.
+
+#>
+
+
 function Update-SnipeItAlias()
 {
     [CmdletBinding(
@@ -28,7 +46,7 @@ function Update-SnipeItAlias()
         }
     }
     end{
-        Write-Verbose "..replacing done 1 "
+        Write-Verbose "..replacing done"
     }
 
 
diff --git a/docs/SnipeItPS.md b/docs/SnipeItPS.md
index 2189f2f..4b03e7d 100644
--- a/docs/SnipeItPS.md
+++ b/docs/SnipeItPS.md
@@ -122,3 +122,6 @@ Updates Model on Snipe-it asset system
 ### [Set-SnipeItUser](Set-SnipeItUser.md)
 Creates a new user
 
+### [Update-SnipeItAlias](Update-SnipeItAlias.md)
+{{ Fill in the Synopsis }}
+
diff --git a/docs/Update-SnipeItAlias.md b/docs/Update-SnipeItAlias.md
new file mode 100644
index 0000000..607bdd4
--- /dev/null
+++ b/docs/Update-SnipeItAlias.md
@@ -0,0 +1,91 @@
+---
+external help file: SnipeItPS-help.xml
+Module Name: SnipeitPS
+online version:
+schema: 2.0.0
+---
+
+# Update-SnipeItAlias
+
+## SYNOPSIS
+{{ Fill in the Synopsis }}
+
+## SYNTAX
+
+```
+Update-SnipeItAlias [-String] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{ Fill in the Description }}
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> {{ Add example code here }}
+```
+
+{{ Add example description here }}
+
+## PARAMETERS
+
+### -String
+{{ Fill String Description }}
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+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 cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+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).
+
+## INPUTS
+
+### System.String[]
+
+## OUTPUTS
+
+### System.Object
+## NOTES
+
+## RELATED LINKS