.. _rest_v6_diagnostic:

v6 Diagnostic Services
========================================================================================================================

These services provide methods of running tests and diagnostics on Scale.

+-------------------------------------------------------------------------------------------------------------------------+
| **Queue Scale Bake Jobs**                                                                                               |
+=========================================================================================================================+
| Creates and queues a specified number of Scale Bake jobs. Scale Bake jobs wait for 15 minutes and then complete,        |
| allowing a simulation of jobs that take some amount of time to complete.                                                |
+-------------------------------------------------------------------------------------------------------------------------+
| **POST** /v6/diagnostics/job/bake/                                                                                      |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Content Type**   | *application/json*                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **JSON Fields**                                                                                                         |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| num                | Integer           | The number of jobs to create, must be at least one                             |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| .. code-block:: javascript                                                                                              |
|                                                                                                                         |
|    {                                                                                                                    |
|        "num": 100                                                                                                       |
|    }                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+
| **Successful Response**                                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Status**         | 202 ACCEPTED                                                                                       |
+--------------------+----------------------------------------------------------------------------------------------------+

+-------------------------------------------------------------------------------------------------------------------------+
| **Queue Scale Casino Recipes**                                                                                          |
+=========================================================================================================================+
| Creates and queues a specified number of Scale Casino recipes. Scale Casino recipes are useful for testing recipes in   |
| the presence of job failures.                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------+
| **POST** /v6/diagnostics/recipe/casino/                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Content Type**   | *application/json*                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **JSON Fields**                                                                                                         |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| num                | Integer           | The number of recipes to create, must be at least one                          |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| .. code-block:: javascript                                                                                              |
|                                                                                                                         |
|    {                                                                                                                    |
|        "num": 100                                                                                                       |
|    }                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+
| **Successful Response**                                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Status**         | 202 ACCEPTED                                                                                       |
+--------------------+----------------------------------------------------------------------------------------------------+

+-------------------------------------------------------------------------------------------------------------------------+
| **Queue Scale Hello Jobs**                                                                                              |
+=========================================================================================================================+
| Creates and queues a specified number of Scale Hello jobs. Scale Hello jobs simply print out a hello message and are    |
| useful for testing and evaluating Scale's job throughput performance.                                                   |
+-------------------------------------------------------------------------------------------------------------------------+
| **POST** /v6/diagnostics/job/hello/                                                                                     |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Content Type**   | *application/json*                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **JSON Fields**                                                                                                         |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| num                | Integer           | The number of jobs to create, must be at least one                             |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| .. code-block:: javascript                                                                                              |
|                                                                                                                         |
|    {                                                                                                                    |
|        "num": 100                                                                                                       |
|    }                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+
| **Successful Response**                                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Status**         | 202 ACCEPTED                                                                                       |
+--------------------+----------------------------------------------------------------------------------------------------+

+-------------------------------------------------------------------------------------------------------------------------+
| **Queue Scale Roulette Jobs**                                                                                           |
+=========================================================================================================================+
| Creates and queues a specified number of Scale Roulette jobs. Scale Roulette randomly complete/fail with 50% odds and   |
| are useful for testing jobs that both complete and fail.                                                                |
+-------------------------------------------------------------------------------------------------------------------------+
| **POST** /v6/diagnostics/job/roulette/                                                                                  |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Content Type**   | *application/json*                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **JSON Fields**                                                                                                         |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| num                | Integer           | The number of jobs to create, must be at least one                             |
+--------------------+-------------------+--------------------------------------------------------------------------------+
| .. code-block:: javascript                                                                                              |
|                                                                                                                         |
|    {                                                                                                                    |
|        "num": 100                                                                                                       |
|    }                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+
| **Successful Response**                                                                                                 |
+--------------------+----------------------------------------------------------------------------------------------------+
| **Status**         | 202 ACCEPTED                                                                                       |
+--------------------+----------------------------------------------------------------------------------------------------+