search

dapplo / Dapplo.Confluence

An Atlassian confluence client for .NET
MIT License
34 stars 20 forks source link

Get root pages #63

Open Morhpeuss opened 1 year ago

Morhpeuss commented 1 year ago

I want to get pages hierarchy in space. Root pages/page first with the children.

I am able to get children of the page, but how could I get the root pages?

Thanks. Josef

Morhpeuss commented 1 year ago

I found the problem.

The right way is to use "confluenceClient.Space.GetContentsAsync(this.spaceKey)" but You need to add the query parameter "depth", regarding documentation https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/#api-wiki-rest-api-space-spacekey-content-type-get

How could I add the query parameter?

Lakritzator commented 1 year ago

Currently there is no way to specify the depth, I made this library with a "I/we will add it when it's needed" policy, and not trying to support everything if it's not needed. This request aligns with #62, where the start and limit are not supplied and aren't supported in the method call.

It makes sense to add support to something like query parameters with some defaults and optional, tailored to the request, depth would be in there. This would mean Space.GetContentsAsync would get another overload with an additional parameter.

Morhpeuss commented 1 year ago

@Lakritzator I understand that you can not support all properties.

Adding a new overload of the method with optional parameters makes sense.