Merge pull request #1300 from sternenseemann/doc-eval-builds

Document all_builds (/eval/{eval-id}/builds) endpoint
NixOS · Sep 9, 2023 · 8520ab1 · 8520ab1
2 parents 8a413ce + e2195c4
commit 8520ab1
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/hydra-api.yaml b/hydra-api.yaml
@@ -551,6 +551,24 @@ paths:
               schema:
                 $ref: '#/components/schemas/JobsetEval'
 
+  /eval/{eval-id}/builds:
+    get:
+      summary: Retrieves all builds belonging to an evaluation identified by eval id
+      parameters:
+        - name: eval-id
+          in: path
+          description: eval identifier
+          required: true
+          schema:
+            type: integer
+      responses:
+        '200':
+          description: builds
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JobsetEvalBuilds'
+
 components:
   schemas:
 
@@ -796,6 +814,13 @@ components:
           additionalProperties:
             $ref: '#/components/schemas/JobsetEvalInput'
 
+    JobsetEvalBuilds:
+      type: array
+      items:
+        type: object
+        additionalProperties:
+          $ref: '#/components/schemas/Build'
+
     JobsetOverview:
       type: array
       items: