This is an automated email from the ASF dual-hosted git repository.
mani pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new aae16d293f [YUNIKORN-2716] Doc changes to escape query params in REST
API (#448)
aae16d293f is described below
commit aae16d293f6dd42cee72f320eb6814380607b39f
Author: Manikandan R <[email protected]>
AuthorDate: Sat Jul 6 10:56:56 2024 +0530
[YUNIKORN-2716] Doc changes to escape query params in REST API (#448)
Closes: #448
Signed-off-by: Manikandan R <[email protected]>
---
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 482b98dfb2..68e982965b 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 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.
+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.
+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.
+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}`
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
