Skip to content

Clarify optional parameters in Airbyte docstrings #30031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 1 commit into from
Mar 11, 2023
Merged

Clarify optional parameters in Airbyte docstrings #30031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions airflow/providers/airbyte/hooks/airbyte.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ class AirbyteHook(HttpHook):
"""
Hook for Airbyte API

:param airbyte_conn_id: Required. The name of the Airflow connection to get
connection information for Airbyte.
:param api_version: Optional. Airbyte API version.
:param airbyte_conn_id: Optional. The name of the Airflow connection to get
connection information for Airbyte. Defaults to "airbyte_default".
:param api_version: Optional. Airbyte API version. Defaults to "v1".
"""

conn_name_attr = "airbyte_conn_id"
Expand Down
15 changes: 8 additions & 7 deletions airflow/providers/airbyte/operators/airbyte.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,17 @@ class AirbyteTriggerSyncOperator(BaseOperator):
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:AirbyteTriggerSyncOperator`

:param airbyte_conn_id: Required. The name of the Airflow connection to get connection
information for Airbyte.
:param airbyte_conn_id: Optional. The name of the Airflow connection to get connection
information for Airbyte. Defaults to "airbyte_default".
:param connection_id: Required. The Airbyte ConnectionId UUID between a source and destination.
:param asynchronous: Optional. Flag to get job_id after submitting the job to the Airbyte API.
This is useful for submitting long running jobs and
waiting on them asynchronously using the AirbyteJobSensor.
:param api_version: Optional. Airbyte API version.
waiting on them asynchronously using the AirbyteJobSensor. Defaults to False.
:param api_version: Optional. Airbyte API version. Defaults to "v1".
:param wait_seconds: Optional. Number of seconds between checks. Only used when ``asynchronous`` is False.
Defaults to 3 seconds.
:param timeout: Optional. The amount of time, in seconds, to wait for the request to complete.
Only used when ``asynchronous`` is False.
Only used when ``asynchronous`` is False. Defaults to 3600 seconds (or 1 hour).
"""

template_fields: Sequence[str] = ("connection_id",)
Expand All @@ -53,10 +54,10 @@ def __init__(
self,
connection_id: str,
airbyte_conn_id: str = "airbyte_default",
asynchronous: bool | None = False,
asynchronous: bool = False,
api_version: str = "v1",
wait_seconds: float = 3,
timeout: float | None = 3600,
timeout: float = 3600,
Comment on lines +57 to +60
Copy link
Contributor Author

@josh-fell josh-fell Mar 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cleaned up some typing as well.

**kwargs,
) -> None:
super().__init__(**kwargs)
Expand Down
6 changes: 3 additions & 3 deletions airflow/providers/airbyte/sensors/airbyte.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ class AirbyteJobSensor(BaseSensorOperator):
Check for the state of a previously submitted Airbyte job.

:param airbyte_job_id: Required. Id of the Airbyte job
:param airbyte_conn_id: Required. The name of the Airflow connection to get
connection information for Airbyte.
:param api_version: Optional. Airbyte API version.
:param airbyte_conn_id: Optional. The name of the Airflow connection to get
connection information for Airbyte. Defaults to "airbyte_default".
:param api_version: Optional. Airbyte API version. Defaults to "v1".
"""

template_fields: Sequence[str] = ("airbyte_job_id",)
Expand Down