Merge pull request #41 from cielo24/PS-1140

[PS-1140] Documentation for changes made by PS-1140
cielo24 · Dec 4, 2019 · 329f10b · 329f10b
2 parents ad9ab44 + 041bc61
commit 329f10b
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/api/source/job_control/get_caption.rst b/api/source/job_control/get_caption.rst
@@ -148,6 +148,19 @@ The job must have completed transcription before a caption can be downloaded.
 |                                 +------------------+-----------------------------------------------------------+
 |                                 | `Example`        | ``display_speaker_id=number``                             |
 +---------------------------------+------------------+-----------------------------------------------------------+
+| iwp_name                        | .. raw:: html                                                                |
+|                                 |                                                                              |
+|                                 |  The named version of element list to generate the transcript from.</br>     |
+|                                 |  If not specified, the transcript will be generated from the</br>            |
+|                                 |  latest version.                                                             |
+|                                 |                                                                              |
+|                                 +------------------+-----------------------------------------------------------+
+|                                 | `Allowed Values` | String                                                    |
+|                                 +------------------+-----------------------------------------------------------+
+|                                 | `Default Value`  | ""                                                        |
+|                                 +------------------+-----------------------------------------------------------+
+|                                 | `Example`        | ``iwp_name=MECHANICAL``                                   |
++---------------------------------+------------------+-----------------------------------------------------------+
 | elementlist_version             | .. raw:: html                                                                |
 |                                 |                                                                              |
 |                                 |  The version of element list to generate the captions from.</br>             |

diff --git a/api/source/job_control/get_elementlist.rst b/api/source/job_control/get_elementlist.rst
@@ -45,6 +45,19 @@ The job must have completed transcription before a caption can be downloaded.
 |                     +------------------+--------------------------------------------------------+
 |                     | `Example`        | ``elementlist_version=2014-07-31T12:35:52Z``           |
 +---------------------+------------------+--------------------------------------------------------+
+| iwp_name            | .. raw:: html                                                             |
+|                     |                                                                           |
+|                     |  The named version of element list to generate the transcript from.</br>  |
+|                     |  If not specified, the transcript will be generated from the</br>         |
+|                     |  latest version.                                                          |
+|                     |                                                                           |
+|                     +------------------+--------------------------------------------------------+
+|                     | `Allowed Values` | String                                                 |
+|                     +------------------+--------------------------------------------------------+
+|                     | `Default Value`  | None (the latest version is returned)                  |
+|                     +------------------+--------------------------------------------------------+
+|                     | `Example`        | ``iwp_name=MECHANICAL``                                |
++---------------------+------------------+--------------------------------------------------------+
 
 **Responses**
 

diff --git a/api/source/job_control/get_transcript.rst b/api/source/job_control/get_transcript.rst
@@ -63,6 +63,19 @@ The job must have completed transcription before a transcript can be downloaded.
 |                               +------------------+-----------------------------------------------------------+
 |                               | `Example`        | ``elementlist_version=2014-07-31T12:35:52Z``              |
 +-------------------------------+------------------+-----------------------------------------------------------+
+| iwp_name                      | .. raw:: html                                                                |
+|                               |                                                                              |
+|                               |  The named version of element list to generate the transcript from.</br>     |
+|                               |  If not specified, the transcript will be generated from the</br>            |
+|                               |  latest version.                                                             |
+|                               |                                                                              |
+|                               +------------------+-----------------------------------------------------------+
+|                               | `Allowed Values` | String                                                    |
+|                               +------------------+-----------------------------------------------------------+
+|                               | `Default Value`  | ""                                                        |
+|                               +------------------+-----------------------------------------------------------+
+|                               | `Example`        | ``iwp_name=MECHANICAL``                                   |
++-------------------------------+------------------+-----------------------------------------------------------+
 | emit_speaker_change_tokens_as | .. raw:: html                                                                |
 |                               |                                                                              |
 |                               |  Determine what characters to use to denote speaker changes.</br>            |