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.

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-746: Simplify the REST API document #64

Merged
merged 3 commits into from Jul 19, 2021

Conversation

manirajv06
Copy link
Contributor

Doc changes to clearly explain the Old and Newer version API's use.

@yangwwei
Copy link
Contributor

hi @manirajv06 thanks for working on this. Can we remove the "Deprecated" and "Newer version" in the doc, and merge them into one section? For queus/apps/nodes, we should only have one section each, and the old/new API can all be explained in each single section.

@manirajv06
Copy link
Contributor Author

Taken care. Pls check.

Copy link
Contributor

@yangwwei yangwwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, it looks much better. I just added some minor comments to request the change of sub-titles, hope that makes sense.

## Queues (Newer Version)
## Queues

### Single Partition
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partition queues

@@ -162,7 +164,7 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila
}
```

## Queues
### All Partitions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All queues

## Applications (Newer Version)
## Applications

### Single Partition
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Queue applications

@@ -319,7 +323,7 @@ In the example below there are three allocations belonging to two applications.
}
```

## Applications
### All Partitions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All applications

## Nodes (Newer Version)
## Nodes

### Single Partition
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partition nodes

@@ -508,7 +514,7 @@ Here you can see an example response from a 2-node cluster having 3 allocations.
}
```

## Nodes
### All Partitions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All nodes

Copy link
Contributor

@yangwwei yangwwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yangwwei yangwwei merged commit 63875dd into apache:master Jul 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants