GitlabCli

1.120.4

Topics.psm1

# https://docs.gitlab.com/ee/api/topics.html#list-topics
function Get-GitlabTopic {
    [CmdletBinding(DefaultParameterSetName='Search')]
    param (
        [Parameter(Mandatory, ParameterSetName='Id')]
        [Alias('Id')]
        [string]
        $TopicId,

        [Parameter(ParameterSetName='Search', Position=0)]
        [string]
        $Search,

        [Parameter(ParameterSetName='Search')]
        [switch]
        $WithoutProjects,

        [Parameter(ParameterSetName='Search')]
        [uint]
        $MaxPages,

        [Parameter(ParameterSetName='Search')]
        [switch]
        $All,

        [Parameter(Mandatory=$false)]
        [string]
        $SiteUrl
    )

    if ($All) {
        if ($MaxPages) {
            Write-Warning -Message "Ignoring -MaxPages in favor of -All"
        }
        $MaxPages = [uint]::MaxValue
    }

    $Query = @{}
    switch ($PSCmdlet.ParameterSetName) {
        Search  { $Url = 'topics'  }
        Id      { $Url = "topics/$TopicId" }
        Default { throw "$($PSCmdlet.ParameterSetName) is not supported"}
    }
    if ($Search) {
        $Query.search = $Search
    }
    if ($WithoutProjects) {
        $Query.without_projects = 'true'
    }

    Invoke-GitlabApi GET $Url $Query -MaxPages $MaxPages -SiteUrl $SiteUrl |
        New-WrapperObject 'Gitlab.Topic' |
        Sort-Object Name
}

# https://docs.gitlab.com/ee/api/topics.html#create-a-project-topic
function New-GitlabTopic {
    [CmdletBinding(SupportsShouldProcess)]
    param (
        [Parameter(Mandatory, Position=0)]
        [string]
        $Name,

        [Parameter()]
        [string]
        $Title,

        [Parameter()]
        [string]
        $Description
    )

    if (-not $Title) {
        $Title = $Name
    }

    $Request = @{
        name = $Name
        title = $Title
    }
    if ($Description) {
        $Request.description = $Description
    }

    if ($PSCmdlet.ShouldProcess("topics", "create ($($Request | ConvertTo-Json))")) {
        Invoke-GitlabApi POST "topics" -SiteUrl $SiteUrl -Body $Request | New-WrapperObject 'Gitlab.Topic'
    }
}

# https://docs.gitlab.com/ee/api/topics.html#update-a-project-topic
function Update-GitlabTopic {
    [CmdletBinding(SupportsShouldProcess)]
    param (
        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
        [Alias('Id')]
        [string]
        $TopicId,

        [Parameter()]
        [string]
        $Name,

        [Parameter()]
        [string]
        $Title,

        [Parameter()]
        [string]
        $Description
    )

    $Request = @{}
    if ($Name) {
        $Request.name = $Name
    }
    if ($Title) {
        $Request.title = $Title
    }
    if ($Description) {
        $Request.description = $Description
    }

    if ($PSCmdlet.ShouldProcess("topic $TopicId", "update ($($Request | ConvertTo-Json))")) {
        Invoke-GitlabApi PUT "topics/$TopicId" -SiteUrl $SiteUrl -Body $Request | New-WrapperObject 'Gitlab.Topic'
    }
}

# https://docs.gitlab.com/ee/api/topics.html#delete-a-project-topic
function Remove-GitlabTopic {
    [CmdletBinding(SupportsShouldProcess=$true)]
    param (
        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
        [Alias('Id')]
        [string]
        $TopicId
    )
    
    if ($PSCmdlet.ShouldProcess("topic $TopicId", "delete")) {
        if (Invoke-GitlabApi DELETE "topics/$TopicId" -SiteUrl $SiteUrl) {
            Write-Host "Topic $TopicId deleted"
        }
    }
}