Update api docs to include abortedby info

rundeck · Feb 16, 2011 · 24f251b · 24f251b
1 parent c163c6f
commit 24f251b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/en/09-api/01-chapter10.md b/docs/en/09-api/01-chapter10.md
@@ -282,6 +282,9 @@ Result: An Item List of `executions`.  Each `execution` of the form:
         <!-- the completion time of the execution -->
         <date-ended unixtime="[unixtime]">[datetime]</date-ended> 
         
+        <!-- if the execution was aborted, the username who aborted it: -->
+        <abortedby>[username]</abortedby>
+        
     </execution>
 
 The `[status]` value indicates the execution status.  It is one of:
@@ -449,6 +452,8 @@ Result:  an Item List of `events`.  Each `event` has this form:
       <project>[project]</project>
       <date-started>[start date]</date-started>
       <date-ended>[end date]</date-ended>
+      <!-- if the execution was aborted, the username who aborted it: -->
+      <abortedby>[username]</abortedby>
       <!-- if associated with an Execution, include the execution id: -->
       <execution id="[execid]"/>
       <!-- if associated with a Job, include the Job ID: -->