Skip to content

docs(api-reference): regenerate v1 API docs (automated) #1679

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
ppiegaze merged 1 commit into from
Oct 5, 2026
Merged

docs(api-reference): regenerate v1 API docs (automated) #1679

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
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Flytekit SDK
description: "This package contains all of the most common abstractions you'll need to write Flyte workflows and extend Flytekit."
icon: book
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.bin.entrypoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.bin.entrypoint
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth.auth_client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth.auth_client
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth.authenticator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth.authenticator
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth.default_html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth.default_html
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth.exceptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth.exceptions
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth.keyring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth.keyring
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth.token_client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth.token_client
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.auth_helper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.auth_helper
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.friendly.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.friendly
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.auth_interceptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.grpc_utils.auth_interceptor
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion .../api-reference/flytekit-sdk/flytekit.clients.grpc_utils.deadline_interceptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.grpc_utils.deadline_interceptor
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion ...erence/flytekit-sdk/flytekit.clients.grpc_utils.default_metadata_interceptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.grpc_utils.default_metadata_interceptor
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion ...eference/flytekit-sdk/flytekit.clients.grpc_utils.wrap_exception_interceptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.grpc_utils.wrap_exception_interceptor
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.helpers
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clients.raw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clients.raw
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.helpers
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.backfill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.backfill
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
4 changes: 1 addition & 3 deletions content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.build
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down Expand Up @@ -143,7 +143,6 @@ class BuildParams(
cluster_pool: str = '',
execution_cluster_label: str = '',
computed_params: flytekit.clis.sdk_in_container.run.RunLevelComputedParams = <factory>,
_remote: typing.Optional[flytekit.remote.remote.FlyteRemote] = None,
fast: bool = False,
)
```
Expand Down Expand Up @@ -179,7 +178,6 @@ class BuildParams(
| `cluster_pool` | `str` | |
| `execution_cluster_label` | `str` | |
| `computed_params` | `flytekit.clis.sdk_in_container.run.RunLevelComputedParams` | |
| `_remote` | `typing.Optional[flytekit.remote.remote.FlyteRemote]` | |
| `fast` | `bool` | |

### Properties
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.constants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.constants
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.executions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.executions
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.helpers
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.metrics
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.package
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.pyflyte.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.pyflyte
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
12 changes: 2 additions & 10 deletions content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.run
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down Expand Up @@ -73,17 +73,11 @@ Returns a list of flyte workflow names and list of Flyte tasks in a file.
#### is_optional()

```python
def is_optional(
_type,
)
def is_optional()
```
Checks if the given type is Optional Type


| Parameter | Type | Description |
|-|-|-|
| `_type` | | |

#### load_naive_entity()

```python
Expand Down Expand Up @@ -457,7 +451,6 @@ class RunLevelParams(
cluster_pool: str = '',
execution_cluster_label: str = '',
computed_params: flytekit.clis.sdk_in_container.run.RunLevelComputedParams = <factory>,
_remote: typing.Optional[flytekit.remote.remote.FlyteRemote] = None,
)
```
| Parameter | Type | Description |
Expand Down Expand Up @@ -492,7 +485,6 @@ class RunLevelParams(
| `cluster_pool` | `str` | |
| `execution_cluster_label` | `str` | |
| `computed_params` | `flytekit.clis.sdk_in_container.run.RunLevelComputedParams` | |
| `_remote` | `typing.Optional[flytekit.remote.remote.FlyteRemote]` | |

### Properties

Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serialize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.serialize
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.serve
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.utils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.sdk_in_container.utils
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.clis.version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.clis.version
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.configuration.default_images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.configuration.default_images
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.configuration.feature_flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.configuration.feature_flags
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.configuration.file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.configuration.file
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.configuration.internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: flytekit.configuration.internal
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
6 changes: 2 additions & 4 deletions content/api-reference/flytekit-sdk/flytekit.configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: flytekit.configuration
description: "There are multiple ways to configure flytekit settings."
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down Expand Up @@ -215,7 +215,7 @@ class Config(
secrets: SecretsConfig = SecretsConfig(env_prefix='_FSEC_', default_dir='/etc/secrets', file_prefix=''),
stats: StatsConfig = StatsConfig(host='localhost', port=8125, disabled=False, disabled_tags=False),
data_config: DataConfig = DataConfig(s3=S3Config(enable_debug=False, endpoint=None, retries=3, backoff=datetime.timedelta(seconds=5), access_key_id=None, secret_access_key=None, adressing_style=None), gcs=GCSConfig(gsutil_parallelism=False), azure=AzureBlobStorageConfig(account_name=None, account_key=None, tenant_id=None, client_id=None, client_secret=None), generic=GenericPersistenceConfig(attach_execution_metadata=True)),
local_sandbox_path: str = '/tmp/flytegaolxhbu',
local_sandbox_path: str = '/tmp/flyte8066zmhd',
)
```
| Parameter | Type | Description |
Expand Down Expand Up @@ -642,7 +642,6 @@ Allows you to programmatically create an ImageConfig. Usually only the default_i

```python
def validate_image(
_: typing.Any,
param: str,
values: tuple,
) -> ImageConfig
Expand All @@ -656,7 +655,6 @@ CLI

| Parameter | Type | Description |
|-|-|-|
| `_` | `typing.Any` | click argument, ignored here. |
| `param` | `str` | the click argument, here should be "image" |
| `values` | `tuple` | user-supplied images |

Expand Down
2 changes: 1 addition & 1 deletion content/api-reference/flytekit-sdk/flytekit.configuration.plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: flytekit.configuration.plugin
description: "Defines a plugin API allowing other libraries to modify the behavior of flytekit."
icon: box-seam
version: 1.16.28
version: 1.16.29
variants: +flyte +union
layout: py_api
---
Expand Down
Loading
Loading