From 6389f1a5080582617edff86b08f9c131e83e8d93 Mon Sep 17 00:00:00 2001 From: Ian Roddis Date: Tue, 22 Feb 2022 10:36:34 -0400 Subject: [PATCH] fixing up rst --- endpoints.rst | 68 ++++++++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 30 deletions(-) diff --git a/endpoints.rst b/endpoints.rst index 269e9e8..1e4e409 100644 --- a/endpoints.rst +++ b/endpoints.rst @@ -1,34 +1,37 @@ Paths -=== +===== -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| Path | Verb | Description | Payload | Result | -+==============================================+========+===========================================================================+====================+===============================+ -| ``/ready`` | GET | Ready check | | ``{ "msg": "Ya like DAGs?"}`` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagruns?all=1`` | GET | Retrieve list of known dags | | :ref:`Example List of Runs` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun`` | POST | Submit a DAG for execution | :ref:`Example DAG` | ``{ "runID": 0 }`` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/validate`` | POST | Submit a DAG for validation | :ref:`Example DAG` | ``{ "valid": true }`` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}`` | GET | Retrieve full state of dagrun | | :ref:`Example DAG Run` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}`` | DELETE | Kill a running DAG | | | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}/state`` | GET | Retrieve current state of run | | ``{ "state": "QUEUED" }`` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}/state/{state}`` | PATCH | Set the state of a DAG Run. Can be used to restart an errored/killed DAG. | | ``{ "runID": 0 }`` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}/task/{taskName}`` | GET | Get all the details of a specific task. | | :ref:`Example Task Details` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}/task/{taskName}`` | DELETE | Kill a task | | | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ -| ``/v1/dagrun/{runid}/task/{taskName}/state`` | GET | Get the current state of a task | | ``{ "state": "QUEUED" }`` | -+----------------------------------------------+--------+---------------------------------------------------------------------------+--------------------+-------------------------------+ ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| Path | Verb | Description | Payload | Result | ++==============================================+========+===========================================================================+================+===============================+ +| ``/ready`` | GET | Ready check | | ``{ "msg": "Ya like DAGs?"}`` | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagruns?all=1`` | GET | Retrieve list of known dags | | `Example List of Runs`_ | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun`` | POST | Submit a DAG for execution | `Example DAG`_ | ``{ "runID": 0 }`` | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/validate`` | POST | Submit a DAG for validation | `Example DAG`_ | ``{ "valid": true }`` | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}`` | GET | Retrieve full state of dagrun | | `Example DAG Run`_ | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}`` | DELETE | Kill a running DAG | | | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}/state`` | GET | Retrieve current state of run | | ``{ "state": "QUEUED" }`` | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}/state/{state}`` | PATCH | Set the state of a DAG Run. Can be used to restart an errored/killed DAG. | | ``{ "runID": 0 }`` | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}/task/{taskName}`` | GET | Get all the details of a specific task. | | `Example Task Details`_ | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}/task/{taskName}`` | DELETE | Kill a task | | | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ +| ``/v1/dagrun/{runid}/task/{taskName}/state`` | GET | Get the current state of a task | | ``{ "state": "QUEUED" }`` | ++----------------------------------------------+--------+---------------------------------------------------------------------------+----------------+-------------------------------+ + +.. _`Example List of Runs`: Example List of Runs -=== +==================== + .. code:: json @@ -66,8 +69,10 @@ Example List of Runs } ] +.. _`Example DAG`: + Example DAG -=== +=========== .. code:: json @@ -90,8 +95,10 @@ Example DAG } +.. _`Example DAG Run`: + Example DAG Run -=== +=============== .. code:: json @@ -176,9 +183,10 @@ Example DAG Run ] } +.. _`Example Task Details`: Example Task Details -=== +==================== .. code:: json