diff --git a/appveyor.yml b/appveyor.yml index f9ed78c..c16c57c 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -10,8 +10,9 @@ # This tells AppVeyor that we need WMF 5 and PowerShell 5.0 os: WMF 5 -#environment: - # To encrypt a value in AppVeyor, go to the Account menu and choose "Encrypt data" +environment: + PSGalleryAPIKey: + secure: UdM6qhf5B0G8liHhUrwWERCZr44iSqmg4jUq0lwlTjZs4KyeoiwnBzdej0phqIAm version: 1.0.{build} @@ -58,3 +59,17 @@ build_script: test_script: - ps: Invoke-Build -Task Test +before_deploy: + - ps: Invoke-Build -Task Deploy + +deploy: + provider: GitHub + release: v$(appveyor_build_version) + description: '' + auth_token: + secure: m72Ke3nJcSxZkc36UwRIw+q0NtNvERfQYHZUBNDvLP/kjW+mWmVueR6tmgBujyBM + draft: false + prerelease: false + on: + branch: master # release from master branch only + appveyor_repo_tag: false # deploy on tag push only \ No newline at end of file diff --git a/docs/Get-Categories.md b/docs/Get-Category.md similarity index 92% rename from docs/Get-Categories.md rename to docs/Get-Category.md index da7ecd7..bbbca5a 100644 --- a/docs/Get-Categories.md +++ b/docs/Get-Category.md @@ -5,7 +5,7 @@ online version: schema: 2.0.0 --- -# Get-Categories +# Get-Category ## SYNOPSIS {{Fill in the Synopsis}} @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Categories [-url] [-apiKey] +Get-Category [-url] [-apiKey] ``` ## DESCRIPTION diff --git a/docs/Get-Manufacturers.md b/docs/Get-Manufacturer.md similarity index 91% rename from docs/Get-Manufacturers.md rename to docs/Get-Manufacturer.md index 9e32100..f29d362 100644 --- a/docs/Get-Manufacturers.md +++ b/docs/Get-Manufacturer.md @@ -5,7 +5,7 @@ online version: schema: 2.0.0 --- -# Get-Manufacturers +# Get-Manufacturer ## SYNOPSIS {{Fill in the Synopsis}} @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Manufacturers [-url] [-apiKey] +Get-Manufacturer [-url] [-apiKey] ``` ## DESCRIPTION diff --git a/docs/Get-Models.md b/docs/Get-Model.md similarity index 93% rename from docs/Get-Models.md rename to docs/Get-Model.md index 15880d0..215ba79 100644 --- a/docs/Get-Models.md +++ b/docs/Get-Model.md @@ -5,7 +5,7 @@ online version: schema: 2.0.0 --- -# Get-Models +# Get-Model ## SYNOPSIS {{Fill in the Synopsis}} @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Models [-url] [-apiKey] +Get-Model [-url] [-apiKey] ``` ## DESCRIPTION diff --git a/docs/Get-Users.md b/docs/Get-User.md similarity index 95% rename from docs/Get-Users.md rename to docs/Get-User.md index ea1f5f9..31ccdb6 100644 --- a/docs/Get-Users.md +++ b/docs/Get-User.md @@ -5,7 +5,7 @@ online version: schema: 2.0.0 --- -# Get-Users +# Get-User ## SYNOPSIS # Gets a list of Snipe-it Users @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Users [-url] [-apiKey] +Get-User [-url] [-apiKey] ``` ## DESCRIPTION diff --git a/docs/Invoke-Method.md b/docs/Invoke-Method.md deleted file mode 100644 index 94145fa..0000000 --- a/docs/Invoke-Method.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: -schema: 2.0.0 ---- - -# Invoke-Method - -## SYNOPSIS -Extracted invokation of the REST method to own function. - -## SYNTAX - -``` -Invoke-Method [-URi] [[-Method] ] [[-Body] ] [[-Token] ] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -URi -REST API to invoke - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Method -Method of the invokation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: GET -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Body of the request - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Token -{{Fill Token Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS - diff --git a/docs/New-Asset.md b/docs/New-Asset.md index afea065..30fbb22 100644 --- a/docs/New-Asset.md +++ b/docs/New-Asset.md @@ -14,7 +14,7 @@ schema: 2.0.0 ``` New-Asset [-Name] [-Status_id] [-Model_id] [-url] [-apiKey] - [[-customfields] ] + [[-customfields] ] [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -31,6 +31,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -Model_id {{Fill Model_id Description}} @@ -76,6 +91,22 @@ 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 +``` + ### -apiKey {{Fill apiKey Description}} diff --git a/docs/New-Component.md b/docs/New-Component.md index 811c3a3..8d4bba7 100644 --- a/docs/New-Component.md +++ b/docs/New-Component.md @@ -14,6 +14,7 @@ schema: 2.0.0 ``` New-Component [-name] [-category_id] [-qty] [-url] [-apiKey] + [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -30,6 +31,37 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -apiKey {{Fill apiKey Description}} diff --git a/docs/New-Manufacturer.md b/docs/New-Manufacturer.md index 743270b..5616130 100644 --- a/docs/New-Manufacturer.md +++ b/docs/New-Manufacturer.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -New-Manufacturer [-Name] [-url] [-apiKey] +New-Manufacturer [-Name] [-url] [-apiKey] [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -30,6 +30,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -Name {{Fill Name Description}} @@ -45,6 +60,22 @@ 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 +``` + ### -apiKey {{Fill apiKey Description}} diff --git a/docs/New-Model.md b/docs/New-Model.md index 3295758..06b064b 100644 --- a/docs/New-Model.md +++ b/docs/New-Model.md @@ -14,7 +14,7 @@ schema: 2.0.0 ``` New-Model [-name] [-category_id] [-manufacturer_id] [-fieldset_id] - [-url] [-apiKey] + [-url] [-apiKey] [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -31,6 +31,37 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -apiKey {{Fill apiKey Description}} diff --git a/docs/Set-Asset.md b/docs/Set-Asset.md index 53d4c7a..d578e3b 100644 --- a/docs/Set-Asset.md +++ b/docs/Set-Asset.md @@ -14,7 +14,7 @@ schema: 2.0.0 ``` Set-Asset [-id] [-Name] [-Status_id] [-Model_id] [-url] - [-apiKey] [[-customfields] ] + [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -31,6 +31,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -Model_id {{Fill Model_id Description}} @@ -76,6 +91,22 @@ 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 +``` + ### -apiKey {{Fill apiKey Description}} diff --git a/docs/Set-AssetOwner.md b/docs/Set-AssetOwner.md index d22c8e1..1e3b9f2 100644 --- a/docs/Set-AssetOwner.md +++ b/docs/Set-AssetOwner.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Set-AssetOwner [-id] [-user_id] [-url] [-apiKey] +Set-AssetOwner [-id] [-user_id] [-url] [-apiKey] [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -30,6 +30,37 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -apiKey {{Fill apiKey Description}} diff --git a/docs/Update-Component.md b/docs/Set-Component.md similarity index 65% rename from docs/Update-Component.md rename to docs/Set-Component.md index a346a1b..79a41d0 100644 --- a/docs/Update-Component.md +++ b/docs/Set-Component.md @@ -5,7 +5,7 @@ online version: schema: 2.0.0 --- -# Update-Component +# Set-Component ## SYNOPSIS {{Fill in the Synopsis}} @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Update-Component [-id] [-qty] [-url] [-apiKey] +Set-Component [-id] [-qty] [-url] [-apiKey] [-WhatIf] [-Confirm] ``` ## DESCRIPTION @@ -30,6 +30,37 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -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 +``` + ### -apiKey {{Fill apiKey Description}}