🚀 [Feature]: Teams and Workflows cleanup

src/classes/public/Teams/GitHubTeam.ps1

@@ -14,6 +14,10 @@
     # The description of the team.
     [string] $Description
 
+    # The HTML URL of the team.
+    # Example: https://github.com/orgs/github/teams/justice-league
+    [string] $Url
+
     # The notification setting the team has chosen.
     # $true = notifications_enabled - team members receive notifications when the team is @mentioned.
     # $false = notifications_disabled - no one receives notifications.

src/functions/private/Teams/Get-GitHubTeamBySlug.ps1

@@ -13,16 +13,15 @@
     [OutputType([GitHubTeam])]
     [CmdletBinding()]
     param(
-        # The slug of the team name.
-        [Parameter(Mandatory)]
-        [Alias('team_slug')]
-        [string] $Slug,
-
         # The organization name. The name is not case sensitive.
         # If not provided, the owner from the context will be used.
-        [Parameter()]
+        [Parameter(Mandatory)]
         [string] $Organization,
 
+        # The slug of the team name.
+        [Parameter(Mandatory)]
+        [string] $Slug,
+
         # 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.
         [Parameter(Mandatory)]
@@ -36,72 +35,63 @@
     }
 
     process {
-        $query = @"
-query(`$org: String!, `$teamSlug: String!) {
-  organization(login: `$org) {
-    team(slug: `$teamSlug) {
-        id
+        $inputObject = @{
+            Query     = @'
+query($org: String!, $teamSlug: String!) {
+  organization(login: $org) {
+    team(slug: $teamSlug) {
+      id
+      name
+      slug
+      url
+      combinedSlug
+      databaseId
+      description
+      notificationSetting
+      privacy
+      parentTeam {
         name
         slug
-        combinedSlug
-        databaseId
-        description
-        notificationSetting
-        privacy
-        parentTeam {
+      }
+      childTeams(first: 100) {
+        nodes {
           name
-          slug
         }
-        organization {
-          login
-        }
-        childTeams(first: 100) {
-          nodes {
-            name
-          }
-        }
-        createdAt
-        updatedAt
       }
+      createdAt
+      updatedAt
     }
   }
 }
-"@
-
-        # Variables hash that will be sent with the query
-        $variables = @{
-            org      = $Organization
-            teamSlug = $Slug
+'@
+            Variables = @{
+                org      = $Organization
+                teamSlug = $Slug
+            }
+            Context   = $Context
         }
-
-        # Send the request to the GitHub GraphQL API
-        $data = Invoke-GitHubGraphQLQuery -Query $query -Variables $variables -Context $Context
-
-        # Extract team data
+        $data = Invoke-GitHubGraphQLQuery @inputObject
         $team = $data.organization.team
-
-        # Output the team object
-        if (-not $team) {
-            return
+        if ($team) {
+            [GitHubTeam](
+                @{
+                    Name          = $team.name
+                    Slug          = $team.slug
+                    NodeID        = $team.id
+                    Url           = $team.url
+                    CombinedSlug  = $team.CombinedSlug
+                    ID            = $team.DatabaseId
+                    Description   = $team.description
+                    Notifications = $team.notificationSetting -eq 'NOTIFICATIONS_ENABLED' ? $true : $false
+                    Visible       = $team.privacy -eq 'VISIBLE' ? $true : $false
+                    ParentTeam    = $team.parentTeam.slug
+                    Organization  = $Organization
+                    ChildTeams    = $team.childTeams.nodes.name
+                    CreatedAt     = $team.createdAt
+                    UpdatedAt     = $team.updatedAt
+                }
+            )
         }
-
-        [GitHubTeam](
-            @{
-                Name          = $team.name
-                Slug          = $team.slug
-                NodeID        = $team.id
-                CombinedSlug  = $team.CombinedSlug
-                ID            = $team.DatabaseId
-                Description   = $team.description
-                Notifications = $team.notificationSetting -eq 'NOTIFICATIONS_ENABLED' ? $true : $false
-                Visible       = $team.privacy -eq 'VISIBLE' ? $true : $false
-                ParentTeam    = $team.parentTeam.slug
-                Organization  = $team.organization.login
-                ChildTeams    = $team.childTeams.nodes.name
-                CreatedAt     = $team.createdAt
-                UpdatedAt     = $team.updatedAt
-            }
-        )
     }
 
     end {

src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1

@@ -8,9 +8,6 @@
 
         .EXAMPLE
         Get-GitHubTeamListByOrg -Organization 'github'
-
-        .NOTES
-        [List teams](https://docs.github.com/rest/teams/teams#list-teams)
     #>
     [OutputType([GitHubTeam[]])]
     [CmdletBinding()]
@@ -33,14 +30,16 @@
     }
 
     process {
-        $query = @"
-query(`$org: String!, `$after: String) {
-  organization(login: `$org) {
-    teams(first: 100, after: `$after) {
+        $inputObject = @{
+            Query     = @'
+query($org: String!, $after: String) {
+  organization(login: $org) {
+    teams(first: 100, after: $after) {
       nodes {
         id
         name
         slug
+        url
         combinedSlug
         databaseId
         description
@@ -50,9 +49,6 @@ query(`$org: String!, `$after: String) {
           name
           slug
         }
-        organization {
-          login
-        }
         childTeams(first: 100) {
           nodes {
             name
@@ -68,49 +64,40 @@ query(`$org: String!, `$after: String) {
     }
   }
 }
-"@
-
-        # Variables hash that will be sent with the query
-        $variables = @{
-            org = $Organization
+'@
+            Variables = @{
+                org = $Organization
+            }
+            Context   = $Context
         }
-
-        # Prepare to store results and handle pagination
         $hasNextPage = $true
         $after = $null
 
         do {
             # Update the cursor for pagination
-            $variables['after'] = $after
-
-            # Send the request to the GitHub GraphQL API
-            $data = Invoke-GitHubGraphQLQuery -Query $query -Variables $variables -Context $Context
-
-            # Extract team data
+            $inputObject['Variables']['after'] = $after
+            $data = Invoke-GitHubGraphQLQuery @inputObject
             $teams = $data.organization.teams
-
-            # Accumulate the teams in results
             $teams.nodes | ForEach-Object {
                 [GitHubTeam](
                     @{
                         Name          = $_.name
                         Slug          = $_.slug
                         NodeID        = $_.id
+                        Url           = $_.url
                         CombinedSlug  = $_.combinedSlug
                         ID            = $_.databaseId
                         Description   = $_.description
                         Notifications = $_.notificationSetting -eq 'NOTIFICATIONS_ENABLED' ? $true : $false
                         Visible       = $_.privacy -eq 'VISIBLE' ? $true : $false
                         ParentTeam    = $_.parentTeam.slug
-                        Organization  = $_.organization.login
+                        Organization  = $Organization
                         ChildTeams    = $_.childTeams.nodes.name
                         CreatedAt     = $_.createdAt
                         UpdatedAt     = $_.updatedAt
                     }
                 )
             }
-
-            # Check if there's another page to fetch
             $hasNextPage = $teams.pageInfo.hasNextPage
             $after = $teams.pageInfo.endCursor
         } while ($hasNextPage)

src/functions/public/API/Invoke-GitHubAPI.ps1

@@ -315,15 +315,21 @@ filter Invoke-GitHubAPI {
                 Information = $errordetails.documentation_url
                 Status      = $failure.Exception.Message
                 StatusCode  = $errordetails.status
+                ErrorTime   = Get-Date -Format 's'
             }
-            $APICall.HttpVersion = $APICall.HttpVersion.ToString()
-            $APICall.Headers = $APICall.Headers | ConvertTo-Json
-            $APICall.Method = $APICall.Method.ToString()
 
             $exception = @"
 ----------------------------------
+Request:
+$([pscustomobject]$APICall | Format-List -Property Headers, HttpVersion, Method, Uri, ContentType, Authentication, Token | Out-String)
+----------------------------------
+Response Headers:
+$($headers | Format-List | Out-String)
+----------------------------------
+Error:
 $($errorResult | Format-List | Out-String)
 ----------------------------------
+
 "@
             $PSCmdlet.ThrowTerminatingError(
                 [System.Management.Automation.ErrorRecord]::new(

src/functions/public/Repositories/Get-GitHubRepository.ps1

@@ -26,7 +26,7 @@
         Gets the repositories for the specified user.
 
         .EXAMPLE
-        Get-GitHubRepository -Owner 'github' -Name 'octocat'
+        Get-GitHubRepository -Organization 'github' -Name 'octocat'
 
         Gets the specified repository.
 

src/functions/public/Teams/Get-GitHubTeam.ps1

@@ -17,23 +17,25 @@
         Get-GitHubTeam -Organization 'github' -Slug 'my-team-name'
 
         Gets the team with the slug 'my-team-name' in the `github` organization.
+
+        .NOTES
+        [List teams](https://docs.github.com/rest/teams/teams#list-teams)
+
+        .LINK
+        https://psmodule.io/GitHub/Functions/Teams/Get-GitHubTeam
     #>
     [OutputType([GitHubTeam])]
-    [CmdletBinding(DefaultParameterSetName = '__AllParameterSets')]
+    [CmdletBinding(DefaultParameterSetName = 'List all teams in an organization')]
     param(
-        # The slug of the team name.
-        [Parameter(
-            Mandatory,
-            ParameterSetName = 'BySlug'
-        )]
-        [Alias('team_slug')]
-        [string] $Slug,
-
         # The organization name. The name is not case sensitive.
         # If not provided, the owner from the context will be used.
-        [Parameter()]
+        [Parameter(Mandatory)]
         [string] $Organization,
 
+        # The slug of the team name.
+        [Parameter(Mandatory, ParameterSetName = 'BySlug')]
+        [string] $Slug,
+
         # 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.
         [Parameter()]
@@ -45,11 +47,6 @@
         Write-Debug "[$stackPath] - Start"
         $Context = Resolve-GitHubContext -Context $Context
         Assert-GitHubContext -Context $Context -AuthType IAT, PAT, UAT
-
-        if ([string]::IsNullOrEmpty($Organization)) {
-            $Organization = $Context.Owner
-        }
-        Write-Debug "Organization: [$Organization]"
     }
 
     process {
@@ -71,5 +68,3 @@
         Write-Debug "[$stackPath] - End"
     }
 }
-
-#SkipTest:FunctionTest:Will add a test for this function in a future PR