[GitHub] [airflow] shuva10v opened a new pull request #5260: [AIRFLOW-4482] Add execution_date to trigger DAG run API response

[GitBox <gi...@apache.org>]

shuva10v opened a new pull request #5260: [AIRFLOW-4482] Add execution_date to trigger DAG run API response
URL: https://github.com/apache/airflow/pull/5260
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow Jira AIRFLOW-4482](https://issues.apache.org/jira/browse/AIRFLOW-4482) issues and references them in the PR title. 
   
   ### Description
   
   - [ ] Here are some details about my PR, including screenshots of any UI changes:
   
   We are using experimental REST API for automating Airflow from Jenkins and our workflow looks like this:
    * Jenkins job triggers DAG run (using _POST /api/experimental/dags/**<dag_id>**/dag_runs_)
    * Airflow API returns response like this: 
   
   `
   {"message":"Created <DagRun dag_id @ 2019-05-08 11:42:43+00:00: run_id, externally triggered: True>"}
   `
    * Jenkins job parses the response for **execution_date** (2019-05-08T11:42:43 for response above)
    * Jenkins job further uses execution_date to check DAG run state using _POST /api/experimental/dags/**<dag_id>**/dag_runs/**<execution_date>**_
    * Also Jenkins job generates DAG run UI link
   
   Here is [the code](https://github.com/doublescoring/jenkins-pipeline-goodness/blob/master/src/main/groovy/airflow.groovy) - how it works.
   
   Actually it is not a good idea to parse message string for execution_date. So it is proposed to add **execution_date** in DAG run trigger API response as a field. It makes it possible to get execution_date directly from the response without dirty and unpredictable parsing. After this improvement API response will be like this:
   
   `
   {'execution_date': '2019-05-08T07:03:09+00:00', 'message': 'Created <DagRun dag_id @ 2019-05-08 07:03:09+00:00: manual__2019-05-08T07:03:09+00:00, externally triggered: True>'}
   ` 
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   Asserts added for test_endpoints.test_trigger_dag
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
     - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
   ### Code Quality
   
   - [ ] Passes `flake8`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services