From 62463e399fa8cb3fe0b5bfdabe211d12658e7465 Mon Sep 17 00:00:00 2001
From: Corentin Musard <corentin.musard@tilebox.com>
Date: Mon, 12 May 2025 16:39:45 +0200
Subject: [PATCH] Add clusters doc api-reference for python

---
 .../tilebox.workflows/ClustersClient.all.mdx  | 20 ++++++++++++++
 .../ClustersClient.create.mdx                 | 26 +++++++++++++++++++
 .../ClustersClient.delete.mdx                 | 22 ++++++++++++++++
 .../tilebox.workflows/ClustersClient.find.mdx | 26 +++++++++++++++++++
 mint.json                                     |  4 +++
 5 files changed, 98 insertions(+)
 create mode 100644 api-reference/python/tilebox.workflows/ClustersClient.all.mdx
 create mode 100644 api-reference/python/tilebox.workflows/ClustersClient.create.mdx
 create mode 100644 api-reference/python/tilebox.workflows/ClustersClient.delete.mdx
 create mode 100644 api-reference/python/tilebox.workflows/ClustersClient.find.mdx

diff --git a/api-reference/python/tilebox.workflows/ClustersClient.all.mdx b/api-reference/python/tilebox.workflows/ClustersClient.all.mdx
new file mode 100644
index 0000000..9149db7
--- /dev/null
+++ b/api-reference/python/tilebox.workflows/ClustersClient.all.mdx
@@ -0,0 +1,20 @@
+---
+title: ClustersClient.all
+icon: circle-nodes
+---
+
+```python
+def ClustersClient.all(): list[Cluster]
+```
+
+List all available clusters.
+
+## Returns
+
+A list of all available clusters.
+
+<RequestExample>
+```python Python
+clusters = cluster_client.all()
+```
+</RequestExample>
diff --git a/api-reference/python/tilebox.workflows/ClustersClient.create.mdx b/api-reference/python/tilebox.workflows/ClustersClient.create.mdx
new file mode 100644
index 0000000..bf75ae1
--- /dev/null
+++ b/api-reference/python/tilebox.workflows/ClustersClient.create.mdx
@@ -0,0 +1,26 @@
+---
+title: ClustersClient.create
+icon: circle-nodes
+---
+
+```python
+def ClustersClient.create(name: str): Cluster
+```
+
+Create a cluster.
+
+## Parameters
+
+<ParamField path="name" type="string">
+  A display name for the cluster
+</ParamField>
+
+## Returns
+
+The created cluster object.
+
+<RequestExample>
+```python Python
+cluster = cluster_client.create("My cluster")
+```
+</RequestExample>
diff --git a/api-reference/python/tilebox.workflows/ClustersClient.delete.mdx b/api-reference/python/tilebox.workflows/ClustersClient.delete.mdx
new file mode 100644
index 0000000..f129f52
--- /dev/null
+++ b/api-reference/python/tilebox.workflows/ClustersClient.delete.mdx
@@ -0,0 +1,22 @@
+---
+title: ClustersClient.delete
+icon: circle-nodes
+---
+
+```python
+def ClustersClient.delete(cluster_or_slug: Cluster | str)
+```
+
+Delete a cluster.
+
+## Parameters
+
+<ParamField path="cluster_or_slug" type="Cluster | str">
+  The cluster or cluster slug to delete.
+</ParamField>
+
+<RequestExample>
+```python Python
+cluster_client.delete(cluster)
+```
+</RequestExample>
diff --git a/api-reference/python/tilebox.workflows/ClustersClient.find.mdx b/api-reference/python/tilebox.workflows/ClustersClient.find.mdx
new file mode 100644
index 0000000..6c17934
--- /dev/null
+++ b/api-reference/python/tilebox.workflows/ClustersClient.find.mdx
@@ -0,0 +1,26 @@
+---
+title: ClustersClient.find
+icon: circle-nodes
+---
+
+```python
+def ClustersClient.find(cluster_or_slug: Cluster | str): Cluster
+```
+
+Get a cluster by its slug.
+
+## Parameters
+
+<ParamField path="cluster_or_slug" type="Cluster | str">
+  The cluster or cluster slug to get.
+</ParamField>
+
+## Returns
+
+A cluster object.
+
+<RequestExample>
+```python Python
+cluster = cluster_client.find("my-cluster-CvufcSxcC9SKfe")
+```
+</RequestExample>
diff --git a/mint.json b/mint.json
index adc4841..bdf06cd 100644
--- a/mint.json
+++ b/mint.json
@@ -210,6 +210,10 @@
             "api-reference/python/tilebox.workflows/TaskRunner.run_forever",
             "api-reference/python/tilebox.workflows/ExecutionContext.submit_subtask",
             "api-reference/python/tilebox.workflows/ExecutionContext.job_cache",
+            "api-reference/python/tilebox.workflows/ClustersClient.create",
+            "api-reference/python/tilebox.workflows/ClustersClient.find",
+            "api-reference/python/tilebox.workflows/ClustersClient.delete",
+            "api-reference/python/tilebox.workflows/ClustersClient.all",
             "api-reference/python/tilebox.workflows/JobCache.group",
             "api-reference/python/tilebox.workflows/JobCache.__iter__",
             "api-reference/python/tilebox.workflows/JobClient.submit",