[jira] [Updated] (AIRFLOW-2959) HTTPSensor doc/comment is not clear enough

["Xiaodong DENG (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AIRFLOW-2959?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Xiaodong DENG updated AIRFLOW-2959:
-----------------------------------
    Description: 
The HTTPSensor is supposed to sense if a resource/endpoint if available at a location specified by http connection. It will return False when the HTTP Status code is 404 or check function returns False.

However, HTTP Error code other than 404, or Connection Refused, would fail the sensor itself directly (no more poking) [https://github.com/apache/incubator-airflow/blob/f6191fbd7a61766bd002873db371b74702b13ff3/airflow/sensors/http_sensor.py#L90]. This is not clear enough in the doc. Users like myself may think these situations will also return False and try poking later, while it's not true.

This should be made clear in the documetation.

  was:
The HTTPSensor is supposed to sense if a resource/endpoint if available at a location specified by http connection. It will return False when the HTTP Status code is 404 or check function returns False.

However, HTTP Error code other than 404, or Connection Refused, would fail the sensor
 itself directly (no more poking). This is not clear enough in the doc. Users like myself may think these situations will also return False and try poking later, while it's not true.

This should be made clear in the documetation.


> HTTPSensor doc/comment is not clear enough
> ------------------------------------------
>
>                 Key: AIRFLOW-2959
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2959
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: operators
>            Reporter: Xiaodong DENG
>            Assignee: Xiaodong DENG
>            Priority: Minor
>
> The HTTPSensor is supposed to sense if a resource/endpoint if available at a location specified by http connection. It will return False when the HTTP Status code is 404 or check function returns False.
> However, HTTP Error code other than 404, or Connection Refused, would fail the sensor itself directly (no more poking) [https://github.com/apache/incubator-airflow/blob/f6191fbd7a61766bd002873db371b74702b13ff3/airflow/sensors/http_sensor.py#L90]. This is not clear enough in the doc. Users like myself may think these situations will also return False and try poking later, while it's not true.
> This should be made clear in the documetation.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)