Minor ITGlueAPI.psd1 file edits #27
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 8 commits
August 12, 2018 21:09
|
Hey @adrianwells, I like your idea for the versioning. I went ahead and did some looking. I think Semantic Versioning would be a good fit. The gist is as follows:
The fixes given in 5d4ceb4 reflect this, especially given the code update I've just done has some breaking aspects (outlined in 29e7dda). I'm going to create a pull request from itglue:development into itglue:master. The code should be good to go, though I'll give it a day for one final review prior to merging. |
CalebAlbers
added a commit
that referenced
this pull request
Sep 18, 2018
* Update development branch with current proposed updates (#22) * 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 * Support Nested Relationships Route for Show * Update Documents in Development branch (#25) * Markdown formatting edits and update doc for additional commands * Markdown formatting edits * Update to Current API Standards This update overhauls all endpoints to bring them current with the IT Glue API. Any and all filtering, options, and endpoints are covered. :warning: This is a **breaking** update. In order to better match the API docs that IT Glue presents at https://api.itglue.com/development, the `$data` input taken for module functions will *only* consist of the information present in the `data` array, rather than requiring what was effectively a `$body` request with a data array nested as a value. Some other styalistic choices were propogated throughout the code as well. For example, the `-important` parameter that some functions support now is a boolean. You no longer have to pass `0` or `1`, but can also pass `$true`, `$false`, or any other PowerShell boolean equivalent. * Minor ITGlueAPI.psd1 file edits (#27) * Markdown formatting edits and update doc for additional commands * Markdown formatting edits * Intial check in of basic tests for the module * Expanded testing * Minor edits * Revert "Expanded testing" This reverts commit 6c8f31e. * Revert "Intial check in of basic tests for the module" This reverts commit ead9f25. * Update to 2.0.0 The module version has been updated to `2.0.0`. From now on, Semantic Versioning (https://semver.org) should be followed on the module. Given a version number MAJOR.MINOR.PATCH, increment the: 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. * Implement Error Handling on REST Headers This implements the fix suggested by @ecspresso (thanks!!) and closes #29. Co-Authored-By: Emile <[email protected]>
CalebAlbers
pushed a commit
that referenced
this pull request
Oct 4, 2018
* 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 * Update development branch with current proposed updates (#22) * 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 * Support Nested Relationships Route for Show * Markdown formatting edits and update doc for additional commands * Markdown formatting edits * Intial check in of basic tests for the module * Expanded testing * Minor edits * Update Documents in Development branch (#25) * Markdown formatting edits and update doc for additional commands * Markdown formatting edits * Revert "Expanded testing" This reverts commit 6c8f31e. * Revert "Intial check in of basic tests for the module" This reverts commit ead9f25. * Corrected test for test files * Update to Current API Standards This update overhauls all endpoints to bring them current with the IT Glue API. Any and all filtering, options, and endpoints are covered. :warning: This is a **breaking** update. In order to better match the API docs that IT Glue presents at https://api.itglue.com/development, the `$data` input taken for module functions will *only* consist of the information present in the `data` array, rather than requiring what was effectively a `$body` request with a data array nested as a value. Some other styalistic choices were propogated throughout the code as well. For example, the `-important` parameter that some functions support now is a boolean. You no longer have to pass `0` or `1`, but can also pass `$true`, `$false`, or any other PowerShell boolean equivalent. * Minor ITGlueAPI.psd1 file edits (#27) * Markdown formatting edits and update doc for additional commands * Markdown formatting edits * Intial check in of basic tests for the module * Expanded testing * Minor edits * Revert "Expanded testing" This reverts commit 6c8f31e. * Revert "Intial check in of basic tests for the module" This reverts commit ead9f25. * Update to 2.0.0 The module version has been updated to `2.0.0`. From now on, Semantic Versioning (https://semver.org) should be followed on the module. Given a version number MAJOR.MINOR.PATCH, increment the: 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. * Updated to test to remove a check due to changes in module * Minor to cleanup error caused by debug details * Implement Error Handling on REST Headers This implements the fix suggested by @ecspresso (thanks!!) and closes #29. Co-Authored-By: Emile <[email protected]> * Sync'ing master with 2.0.0 release * Minor edit * Inital Commit * Fix to remove variable correclty and minor spacing edits * Added Semantic Versioning guidance * Initial Commit * Fix Remove-ITGlueAPIKey and minor edits * Increment version for recent patch in APIKey.ps1 * Improve testing, add variables, and minor code formatting
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@CalebAlbers, Hello. A couple minor edits to the ITGlueAPI.psd1 file as part of an effort to add some automated testing and in the process identified a few minor areas of improvement. Within this file, interested to know more about the versioning and generated on date in the psd1 file and how to keep those up to date, maybe git tags for versioning can help?