Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[YUNIKORN-2716] Doc changes to escape query params in REST API #448

Closed
wants to merge 2 commits into from
Closed

[YUNIKORN-2716] Doc changes to escape query params in REST API #448

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
169dc6d
[YUNIKORN-2716] Doc changes to escape query params in REST API
manirajv06 Jul 3, 2024
57b7dc7
Modified message
manirajv06 Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/scheduler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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}`

Expand Down Expand Up @@ -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}`

Expand Down Expand Up @@ -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}`

Expand Down