Skip to content

Commit 5c8bff6

Browse files
adrianwellsCalebAlbers
authored andcommitted
Guidance for versioning in CONTRIBUTING.md and fix for Remove-ITGlueAPIKey (#37)
* Add Support for Passwords API With the release of API v1.8.0, a new Passwords endpoint was added. This update uncovers that endpoint in the PowerShell module with the addition of the following functions: - `New-ITGluePasswords` - `Get-ITGluePasswords` - `Set-ITGluePasswords` Release notes for the Passwords api are available [here](https://kb.itglue.com/hc/en-us/articles/360001797531-Release-Note s-1-8-0-API). —————— The Module Version was also updated to reflect the API version it supports. * Add support for EU API endpoints API endpoints have been added for deployments in the EU datacenter. This update uncovers the ability to use the EU API links by use of a `-data_center` (or `-dc`) option on the `Add-ITGlueBaseURI` function. This optional argument takes `EU` and `US` as options, however the US datacenter is still kept as the default even if no arguments are given. — HTTPS is also set by default for both the US and EU data centers. * Added enhanced filtering capability Most endpoints (especially Index/Show, and Update) now allow for expanded filtering capabilities. This updated exposes those new capabilities as command parameters. * Fixed Configurations Return Data Fixed a bug that was pointed out that caused incorrect data to be returned from the `Get-ITGlueConfigurations’ function. * Compatability Update All resources now match the current API spec given at https://api.itglue.com/developer. This includes enhanced bulk update, bulk destroy, and filtering capabilities. Thanks to @TheMattCollins0 for changes to make adding an API key via command line easier. * Added file to resolve Import-Module HRESULT: 0x8013104 * Sync'ing master with 2.0.0 release * Fix to remove variable correclty and minor spacing edits * Added Semantic Versioning guidance * Fix Remove-ITGlueAPIKey and minor edits * Increment version for recent patch in APIKey.ps1
1 parent 08a49b3 commit 5c8bff6

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@
1212

1313
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
1414

15+
* Please update the ModuleVersion using [Semantic Versioning](https://semver.org) in the ITGlueAPI.psd1 file. Given a version number MAJOR.MINOR.PATCH:
16+
17+
* MAJOR version when you make incompatible API changes,
18+
* MINOR version when you add functionality in a backwards-compatible manner, and
19+
* PATCH version when you make backwards-compatible bug fixes.
20+
* Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
21+
1522
## **Do you intend to add a new feature or change an existing one?**
1623

1724
* Suggest your change by creating a GitHub issue tagged with "Enhancement"

ITGlueAPI/ITGlueAPI.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ RootModule = '.\ITGlueAPI.psm1'
1717
# -- MAJOR version when you make incompatible API changes,
1818
# -- MINOR version when you add functionality in a backwards-compatible manner, and
1919
# -- PATCH version when you make backwards-compatible bug fixes.
20-
ModuleVersion = '2.0.0'
20+
ModuleVersion = '2.0.1'
2121

2222
# ID used to uniquely identify this module
2323
#GUID = ''

ITGlueAPI/Internal/APIKey.ps1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ function Add-ITGlueAPIKey {
77
[string]$Api_Key
88
)
99
if ($Api_Key) {
10-
$x_api_key = ConvertTo-SecureString $Api_Key -AsPlainText -Force
10+
$x_api_key = ConvertTo-SecureString $Api_Key -AsPlainText -Force
1111

12-
Set-Variable -Name "ITGlue_API_Key" -Value $x_api_key -Option ReadOnly -Scope global -Force
12+
Set-Variable -Name "ITGlue_API_Key" -Value $x_api_key -Option ReadOnly -Scope global -Force
1313
}
1414
else {
1515
Write-Host "Please enter your API key:"
1616
$x_api_key = Read-Host -AsSecureString
1717

18-
Set-Variable -Name "ITGlue_API_Key" -Value $x_api_key -Option ReadOnly -Scope global -Force
18+
Set-Variable -Name "ITGlue_API_Key" -Value $x_api_key -Option ReadOnly -Scope global -Force
1919
}
2020
}
2121

2222
function Remove-ITGlueAPIKey {
23-
Remove-Variable -Name "ITGlue_API_Key" -Force
23+
Remove-Variable -Name "ITGlue_API_Key" -Scope global -Force
2424
}
2525

2626
function Get-ITGlueAPIKey {
@@ -32,4 +32,4 @@ function Get-ITGlueAPIKey {
3232
}
3333
}
3434

35-
New-Alias -Name Set-ITGlueAPIKey -Value Add-ITGlueAPIKey
35+
New-Alias -Name Set-ITGlueAPIKey -Value Add-ITGlueAPIKey

0 commit comments

Comments
 (0)