🩹 [Patch]: Set default 'PerPage' value in the GitHubContext (#206)

MariusStorhaug · web-flow · commit 77ac2d7b4661 · 2024-12-15T01:30:02.000+01:00
## Description - Set default `PerPage` value in the `GitHubContext` - Fixes #31 ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/src/classes/public/Context/GitHubContext.ps1 b/src/classes/public/Context/GitHubContext.ps1
@@ -53,6 +53,9 @@ class GitHubContext : Context {
     # The default value for the Repo parameter.
     [string] $Repo
 
+    # The default value for the 'per_page' API parameter used in 'Get' functions that support paging.
+    [int] $PerPage
+
     # Simple parameterless constructor
     GitHubContext() {}
 
diff --git a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1
@@ -26,8 +26,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1
@@ -28,8 +28,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Organization/Get-GitHubMyOrganization.ps1 b/src/functions/private/Organization/Get-GitHubMyOrganization.ps1
@@ -27,8 +27,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1
@@ -29,8 +29,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1
@@ -35,8 +35,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Releases/Releases/Get-GitHubReleaseAll.ps1 b/src/functions/private/Releases/Releases/Get-GitHubReleaseAll.ps1
@@ -29,8 +29,8 @@
 
         # The number of results per page (max 100).
         [Parameter(ParameterSetName = 'AllUsers')]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Repositories/Repositories/Get-GitHubMyRepositories.ps1 b/src/functions/private/Repositories/Repositories/Get-GitHubMyRepositories.ps1
@@ -96,8 +96,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # Only show repositories updated after the given time.
         [Parameter()]
diff --git a/src/functions/private/Repositories/Repositories/Get-GitHubRepositoryListByOrg.ps1 b/src/functions/private/Repositories/Repositories/Get-GitHubRepositoryListByOrg.ps1
@@ -53,8 +53,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Repositories/Repositories/Get-GitHubRepositoryListByUser.ps1 b/src/functions/private/Repositories/Repositories/Get-GitHubRepositoryListByUser.ps1
@@ -55,8 +55,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1
@@ -19,8 +19,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1
@@ -31,8 +31,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1
@@ -21,8 +21,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1
@@ -23,8 +23,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1
@@ -29,8 +29,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1
@@ -20,8 +20,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1
@@ -29,8 +29,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Followers/Get-GitHubUserMyFollowers.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserMyFollowers.ps1
@@ -21,8 +21,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1
@@ -27,8 +27,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1
@@ -22,8 +22,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Get-GitHubAllUser.ps1 b/src/functions/private/Users/Get-GitHubAllUser.ps1
@@ -27,8 +27,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1
@@ -27,8 +27,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1
@@ -22,8 +22,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1
@@ -22,8 +22,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1
@@ -27,8 +27,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1
@@ -20,8 +20,8 @@
     param(
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/API/Invoke-GitHubAPI.ps1 b/src/functions/public/API/Invoke-GitHubAPI.ps1
@@ -150,6 +150,11 @@
         if ($Body) {
             # Use body to create the query string for certain situations
             if ($Method -eq 'GET') {
+                # If body conatins 'per_page' and its is null, set it to $context.PerPage
+                if ($Body['per_page'] -eq 0) {
+                    Write-Debug "Setting per_page to the default value in context [$($Context.PerPage)]."
+                    $Body['per_page'] = $Context.PerPage
+                }
                 $queryString = $Body | ConvertTo-QueryString
                 $APICall.Uri = $APICall.Uri + $queryString
             } elseif ($Body -is [string]) {
diff --git a/src/functions/public/Actions/Get-GitHubWorkflow.ps1 b/src/functions/public/Actions/Get-GitHubWorkflow.ps1
@@ -31,8 +31,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Actions/Get-GitHubWorkflowRun.ps1 b/src/functions/public/Actions/Get-GitHubWorkflowRun.ps1
@@ -21,8 +21,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Auth/Connect-GitHubAccount.ps1 b/src/functions/public/Auth/Connect-GitHubAccount.ps1
@@ -186,6 +186,7 @@
                 Enterprise = [string]$Enterprise
                 Owner      = [string]$Owner
                 Repo       = [string]$Repo
+                PerPage    = 100
             }
 
             Write-Verbose ($context | Format-Table | Out-String)
diff --git a/src/functions/public/Organization/Get-GitHubOrganization.ps1 b/src/functions/public/Organization/Get-GitHubOrganization.ps1
@@ -70,8 +70,8 @@
         [Parameter(ParameterSetName = 'AllOrg')]
         [Parameter(ParameterSetName = 'UserOrg')]
         [Parameter(ParameterSetName = '__DefaultSet')]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Organization/Get-GitHubOrganizationAppInstallation.ps1 b/src/functions/public/Organization/Get-GitHubOrganizationAppInstallation.ps1
@@ -32,8 +32,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Organization/Members/Get-GitHubOrganizationMember.ps1 b/src/functions/public/Organization/Members/Get-GitHubOrganizationMember.ps1
@@ -32,8 +32,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1
@@ -31,8 +31,8 @@
 
         # The number of results per page (max 100).
         [Parameter()]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Releases/Releases/Get-GitHubRelease.ps1 b/src/functions/public/Releases/Releases/Get-GitHubRelease.ps1
@@ -46,8 +46,8 @@
 
         # The number of results per page (max 100).
         [Parameter(ParameterSetName = 'All')]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # Get the latest release only
         [Parameter(
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepository.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepository.ps1
@@ -121,8 +121,8 @@ filter Get-GitHubRepository {
         [Parameter(ParameterSetName = 'MyRepos')]
         [Parameter(ParameterSetName = 'ListByOrg')]
         [Parameter(ParameterSetName = 'ListByUser')]
-        [ValidateRange(1, 100)]
-        [int] $PerPage = 30,
+        [ValidateRange(0, 100)]
+        [int] $PerPage,
 
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1
diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1
diff --git a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1
diff --git a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1
diff --git a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1
diff --git a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1
diff --git a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1
diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1
diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1
diff --git a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1
diff --git a/src/functions/public/Users/Get-GitHubUser.ps1 b/src/functions/public/Users/Get-GitHubUser.ps1
diff --git a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1
diff --git a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1
