includes GET /jobs/successful

zamzar · Mar 22, 2024 · 87dc61c · 87dc61c
1 parent f1af990
commit 87dc61c
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/openapi/spec.yaml b/openapi/spec.yaml
@@ -643,6 +643,43 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Job'
+  /jobs/successful:
+    get:
+      tags:
+        - Jobs
+      summary: Retrieve a list of all successful jobs
+      description: Retrieve a list of all successful jobs
+      operationId: listSuccessfulJobs
+      parameters:
+        - in: query
+          name: limit
+          required: false
+          schema:
+            type: integer
+            default: 50
+          description: Limit the number of results (max 50)
+          example: 25
+        - in: query
+          name: after
+          required: false
+          schema:
+            type: integer
+          description: Retrieve jobs after the specified jobId
+          example: 42
+        - in: query
+          name: before
+          required: false
+          schema:
+            type: integer
+          description: Retrieve jobs after the specified jobId
+          example: 42
+      responses:
+        '200':
+          description: A list of all successful jobs.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Jobs'
   '/jobs/{jobId}':
     get:
       tags: