From cc951b618af99fda1ee9f170c6b737e21ff3dbaa Mon Sep 17 00:00:00 2001 From: Mike Madeja Date: Fri, 20 Mar 2026 00:23:43 -0500 Subject: [PATCH] updated some synopsis --- PiHoleShell/PiHoleShell.psm1 | 2 +- PiHoleShell/Public/Actions.ps1 | 8 ++++---- PiHoleShell/Public/Authentication.ps1 | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/PiHoleShell/PiHoleShell.psm1 b/PiHoleShell/PiHoleShell.psm1 index d371a2d..0a5b5d4 100644 --- a/PiHoleShell/PiHoleShell.psm1 +++ b/PiHoleShell/PiHoleShell.psm1 @@ -16,7 +16,7 @@ foreach ($File in $PrivateFunctions) { Export-ModuleMember -Function @( #Actions.ps1 - 'Update-PiHoleActionsGravity', 'Invoke-PiHoleFlushLog' ` + 'Update-PiHoleActionsGravity', 'Invoke-PiHoleFlushNetwork' ` #Authentication.ps1 'Remove-PiHoleCurrentAuthSession' , 'Get-PiHoleCurrentAuthSession', 'Remove-PiHoleAuthSession', ` #GroupManagement.ps1 diff --git a/PiHoleShell/Public/Actions.ps1 b/PiHoleShell/Public/Actions.ps1 index a45ddd8..738e169 100644 --- a/PiHoleShell/Public/Actions.ps1 +++ b/PiHoleShell/Public/Actions.ps1 @@ -1,7 +1,7 @@ function Update-PiHoleActionsGravity { <# .SYNOPSIS -https://TODO +https://ftl.pi-hole.net/master/docs/#post-/action/gravity #> #Work In Progress @@ -56,10 +56,10 @@ https://TODO } } -function Invoke-PiHoleFlushLog { +function Invoke-PiHoleFlushNetwork { <# .SYNOPSIS -https://dns1.local:8489/api/docs/#post-/action/flush/logs +https://ftl.pi-hole.net/master/docs/#post-/action/flush/network .DESCRIPTION Flushes the Pi-hole log file (/var/log/pihole/pihole.log). @@ -77,7 +77,7 @@ Set to $true to skip SSL certificate validation This will dump the response instead of the formatted object .EXAMPLE -Invoke-PiHoleFlushLogs -PiHoleServer "http://pihole.domain.com:8080" -Password "fjdsjfldsjfkldjslafjskdl" +Invoke-PiHoleFlushNetwork -PiHoleServer "http://pihole.domain.com:8080" -Password "fjdsjfldsjfkldjslafjskdl" #> [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'Flushes PiHole logs')] diff --git a/PiHoleShell/Public/Authentication.ps1 b/PiHoleShell/Public/Authentication.ps1 index 1a31236..a8e4d8a 100644 --- a/PiHoleShell/Public/Authentication.ps1 +++ b/PiHoleShell/Public/Authentication.ps1 @@ -32,7 +32,7 @@ function Request-PiHoleAuth { function Get-PiHoleCurrentAuthSession { <# .SYNOPSIS -https://ftl.pi-hole.net/development-v6/docs/#get-/auth +https://ftl.pi-hole.net/master/docs/#get-/auth .PARAMETER PiHoleServer The URL to the PiHole Server, for example "http://pihole.domain.com:8080", or "http://192.168.1.100" @@ -118,7 +118,7 @@ Get-PiHoleCurrentAuthSession -PiHoleServer "http://pihole.domain.com:8080" -Pass function Remove-PiHoleAuthSession { <# .SYNOPSIS -https://ftl.pi-hole.net/development-v6/docs/#get-/auth +https://ftl.pi-hole.net/master/docs/#get-/auth .PARAMETER PiHoleServer The URL to the PiHole Server, for example "http://pihole.domain.com:8080", or "http://192.168.1.100"