Kinesin/daggy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixing up rst

Browse Source
This commit is contained in:
Ian Roddis
2022-02-22 10:36:34 -04:00
parent b63739c0a9
commit 6389f1a508
1 changed files with 38 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
endpoints.rst
View File

@@ -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