Get-ConfluenceSpace does not return labels, and does not take label as input parameter

[o-l-a-v]

Description

API says that get space will return labels. The Get-Space also includes mentions of labels in $iwParameters['GetParameters'] property expand, where we can find metadata.labels.

But no labels are returned when getting all spaces nor a specific space.

• API Documentation \ Space \ Get
• Get-Space, which actually specifies labels as an attribute to expand, and with no input parameter for getting spaces with a given label/ category.
  
• "Space" class found in ConfluencePS.Types.cs, which does not say anything about label or category.
  

Steps To Reproduce

Get-ConfluenceSpace | Format-List -Force

Expected behavior

Labels or categories should be included in the response.

Screenshots

Your Environment

• PowerShell 5.1 on Windows 10 Enterprise 20H1.
• ConfluencePS version 2.5.

Possible Solution

• Add label to the space class (probably)
• Add input parameter to Get-ConfluenceSpace function to get spaces by labels.

[o-l-a-v]

I added ability to get spaces by label adding the following to Get-Space.

Input parameter

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

Logic for adding label(s) to $iwParameters['GetParameters']

if ($Label -and $Label.'Count' -gt 0) {
    $iwParameters['GetParameters'].Add('label',($Label -join ','))
}

Does not seem to work with multiple labels though.

[o-l-a-v]

Added getting labels from spaces.

Private\ConvertTo-Space

@{
    'Name' = 'labels'
    'Expression' = {
        $_.'metadata'.'labels'.'results'.'name'
    }
}

ConfluencePS.Types.cs

public class Space {
	public Int32 Id { get; set; }
	public String Key { get; set; }
	public String Name { get; set; }
	public Icon Icon { get; set; }
	public String Type { get; set; }
	public String Description { get; set; }
	public String[] Labels { get; set; }
	public Page Homepage { get; set; }
	public override string ToString() {
		return "[" + Key + "] " + Name;
	}
}

[lipkau]

Related compatibility note from #214 / PR #250:

Get-ConfluenceSpace previously requested metadata.labels by default, but the current Space type/converter does not expose labels, so the expansion was unused. PR #250 removes that unused expansion to avoid HTTP 500 responses observed on Confluence Data Center 8.9.x.

This does not reject this feature request. Proper label support should be implemented separately by adding labels to the public Space model/converter, adding any label-filter parameter behavior, and validating the resulting API calls on both Cloud and Data Center. In particular, reintroducing metadata.labels should be covered by Data Center regression tests so it does not recreate #214.