[jira] [Comment Edited] (YUNIKORN-2472) REST API returns subtree by default

["Wilfred Spiegelenburg (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/YUNIKORN-2472?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17824619#comment-17824619 ] 

Wilfred Spiegelenburg edited comment on YUNIKORN-2472 at 3/8/24 5:38 AM:
-------------------------------------------------------------------------

As part of fixing this we also need to add the documentation of the new call.

The rename of the field {{childrenNames}} to {{childNames}} should be considered it does not "feel" right to have 2 plural parts stuck together in the output.


was (Author: wifreds):
As part of fixing this we also need to add the documentation of the new call.

> REST API returns subtree by default
> -----------------------------------
>
>                 Key: YUNIKORN-2472
>                 URL: https://issues.apache.org/jira/browse/YUNIKORN-2472
>             Project: Apache YuniKorn
>          Issue Type: Bug
>          Components: core - common, documentation
>    Affects Versions: 1.5.0
>            Reporter: Wilfred Spiegelenburg
>            Priority: Minor
>              Labels: newbie
>
> The subtree query parameter is interpreted the opposite of what would be expected.
> If you call {{/ws/v1/partition/default/queue/root?subtree}} then you do not get the subtree. If you call {{/ws/v1/partition/default/queue/root}} you get the whole tree rooted at root
> We have not documented the new API yet so before we add it to the docs we should fix the behaviour:
>  * subtree given: return the whole tree
>  * subtree missing: return one level
> The code fix is as simple as a ! in a single call and inverting the test cases to pass or not pass {{?subtree}}



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: issues-help@yunikorn.apache.org