From 169dc6daa94b1004a20d362d4dbd7033e68d17fb Mon Sep 17 00:00:00 2001 From: Manikandan R Date: Wed, 3 Jul 2024 12:51:21 +0530 Subject: [PATCH 1/2] [YUNIKORN-2716] Doc changes to escape query params in REST API --- docs/api/scheduler.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md index 482b98dfb24..9198219a090 100644 --- a/docs/api/scheduler.md +++ b/docs/api/scheduler.md @@ -337,7 +337,7 @@ The content of the application object is the same as Queue Applications. See ### Queue applications -Fetch all Applications for the given Partition/Queue combination and displays general information about the applications like used resources, queue name, submission time and allocations. +Fetch all Applications for the given Partition/Queue combination and displays general information about the applications like used resources, queue name, submission time and allocations. In case queue name contains any special characters, needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/queue/{queueName}/applications` @@ -591,7 +591,7 @@ In the example below there are three allocations belonging to two applications, ### Partition/Queue application -Fetch an Application given a Partition, Queue(optional) and Application ID and displays general information about the application like used resources, queue name, submission time and allocations. +Fetch an Application given a Partition, Queue(optional) and Application ID and displays general information about the application like used resources, queue name, submission time and allocations. In case queue name contains any special characters, needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/application/{appId}` or `/ws/v1/partition/{partitionName}/queue/{queueName}/application/{appId}` @@ -854,7 +854,7 @@ Fetch all users usage given a Partition and displays general information about t ## UserTracker ### Get specific user usage tracking information -Fetch specific user usage given a Partition and displays general information about the users managed by YuniKorn. +Fetch specific user usage given a Partition and displays general information about the users managed by YuniKorn. In case username contains any special characters, needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/usage/user/{userName}` @@ -1027,7 +1027,7 @@ Fetch all groups usage given a Partition and displays general information about ## GroupTracker ### Get specific group usage tracking information -Fetch specific group usage given a Partition and displays general information about the groups managed by YuniKorn. +Fetch specific group usage given a Partition and displays general information about the groups managed by YuniKorn. In case group name contains any special characters, needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/usage/group/{groupName}` From 57b7dc7020ec0fd98d99cff2eea0d7a7cebc2832 Mon Sep 17 00:00:00 2001 From: Manikandan R Date: Fri, 5 Jul 2024 10:31:56 +0530 Subject: [PATCH 2/2] Modified message --- docs/api/scheduler.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md index 9198219a090..68e982965b4 100644 --- a/docs/api/scheduler.md +++ b/docs/api/scheduler.md @@ -337,7 +337,7 @@ The content of the application object is the same as Queue Applications. See ### Queue applications -Fetch all Applications for the given Partition/Queue combination and displays general information about the applications like used resources, queue name, submission time and allocations. In case queue name contains any special characters, needs to be url escaped to avoid issues. +Fetch all Applications for the given Partition/Queue combination and displays general information about the applications like used resources, queue name, submission time and allocations. In case the queue name contains any special characters, it needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/queue/{queueName}/applications` @@ -591,7 +591,7 @@ In the example below there are three allocations belonging to two applications, ### Partition/Queue application -Fetch an Application given a Partition, Queue(optional) and Application ID and displays general information about the application like used resources, queue name, submission time and allocations. In case queue name contains any special characters, needs to be url escaped to avoid issues. +Fetch an Application given a Partition, Queue(optional) and Application ID and displays general information about the application like used resources, queue name, submission time and allocations. In case the queue name contains any special characters, it needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/application/{appId}` or `/ws/v1/partition/{partitionName}/queue/{queueName}/application/{appId}` @@ -854,7 +854,7 @@ Fetch all users usage given a Partition and displays general information about t ## UserTracker ### Get specific user usage tracking information -Fetch specific user usage given a Partition and displays general information about the users managed by YuniKorn. In case username contains any special characters, needs to be url escaped to avoid issues. +Fetch specific user usage given a Partition and displays general information about the users managed by YuniKorn. In case the username contains any special characters, it needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/usage/user/{userName}` @@ -1027,7 +1027,7 @@ Fetch all groups usage given a Partition and displays general information about ## GroupTracker ### Get specific group usage tracking information -Fetch specific group usage given a Partition and displays general information about the groups managed by YuniKorn. In case group name contains any special characters, needs to be url escaped to avoid issues. +Fetch specific group usage given a Partition and displays general information about the groups managed by YuniKorn. In case the group name contains any special characters, it needs to be url escaped to avoid issues. **URL** : `/ws/v1/partition/{partitionName}/usage/group/{groupName}`