You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by wi...@apache.org on 2022/01/28 15:30:02 UTC
[incubator-yunikorn-site] branch master updated: [YUNIKORN-962] Add deprecation message to REST calls. (#120)
This is an automated email from the ASF dual-hosted git repository.
wilfreds pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new d7983d0 [YUNIKORN-962] Add deprecation message to REST calls. (#120)
d7983d0 is described below
commit d7983d04f27b83cdcd6af8e997b409136dc44c9d
Author: Wilfred Spiegelenburg <wi...@apache.org>
AuthorDate: Sat Jan 29 02:29:13 2022 +1100
[YUNIKORN-962] Add deprecation message to REST calls. (#120)
The REST end points `/ws/v1/queues`, `/ws/v1/apps` and `/ws/v1/nodes`
have been deprecated.
Fixes: #120
---
docs/api/scheduler.md | 8 +++++++-
versioned_docs/version-0.12.1/api/scheduler.md | 6 ++++++
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index c7385be..c6bfcee 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -184,6 +184,8 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila
Fetch all Queues across different Partitions and displays general information about the queues like name, status, capacities and properties.
The queues' hierarchy is kept in the response json.
+**Status** : Deprecated since v0.12.1, replaced by [Partition Queues](#partition-queues)
+
**URL** : `/ws/v1/queues`
**Method** : `GET`
@@ -342,6 +344,8 @@ In the example below there are three allocations belonging to two applications.
Fetch all Applications across different Partitions and displays general information about the applications like used resources, queue name, submission time and allocations.
+**Status** : Deprecated since v0.12.1, replaced by [Queue Applications](#queue-applications)
+
**URL** : `/ws/v1/apps`
**Method** : `GET`
@@ -531,9 +535,11 @@ Here you can see an example response from a 2-node cluster having 3 allocations.
### All nodes
-Fetch all Nodes acrosss different Partitions and displays general information about the nodes managed by YuniKorn.
+Fetch all Nodes across different Partitions and displays general information about the nodes managed by YuniKorn.
Node details include host and rack name, capacity, resources and allocations.
+**Status** : Deprecated since v0.12.1, replaced by [Partition Nodes](#partition-nodes)
+
**URL** : `/ws/v1/nodes`
**Method** : `GET`
diff --git a/versioned_docs/version-0.12.1/api/scheduler.md b/versioned_docs/version-0.12.1/api/scheduler.md
index c7385be..16bd379 100644
--- a/versioned_docs/version-0.12.1/api/scheduler.md
+++ b/versioned_docs/version-0.12.1/api/scheduler.md
@@ -184,6 +184,8 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila
Fetch all Queues across different Partitions and displays general information about the queues like name, status, capacities and properties.
The queues' hierarchy is kept in the response json.
+**Status** : Deprecated since v0.12.1, replaced by [Partition Queues](#partition-queues)
+
**URL** : `/ws/v1/queues`
**Method** : `GET`
@@ -342,6 +344,8 @@ In the example below there are three allocations belonging to two applications.
Fetch all Applications across different Partitions and displays general information about the applications like used resources, queue name, submission time and allocations.
+**Status** : Deprecated since v0.12.1, replaced by [Queue Applications](#queue-applications)
+
**URL** : `/ws/v1/apps`
**Method** : `GET`
@@ -534,6 +538,8 @@ Here you can see an example response from a 2-node cluster having 3 allocations.
Fetch all Nodes acrosss different Partitions and displays general information about the nodes managed by YuniKorn.
Node details include host and rack name, capacity, resources and allocations.
+**Status** : Deprecated since v0.12.1, replaced by [Partition Nodes](#partition-nodes)
+
**URL** : `/ws/v1/nodes`
**Method** : `GET`