refs lablup/backend.ai-kernels#59: Update docs for execute runId

lablup · Sep 26, 2017 · a36f932 · a36f932
1 parent 7ce00fc
commit a36f932
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/docs/user-api/exec-batch.rst b/docs/user-api/exec-batch.rst
@@ -81,7 +81,10 @@ Parameters
    * - ``mode``
      - ``enum[str]``
      - A constant string ``"batch"``.
-
+   * - ``runId``
+     - ``str``
+     - A string of client-side unique identifier for this particular execution (run).
+       See details in :doc:`/user-api/exec-query`.
    * - ``options``
      - ``object``
      - :ref:`batch-execution-query-object`.
@@ -93,6 +96,7 @@ Example:
    {
      "type": "batch",
      "options": "{batch-execution-query-object}",
+     "runId": "af9185c5fb0eacb2"
    }
 
 Response

diff --git a/docs/user-api/exec-query.rst b/docs/user-api/exec-query.rst
@@ -32,14 +32,20 @@ Parameters
    * - ``code``
      - ``str``
      - A string of user-written code.  All non-ASCII data must be encoded in UTF-8 or any format acceptable by the kernel.
+   * - ``runId``
+     - ``str``
+     - A string of client-side unique identifier for this particular execution (run).
+       The client should keep the same value until this execution completely finishes with ``finished`` at the result's ``status`` field.
+       Also, the client should use a new value for the subsequent executions.
 
 **Example:**
 
 .. code-block:: json
 
    {
      "type": "query",
-     "code": "print('Hello, world!')"
+     "code": "print('Hello, world!')",
+     "runId": "5facbf2f2697c1b7"
    }