diff --git a/src/functions/public/Teams/New-GitHubTeam.ps1 b/src/functions/public/Teams/New-GitHubTeam.ps1 index 4a8b6b634..b6ae7bf04 100644 --- a/src/functions/public/Teams/New-GitHubTeam.ps1 +++ b/src/functions/public/Teams/New-GitHubTeam.ps1 @@ -12,6 +12,18 @@ `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". + .EXAMPLE + $params = @{ + Organization = 'github' + Name = 'team-name' + Description = 'A new team' + Maintainers = 'octocat' + RepoNames = 'github/octocat' + Privacy = 'closed' + Permission = 'pull' + } + New-GitHubTeam @params + .NOTES [Create a team](https://docs.github.com/rest/teams/teams#create-a-team) #> diff --git a/src/functions/public/Teams/Delete-GitHubTeam.ps1 b/src/functions/public/Teams/Remove-GitHubTeam.ps1 similarity index 95% rename from src/functions/public/Teams/Delete-GitHubTeam.ps1 rename to src/functions/public/Teams/Remove-GitHubTeam.ps1 index 5f4e04a98..49ddc5cac 100644 --- a/src/functions/public/Teams/Delete-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Remove-GitHubTeam.ps1 @@ -8,7 +8,7 @@ If you are an organization owner, deleting a parent team will delete all of its child teams as well. .EXAMPLE - An example + Remove-GitHubTeam -Organization 'github' -Name 'team-name' .NOTES [Delete a team](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#delete-a-team) diff --git a/src/functions/public/Teams/Update-GitHubTeam.ps1 b/src/functions/public/Teams/Update-GitHubTeam.ps1 index 038b924c0..a3531ddab 100644 --- a/src/functions/public/Teams/Update-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Update-GitHubTeam.ps1 @@ -7,7 +7,17 @@ To edit a team, the authenticated user must either be an organization owner or a team maintainer. .EXAMPLE - + $params = @{ + Organization = 'github' + Name = 'team-name' + NewName = 'new-team-name' + Description = 'A new team' + Privacy = 'closed' + NotificationSetting = 'notifications_enabled' + Permission = 'pull' + ParentTeamID = 123456 + } + Update-GitHubTeam @params .NOTES [Update a team](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#update-a-team)