10036: Update ContainerRequest API documentation about canceling a conatiner_request.

[arvados.git] / doc / api / methods / container_requests.html.textile.liquid

diff --git a/doc/api/methods/container_requests.html.textile.liquid b/doc/api/methods/container_requests.html.textile.liquid
index 491698e5a28934b8a0d2b458de1a24d8bf3ca98b..2603079560e8a857c60c1e16c20b43b1476c46fe 100644 (file)
--- a/doc/api/methods/container_requests.html.textile.liquid
+++ b/doc/api/methods/container_requests.html.textile.liquid
@@ -69,4 +69,7 @@ table(table table-bordered table-condensed).
 {background:#ccffcc}.|uuid|string|The UUID of the ContainerRequest in question.|path||
 |container_request|object||query||
 
-Note: To cancel a ContainerRequest, set it's priority to zero.
+{% include 'notebox_begin' %}
+Setting the priority of a committed container_request to 0 may cancel a running container assigned for it.
+See "Canceling a ContainerRequest":{{site.baseurl}}/api/schema/ContainerRequest.html#cancel_container for further details.
+{% include 'notebox_end' %}