[dagster-airbyte][docs] Update airbyte API docs with asset decorator,…

… factory and materialization method
dagster-io · Dec 19, 2024 · 44e7091 · 44e7091
1 parent e1831a6
commit 44e7091
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 1 deletion.
diff --git a/docs/content/api/modules.json.gz b/docs/content/api/modules.json.gz
diff --git a/docs/content/api/searchindex.json.gz b/docs/content/api/searchindex.json.gz
diff --git a/docs/content/api/sections.json.gz b/docs/content/api/sections.json.gz
diff --git a/docs/next/public/objects.inv b/docs/next/public/objects.inv
diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-airbyte.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-airbyte.rst
@@ -17,6 +17,10 @@ Assets (Airbyte API)
 
 .. autofunction:: load_airbyte_cloud_asset_specs
 
+.. autodecorator:: airbyte_assets
+
+.. autofunction:: build_airbyte_assets_definitions
+
 
 Legacy
 ======

diff --git a/python_modules/libraries/dagster-airbyte/dagster_airbyte/asset_defs.py b/python_modules/libraries/dagster-airbyte/dagster_airbyte/asset_defs.py
@@ -1062,6 +1062,7 @@ def build_airbyte_assets_definitions(
 
     Examples:
         Sync the tables of a Airbyte connection:
+
         .. code-block:: python
 
             from dagster_airbyte import AirbyteCloudWorkspace, build_airbyte_assets_definitions
@@ -1083,6 +1084,7 @@ def build_airbyte_assets_definitions(
             )
 
         Sync the tables of a Airbyte connection with a custom translator:
+
         .. code-block:: python
 
             from dagster_airbyte import (

diff --git a/python_modules/libraries/dagster-airbyte/dagster_airbyte/resources.py b/python_modules/libraries/dagster-airbyte/dagster_airbyte/resources.py
@@ -21,7 +21,7 @@
     get_dagster_logger,
     resource,
 )
-from dagster._annotations import experimental
+from dagster._annotations import experimental, public
 from dagster._config.pythonic_config import infer_schema_from_config_class
 from dagster._core.definitions.asset_spec import AssetSpec
 from dagster._core.definitions.definitions_load_context import StateBackedDefinitionsLoader
@@ -1258,6 +1258,7 @@ def _generate_materialization(
                     metadata=stream_asset_spec.metadata,
                 )
 
+    @public
     @experimental
     def sync_and_poll(self, context: AssetExecutionContext):
         """Executes a sync and poll process to materialize Airbyte Cloud assets.
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,10 @@ Assets (Airbyte API) @@
     .. autofunction:: load_airbyte_cloud_asset_specs
+    .. autodecorator:: airbyte_assets
+    .. autofunction:: build_airbyte_assets_definitions
     Legacy
     ======
@@ Expand Down @@