[YUNIKORN-2472] REST API returns subtree by default

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.5.0
• Fix Version/s: 1.6.0
• Component/s: core - common, documentation
• Labels: newbie pull-request-available
• Target Version: 1.6.0
• Assignee: Ted Lin
• Reporter: Wilfred Spiegelenburg
• Created: 08/Mar/24 05:32
• Updated: 03/May/24 10:33
• Resolved: 03/May/24 10:33

Description

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

Issue Links

• relates to: YUNIKORN-2042 REST API for specific queue
• links to: GitHub Pull Request #823