Fixes for PR comments

AtlassianPS · Feb 22, 2019 · c2536e8 · c2536e8
1 parent 9324d34
commit c2536e8
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 9 deletions.
diff --git a/ConfluencePS/Private/Copy-CommonParameter.ps1 b/ConfluencePS/Private/Copy-CommonParameter.ps1
@@ -1,10 +1,28 @@
 function Copy-CommonParameter
 {
+    <#
+    .SYNOPSIS
+    This is a helper function to assist in creating a hashtable for splatting parameters to inner function calls.
+
+    .DESCRIPTION
+    This command copies all of the keys of a hashtable to a new hashtable if the key name matches the DefaultParameter
+    or the AdditionalParameter values. This function is designed to help select only function parameters that have been
+    set, so they can be passed to inner functions if and only if they have been set.
+
+    .EXAMPLE
+    PS C:\> Copy-CommonParameter -InputObject $PSBoundParameters
+
+    Returns a hashtable that contains all of the bound default parameters.
+
+    .EXAMPLE
+    PS C:\> Copy-CommonParameter -InputObject $PSBoundParameters -AdditionalParameter "ApiUri"
+
+    Returns a hashtable that contains all of the bound default parameters and the "ApiUri" parameter.
+    #>
     [CmdletBinding( SupportsShouldProcess = $false )]
     [OutputType(
         [hashtable]
     )]
-    #[System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')]
     param
     (
         [Parameter(Mandatory = $true)]

diff --git a/ConfluencePS/Public/Get-ChildPage.ps1 b/ConfluencePS/Public/Get-ChildPage.ps1
@@ -53,13 +53,13 @@ function Get-ChildPage {
         }
 
         $iwParameters = Copy-CommonParameter -InputObject $PSBoundParameters
-        $iwParameters['Uri']           = if ($Recurse.IsPresent) {"$ApiUri/content/{0}/descendant/page" -f $PageID} else {"$ApiUri/content/{0}/child/page" -f $PageID}
-        $iwParameters['Method']        = 'Get'
+        $iwParameters['Uri'] = if ($Recurse.IsPresent) {"$ApiUri/content/{0}/descendant/page" -f $PageID} else {"$ApiUri/content/{0}/child/page" -f $PageID}
+        $iwParameters['Method'] = 'Get'
         $iwParameters['GetParameters'] = @{
-                                            expand = "space,version,body.storage,ancestors"
-                                            limit  = $PageSize
-                                         }
-        $iwParameters['OutputType']    = [ConfluencePS.Page]
+            expand = "space,version,body.storage,ancestors"
+            limit  = $PageSize
+        }
+        $iwParameters['OutputType'] = [ConfluencePS.Page]
 
         # Paging
         ($PSCmdlet.PagingParameters | Get-Member -MemberType Property).Name | ForEach-Object {

diff --git a/ConfluencePS/Public/New-Page.ps1 b/ConfluencePS/Public/New-Page.ps1
@@ -54,6 +54,9 @@ function New-Page {
         Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started"
 
         $resourceApi = "$ApiUri/content"
+
+        #this is the splat hashtable that passes the auth and uri to calls but not Invoke-Method, i.e. Get-Page
+        $authAndApiUri = Copy-CommonParameter -InputObject $PSBoundParameters -AdditionalParameter "ApiUri"
     }
 
     PROCESS {
@@ -96,14 +99,12 @@ function New-Page {
 
                 if (($ParentID) -and !($SpaceKey)) {
                     Write-Verbose "[$($MyInvocation.MyCommand.Name)] SpaceKey not specified. Retrieving from Get-ConfluencePage -PageID $ParentID"
-                    $authAndApiUri = Copy-CommonParameter -InputObject $PSBoundParameters -AdditionalParameter "ApiUri"
                     $SpaceKey = (Get-Page -PageID $ParentID @authAndApiUri).Space.Key
                 }
 
                 # If -Convert is flagged, call ConvertTo-ConfluenceStorageFormat against the -Body
                 if ($Convert) {
                     Write-Verbose '[$($MyInvocation.MyCommand.Name)] -Convert flag active; converting content to Confluence storage format'
-                    $authAndApiUri = Copy-CommonParameter -InputObject $PSBoundParameters -AdditionalParameter "ApiUri"
                     $Body = ConvertTo-StorageFormat -Content $Body @authAndApiUri
                 }