Fokko commented on a change in pull request #4236: [AIRFLOW-3395] added the REST API endpoints to the doc URL: https://github.com/apache/incubator-airflow/pull/4236#discussion_r236085824
########## File path: docs/api.rst ########## @@ -24,10 +24,73 @@ 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 (POST). + + + **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 (GET). Review comment: Same here. ---------------------------------------------------------------- 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] With regards, Apache Git Services
