From e9beab26189476b60ed7acdcb35f2514a5b15742 Mon Sep 17 00:00:00 2001 From: codaamok Date: Mon, 14 Feb 2022 08:40:24 +0000 Subject: [PATCH] Fixed minimum version check and docs --- CHANGELOG.md | 3 +++ src/Private/GetShlinkConnection.ps1 | 2 +- src/Public/Get-ShlinkVisitsNonOrphan.ps1 | 12 ++++++------ 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d0bb341..950e8d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Fixed +- Updated minimum version check of Shlink instance to 3.0.0 +- Updated comment based help for `Get-ShlinkVisistNonOrphan` as it was copied from `Get-ShlinkVisitsOprhan` ## [0.9.0] - 2022-02-13 ### Added diff --git a/src/Private/GetShlinkConnection.ps1 b/src/Private/GetShlinkConnection.ps1 index 639dc42..da7cf78 100644 --- a/src/Private/GetShlinkConnection.ps1 +++ b/src/Private/GetShlinkConnection.ps1 @@ -24,7 +24,7 @@ function GetShlinkConnection { } } - $Script:MinSupportedShlinkVersion = [Version]"2.9.0" + $Script:MinSupportedShlinkVersion = [Version]"3.0.0" if (-not ("System.Web.HttpUtility" -as [Type])) { Add-Type -AssemblyName "System.Web" -ErrorAction "Stop" diff --git a/src/Public/Get-ShlinkVisitsNonOrphan.ps1 b/src/Public/Get-ShlinkVisitsNonOrphan.ps1 index d7a1c8a..179a11f 100644 --- a/src/Public/Get-ShlinkVisitsNonOrphan.ps1 +++ b/src/Public/Get-ShlinkVisitsNonOrphan.ps1 @@ -1,9 +1,9 @@ function Get-ShlinkVisitsNonOrphan { <# .SYNOPSIS - Get the list of visits to invalid short URLs, the base URL or any other 404. + Get the list of visits to all valid short URLs. .DESCRIPTION - Get the list of visits to invalid short URLs, the base URL or any other 404. + Get the list of visits to all valid short URLs. .PARAMETER StartDate A datetime object to filter the visit data where the start date is equal or greater than this value. .PARAMETER EndDate @@ -17,13 +17,13 @@ function Get-ShlinkVisitsNonOrphan { A SecureString object of your Shlink server's API key. It is not required to use this parameter for every use of this function. When it is used once for any of the functions in the PSShlink module, its value is retained throughout the life of the PowerShell session and its value is only accessible within the module's scope. .EXAMPLE - PS C:\> Get-ShlinkVisitsOrphan + PS C:\> Get-ShlinkVisitsNonOrphan - Get the list of visits to invalid short URLs, the base URL or any other 404. + Get the list of visits to all valid short URLs. .EXAMPLE - PS C:\> Get-ShlinkVisitsOrphan -StartDate (Get-Date "2020-11-01") -EndDate (Get-Date "2020-12-01") -ExcludeBots + PS C:\> Get-ShlinkVisitsNonOrphan -StartDate (Get-Date "2020-11-01") -EndDate (Get-Date "2020-12-01") -ExcludeBots - Get the list of visits to invalid short URLs, the base URL or any other 404, for the whole of November and excluding bots/crawlers. + Get the list of visits to all valid short URLs for the whole of November and excluding bots/crawlers. .INPUTS This function does not accept pipeline input. .OUTPUTS