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 85b5275 [YUNIKORN-405] Document config update API (#47)
85b5275 is described below
commit 85b52755fb2e5699e9d02d051816ae295e5ab997
Author: Kinga Marton <[email protected]>
AuthorDate: Wed Apr 14 09:00:37 2021 +1000
[YUNIKORN-405] Document config update API (#47)
Add checksum information to the REST API documentation.
Fixes: #47
---
docs/api/scheduler.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index ccd111c..ed127d4 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -528,13 +528,20 @@ partitions:
submitacl: '*'
properties:
application.sort.policy: stateaware
+checksum: BAB3D76402827EABE62FA7E4C6BCF4D8DD9552834561B6B660EF37FED9299791
```
+**Note:** Updates must use a current running configuration as the base.
+The base configuration is the configuration version that was retrieved earlier
via a GET request and updated by the user.
+The update request must contain the checksum of the _base_ configuration.
+If the checksum provided in the update request differs from the currently
running configuration checksum the update will be rejected.
### Failure response
-The configuration update can fail due to invalid configuration
+The configuration update can fail due to different reasons such as:
+- invalid configuration,
+- incorrect base checksum.
-In this case the transaction will be rolled back, and the proper
+In each case the transaction will be rejected, and the proper
error message will be returned as a response.
**Code** : `409 Conflict`
@@ -560,6 +567,7 @@ partitions:
vcore: "1"
properties:
application.sort.policy: stateaware
+checksum: BAB3D76402827EABE62FA7E4C6BCF4D8DD9552834561B6B660EF37FED9299791
```
## Application history
