[GitHub] xnuinside opened a new pull request #4236: [AIRFLOW-3395] added the REST API endpoints to the doc

[GitBox]

xnuinside opened a new pull request #4236: [AIRFLOW-3395] added the REST API 
endpoints to the doc
URL: https://github.com/apache/incubator-airflow/pull/4236
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow 
Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references 
them in the PR title. For example, "\[AIRFLOW-3395\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-3395
     - In case you are fixing a typo in the documentation you can prepend your 
commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
   
   ### Description
   
   - [ ] Here are some details about my PR, including screenshots of any UI 
changes:
   
   I don't see any task about start using swagger or something else, so I added 
temporary doc for informing about existed endpoints
   
   I also try to use flask autodoc 
https://sphinxcontrib-httpdomain.readthedocs.io/en/stable/#module-sphinxcontrib.autohttp.flask
 but has an issue relative to defining flask app, I believe need to do some 
refactor to use flask app, so I just used simple httpdomain sphinx.
   
   Added info about REST API endpoints in doc 
   result doc preview: 
   <img width="400" alt="screen shot 2018-11-25 at 21 10 37" 
src="https://user-images.githubusercontent.com/15959809/48982716-3addc180-f0f7-11e8-8113-7667873ba110.png";>
   <img width="400" alt="screen shot 2018-11-25 at 21 10 43" 
src="https://user-images.githubusercontent.com/15959809/48982717-3b765800-f0f7-11e8-8550-c7afe7612cb6.png";>
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for 
this extremely good reason:
   
   ### 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.
     - When adding new operators/hooks/sensors, the autoclass documentation 
generation needs to be added.
   
   ### Code Quality
   
   - [ ] Passes `flake8`
   

----------------------------------------------------------------
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:
us...@infra.apache.org


With regards,
Apache Git Services