rfc44: add optional reason field to undrain event

Problem: At least one documented use case could make use of a reason field in the undrain event, but RFC 44 does not allow that. Add an optional reason key in the undrain context.
grondo · Feb 14, 2025 · f553f71 · f553f71
1 parent 19c94e9
commit f553f71
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/spec_44.rst b/spec_44.rst
@@ -271,6 +271,11 @@ The event context SHALL contain the following keys:
   (*string*, REQUIRED) An RFC 29 hostlist that can be used to map the idset
   execution target ranks to hostnames.
 
+.. data:: reason
+  :noindex:
+
+  (*string*, OPTIONAL) A message describing why the undrain action was taken.
+
 .. code:: json
 
   {