Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
168 changes: 168 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,172 @@
# Reference
<details><summary><code>client.<a href="src/truefoundry_sdk/base_client.py">apply</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Applies a given manifest to create or update resources of specific types, such as provider-account, cluster, workspace, or ml-repo.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from truefoundry_sdk import Collaborator, MlRepoManifest, TrueFoundry

client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.apply(
manifest=MlRepoManifest(
name="name",
storage_integration_fqn="storage_integration_fqn",
collaborators=[
Collaborator(
subject="subject",
role_id="role_id",
)
],
),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**manifest:** `TrueFoundryApplyRequestManifest` — manifest of the resource to be created or updated

</dd>
</dl>

<dl>
<dd>

**dry_run:** `typing.Optional[bool]` — Dry run the apply operation without actually applying

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.<a href="src/truefoundry_sdk/base_client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes resources of specific types, such as provider-account, cluster, workspace, or application.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from truefoundry_sdk import Collaborator, MlRepoManifest, TrueFoundry

client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.delete(
manifest=MlRepoManifest(
name="name",
storage_integration_fqn="storage_integration_fqn",
collaborators=[
Collaborator(
subject="subject",
role_id="role_id",
)
],
),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**manifest:** `TrueFoundryDeleteRequestManifest` — manifest of the resource to be deleted

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Internal
<details><summary><code>client.internal.<a href="src/truefoundry_sdk/internal/client.py">get_id_from_fqn</a>(...)</code></summary>
<dl>
Expand Down
Loading