Document list jobs

Author: corentinmusard

api-reference/python/tilebox.workflows/JobClient.all.mdx

@@ -0,0 +1,32 @@
+---
+title: JobClient.all
+icon: diagram-project
+---
+
+```python
+def JobClient.all(temporal_extent: TimeIntervalLike) -> list[Job]
+```
+
+List all available jobs.
+
+## Parameters
+
+<ParamField path="temporal_extent" type="TimeIntervalLike">
+  The interval for which to load jobs.
+  It can be specified in the following ways:
+      - TimeInterval: interval -> Use the time interval as its given
+      - DatetimeScalar: [time, time] -> Construct a TimeInterval with start and end time set to the given
+          value and the end time inclusive
+      - tuple of two DatetimeScalar: [start, end) -> Construct a TimeInterval with the given start and
+          end time
+</ParamField>
+
+## Returns
+
+A list of jobs.
+
+<RequestExample>
+```python Python
+jobs = job_client.all(("2025-01-01", "2025-02-01"))
+```
+</RequestExample>

api-reference/python/tilebox.workflows/JobClient.find.mdx

@@ -0,0 +1,26 @@
+---
+title: JobClient.find
+icon: diagram-project
+---
+
+```python
+def JobClient.find(job_or_id: Job | str) -> Job
+```
+
+Get a job by its id. Can also be an existing job object, in which case this method acts as a refresh operation to fetch the latest job details.
+
+## Parameters
+
+<ParamField path="job_or_id" type="Job | str">
+  The job or job id to get.
+</ParamField>
+
+## Returns
+
+A job object.
+
+<RequestExample>
+```python Python
+job = job_client.find("0195c87a-49f6-5ffa-e3cb-92215d057ea6")
+```
+</RequestExample>

api-reference/python/tilebox.workflows/JobClient.retry.mdx

@@ -4,7 +4,7 @@ icon: diagram-project
 ---
 
 ```python
-def JobClient.retry(job_or_id: Job | str)
+def JobClient.retry(job_or_id: Job | str) -> int
 ```
 
 Retry a job. All failed tasks will become queued again, and queued tasks will be picked up by task runners again.
@@ -15,8 +15,12 @@ Retry a job. All failed tasks will become queued again, and queued tasks will be
   The job or job id to retry.
 </ParamField>
 
+## Returns
+
+The number of tasks that were rescheduled.
+
 <RequestExample>
 ```python Python
-job_client.retry(job)
+nb_rescheduled = job_client.retry(job)
 ```
 </RequestExample>

mint.json

@@ -222,9 +222,11 @@
             "api-reference/python/tilebox.workflows/JobCache.group",
             "api-reference/python/tilebox.workflows/JobCache.__iter__",
             "api-reference/python/tilebox.workflows/JobClient.submit",
+            "api-reference/python/tilebox.workflows/JobClient.find",
             "api-reference/python/tilebox.workflows/JobClient.retry",
             "api-reference/python/tilebox.workflows/JobClient.cancel",
-            "api-reference/python/tilebox.workflows/JobClient.visualize"
+            "api-reference/python/tilebox.workflows/JobClient.visualize",
+            "api-reference/python/tilebox.workflows/JobClient.list"
           ]
         }
       ]

workflows/concepts/jobs.mdx

@@ -86,6 +86,39 @@ myJob, err := client.Jobs.Submit(ctx, "my-job", cluster,
 
 In this example, if `MyFlakyTask` fails, it will be retried up to five times before being marked as failed.
 
+## Listing jobs
+
+You can list all jobs in a given time range using the `all` method on the job client.
+
+<CodeGroup>
+```python Python
+jobs = job_client.all(("2025-01-01", "2025-02-01"))
+print(jobs)
+```
+```go Go
+import (
+  "time"
+  workflows "github.com/tilebox/tilebox-go/workflows/v1"
+	"github.com/tilebox/tilebox-go/query"
+)
+
+interval := query.NewTimeInterval(
+  time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC),
+  time.Date(2025, 2, 1, 0, 0, 0, 0, time.UTC),
+)
+
+jobs, err := workflows.Collect(client.Jobs.List(ctx, interval))
+if err != nil {
+    slog.Error("Failed to list jobs", slog.Any("error", err))
+    return
+}
+
+for _, job := range jobs {
+    fmt.Println(job)
+}
+```
+</CodeGroup>
+
 ## Retrieving a specific job
 
 When you submit a job, it's assigned a unique identifier that can be used to retrieve it later.
@@ -522,7 +555,7 @@ job_client.retry(job)
 job_client.display(job)
 ```
 ```go Go
-err = client.Jobs.Retry(ctx, job.ID)
+_, err := client.Jobs.Retry(ctx, job.ID)
 ```
 </CodeGroup>