Skip to content

Commit

Permalink
Fixed minimum version check and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codaamok committed Feb 14, 2022
1 parent 6e307fd commit e9beab2
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Private/GetShlinkConnection.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
12 changes: 6 additions & 6 deletions src/Public/Get-ShlinkVisitsNonOrphan.ps1
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down

0 comments on commit e9beab2

Please sign in to comment.