[
https://issues.apache.org/jira/browse/AIRFLOW-3395?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16698691#comment-16698691
]
ASF GitHub Bot commented on AIRFLOW-3395:
-----------------------------------------
Fokko closed pull request #4236: [AIRFLOW-3395] Add REST API endpoints to the
docs
URL: https://github.com/apache/incubator-airflow/pull/4236
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/api.rst b/docs/api.rst
index 194809abc6..8ddfa8a4fd 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -24,10 +24,74 @@ available at /api/experimental/. Please note that we expect
the endpoint definit
Endpoints
---------
-This is a place holder until the swagger definitions are active
+.. http:post:: /api/experimental/dags/<DAG_ID>/dag_runs
+
+
+ Creates a dag_run for a given dag id.
+
+
+ **Trigger DAG with config, example:**
+
+ .. code-block:: bash
+
+ curl -X POST \
+ http://localhost:8080/api/experimental/dags/<DAG_ID>/dag_runs \
+ -H 'Cache-Control: no-cache' \
+ -H 'Content-Type: application/json' \
+ -d '{"conf":"{\"key\":\"value\"}"}'
+
+
+.. http:get:: /api/experimental/dags/<DAG_ID>/dag_runs
+
+ Returns a list of Dag Runs for a specific DAG ID.
+
+.. http:get::
/api/experimental/dags/<string:dag_id>/dag_runs/<string:execution_date>
+
+ Returns a JSON with a dag_run's public instance variables. The format for
the <string:execution_date> is expected to be "YYYY-mm-DDTHH:MM:SS", for
example: "2016-11-16T11:34:15".
+
+
+.. http:get:: /api/experimental/test
+
+ To check REST API server correct work. Return status 'OK'.
+
+
+.. http:get:: /api/experimental/dags/<DAG_ID>/tasks/<TASK_ID>
+
+ Returns info for a task.
+
+
+.. http:get::
/api/experimental/dags/<DAG_ID>/dag_runs/<string:execution_date>/tasks/<TASK_ID>
+
+ Returns a JSON with a task instance's public instance variables. The format
for the <string:execution_date> is expected to be "YYYY-mm-DDTHH:MM:SS", for
example: "2016-11-16T11:34:15".
+
+
+.. http:get:: /api/experimental/dags/<DAG_ID>/paused/<string:paused>
+
+ '<string:paused>' must be a 'true' to pause a DAG and 'false' to unpause.
+
+
+.. http:get:: /api/experimental/latest_runs
+
+ Returns the latest DagRun for each DAG formatted for the UI.
+
+
+.. http:get:: /api/experimental/pools
+
+ Get all pools.
+
+
+.. http:get:: /api/experimental/pools/<string:name>
+
+ Get pool by a given name.
+
+.. http:post:: /api/experimental/pools
+
+ Create a pool.
+
+.. http:delete:: /api/experimental/pools/<string:name>
+
+ Delete pool.
-* /api/experimental/dags/<DAG_ID>/tasks/<TASK_ID> returns info for a task
(GET).
-* /api/experimental/dags/<DAG_ID>/dag_runs creates a dag_run for a given dag
id (POST).
CLI
-----
diff --git a/docs/conf.py b/docs/conf.py
index fa2a3d2274..cc00a27641 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -76,6 +76,7 @@
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinxarg.ext',
+ 'sphinxcontrib.httpdomain'
]
autodoc_default_flags = ['show-inheritance', 'members']
diff --git a/setup.py b/setup.py
index e651f5a66e..86fdfa16f7 100644
--- a/setup.py
+++ b/setup.py
@@ -172,6 +172,7 @@ def write_version(filename=os.path.join(*['airflow',
'sphinx>=1.2.3',
'sphinx-argparse>=0.1.13',
'sphinx-rtd-theme>=0.1.6',
+ 'sphinxcontrib-httpdomain>=1.7.0',
'Sphinx-PyPI-upload>=0.2.1'
]
docker = ['docker~=3.0']
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> add to documentation all existed REST API endpoints and example how to pass
> dag_runs params
> -------------------------------------------------------------------------------------------
>
> Key: AIRFLOW-3395
> URL: https://issues.apache.org/jira/browse/AIRFLOW-3395
> Project: Apache Airflow
> Issue Type: Task
> Affects Versions: 1.10.2
> Reporter: Iuliia Volkova
> Assignee: Iuliia Volkova
> Priority: Minor
>
> In doc exist only 2 endpoints https://airflow.apache.org/api.html#endpoints
> In source code
> (https://github.com/apache/incubator-airflow/blob/v1-10-stable/airflow/www_rbac/api/experimental/endpoints.py)
> we have more, caused issues when users think that there are not more methods
> - I got on work project several questions about it and also saw in
> stackoverflow relative questions:
> https://stackoverflow.com/questions/50121593/pass-parameters-to-airflow-experimental-rest-api-when-creating-dag-run
>
> I want to add more information about REST API
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
