Skip to content

Commit

Permalink
Guidance for versioning in CONTRIBUTING.md and fix for Remove-ITGlueA…
Browse files Browse the repository at this point in the history
…PIKey (#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
  • Loading branch information
adrianwells authored and CalebAlbers committed Oct 4, 2018
1 parent 08a49b3 commit 5c8bff6
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@

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

* Please update the ModuleVersion using [Semantic Versioning](https://semver.org) in the ITGlueAPI.psd1 file. Given a version number MAJOR.MINOR.PATCH:

* MAJOR version when you make incompatible API changes,
* MINOR version when you add functionality in a backwards-compatible manner, and
* PATCH version when you make backwards-compatible bug fixes.
* Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

## **Do you intend to add a new feature or change an existing one?**

* Suggest your change by creating a GitHub issue tagged with "Enhancement"
Expand Down
2 changes: 1 addition & 1 deletion ITGlueAPI/ITGlueAPI.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ RootModule = '.\ITGlueAPI.psm1'
# -- MAJOR version when you make incompatible API changes,
# -- MINOR version when you add functionality in a backwards-compatible manner, and
# -- PATCH version when you make backwards-compatible bug fixes.
ModuleVersion = '2.0.0'
ModuleVersion = '2.0.1'

# ID used to uniquely identify this module
#GUID = ''
Expand Down
10 changes: 5 additions & 5 deletions ITGlueAPI/Internal/APIKey.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ function Add-ITGlueAPIKey {
[string]$Api_Key
)
if ($Api_Key) {
$x_api_key = ConvertTo-SecureString $Api_Key -AsPlainText -Force
$x_api_key = ConvertTo-SecureString $Api_Key -AsPlainText -Force

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

Set-Variable -Name "ITGlue_API_Key" -Value $x_api_key -Option ReadOnly -Scope global -Force
Set-Variable -Name "ITGlue_API_Key" -Value $x_api_key -Option ReadOnly -Scope global -Force
}
}

function Remove-ITGlueAPIKey {
Remove-Variable -Name "ITGlue_API_Key" -Force
Remove-Variable -Name "ITGlue_API_Key" -Scope global -Force
}

function Get-ITGlueAPIKey {
Expand All @@ -32,4 +32,4 @@ function Get-ITGlueAPIKey {
}
}

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

0 comments on commit 5c8bff6

Please sign in to comment.