This is an automated email from the ASF dual-hosted git repository.
wilfred-s 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 66ef06cc62 [YUNIKORN-3347] Add checksum fields in validate-conf REST
response (#573)
66ef06cc62 is described below
commit 66ef06cc62a2707b648d65e42bc6160c71f088f9
Author: sidbroski <[email protected]>
AuthorDate: Tue Aug 18 14:10:28 2026 +1000
[YUNIKORN-3347] Add checksum fields in validate-conf REST response (#573)
Added the checksum and checksumMatch fields to the Configuration validation
success response reference in the cluster REST API docs.
Closes: #573
Signed-off-by: Wilfred Spiegelenburg <[email protected]>
---
docs/api/cluster.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/api/cluster.md b/docs/api/cluster.md
index 543709b61e..4d2daa8a59 100644
--- a/docs/api/cluster.md
+++ b/docs/api/cluster.md
@@ -221,6 +221,8 @@ Regardless whether the configuration is allowed or not if
the server was able to
**Code** : `200 OK`
+The response always contains the `allowed` field. When the configuration is
rejected the `reason` field describes why. When the configuration is allowed
the response also contains the `checksum` calculated over the submitted
configuration and `checksumMatch`, which is `true` when the checksum already
present in the submitted configuration matched the calculated `checksum`.
+
#### Allowed configuration
Sending the following simple configuration yields an accept
@@ -239,7 +241,8 @@ Reponse
```json
{
"allowed": true,
- "reason": ""
+ "checksum":
"9F86D081884C7D659A2FEAA0C55AD015A3BF4F1B2B0B822CD15D6C15B0F00A08",
+ "checksumMatch": false
}
```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
