Merge pull request #11 from Cielo24/feature/CLC-61

[CLC-61] Added documentation for JobDifficulty field.
cielo24 · Jun 25, 2015 · 9cee4cd · 9cee4cd
2 parents 07e21c3 + e4af0dc
commit 9cee4cd
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 3 deletions.
diff --git a/api/source/job_control/job_info.rst b/api/source/job_control/job_info.rst
@@ -102,4 +102,5 @@ Get a list of all tasks associated with an existing job.
             ]
         },
         "Options": {},
+        "JobDifficulty": "Unknown"
     }
diff --git a/api/source/job_control/job_list.rst b/api/source/job_control/job_list.rst
@@ -189,6 +189,15 @@ The list is sorted by default to the creation time of the job, descending.
 |                         +------------------+----------------------------------------------------+
 |                         | `Example`        | ``Username=my_account_name``                       |
 +-------------------------+------------------+----------------------------------------------------+
+| JobDifficulty           | `Description`    | .. raw:: html                                      |
+|                         |                  |                                                    |
+|                         |                  |  List jobs with the specified JobDifficulty.</br>  |
+|                         |                  |                                                    |
+|                         +------------------+----------------------------------------------------+
+|                         | `Allowed Values` | :ref:`job-difficulty-label`                        |
+|                         +------------------+----------------------------------------------------+
+|                         | `Example`        | ``JobDifficulty=Good``                             |
++-------------------------+------------------+----------------------------------------------------+
 
 **Responses**
 
@@ -279,6 +288,7 @@ The list is sorted by default to the creation time of the job, descending.
                     }
                 ]
             },
-            "Options": {}
+            "Options": {},
+            "JobDifficulty": "Unknown"
         }]
     }
diff --git a/api/source/output_formats/enums.rst b/api/source/output_formats/enums.rst
@@ -137,6 +137,30 @@ Fidelity Enumeration
     PROFESSIONAL</br>
     </font>
 
+.. _job-difficulty-label:
+
+JobDifficulty Enumeration
+----------------------
+
+.. raw:: html
+
+    Indicates whether the job was difficult to process. This difficulty could be due to issues with media quality, cross-talk and background noise in the audio, strong accents of speakers, or complicated subject matter. The value of this field will update as the job is processed but will not change once the job has completed.
+    <font color="firebrick">
+    <p>
+    <span style="padding: 20px">
+    Good
+    <font color="black"> - The job was processed without any major problems.</font>
+    </br>
+    <span style="padding: 20px">
+    Bad
+    <font color="black"> - A significant amount of the job was difficult to process. This may cause a delay of the expected due date.</font>
+    </br>
+    <span style="padding: 20px">
+    Unknown
+    <font color="black"> - Not enough of the job has been analyzed at this time to determine whether it is difficult.</font>
+    </br>
+    </font>
+
 .. _caption-format-label:
 
 Caption Format Enumeration

diff --git a/api/source/output_formats/formats.rst b/api/source/output_formats/formats.rst
@@ -38,9 +38,22 @@ The following defines the Job Info in JSON format:
         "Tasks" :
         [
             "List of Task Statuses (see below)"
-        ]
+        ],
+        "JobDifficulty" : "<JobDifficulty Enum>",
     }
 
+.. container::
+
+    Related: :ref:`priority-label`,
+    :ref:`fidelity-label`,
+    :ref:`job-status-label`,
+    :ref:`job-difficulty-label`
+    .
+
+.. raw:: html
+
+    </br>
+
 .. _task-status-format-label:
 
 Task Status Format
@@ -121,13 +134,15 @@ The following defines the Job in JSON format:
         "StartDate" : "<ISO 8601 Date String>",
         "DueDate" : "<ISO 8601 Date String>",
         "CompletedDate" : "<ISO 8601 Date String>",
+        "JobDifficulty" : "<JobDifficulty Enum>",
     }
 
 .. container::
 
     Related: :ref:`job-status-label`,
     :ref:`fidelity-label`,
-    :ref:`priority-label`
+    :ref:`priority-label`,
+    :ref:`job-difficulty-label`
     .
 
 .. raw:: html