Document redirects in Hydra API

This documents useful redirects that Hydra exposes
NixOS · Jul 20, 2023 · 2f68d12 · 2f68d12
1 parent d135b12
commit 2f68d12
Showing 1 changed file with 125 additions and 1 deletion.
diff --git a/hydra-api.yaml b/hydra-api.yaml
@@ -444,7 +444,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-
   /job/{project-id}/{jobset-id}/{job-id}/shield:
     get:
       summary: Generate data for a shields.io badge
@@ -551,6 +550,131 @@ paths:
               schema:
                 $ref: '#/components/schemas/JobsetEval'
 
+  /jobset/{project-id}/{jobset-id}/latest-eval:
+    get:
+      summary: Redirects to the latest finished evaluation for a jobset
+      parameters:
+      - name: project-id
+        in: path
+        description: project identifier
+        required: true
+        schema:
+          type: string
+      - name: jobset-id
+        in: path
+        description: jobset identifier
+        required: true
+        schema:
+          type: string
+      responses:
+        '302':
+          description: the evaluation to redirect to
+          headers:
+            Location:
+              example: /eval/1?name={jobset-id}
+              schema:
+                type: string
+
+  /job/{project-id}/{jobset-id}/{job-id}/latest:
+    get:
+      summary: Redirects to the latest succesful build for a job
+      parameters:
+      - name: project-id
+        in: path
+        description: project identifier
+        required: true
+        schema:
+          type: string
+      - name: jobset-id
+        in: path
+        description: jobset identifier
+        required: true
+        schema:
+          type: string
+      - name: job-id
+        in: path
+        description: job identifier
+        required: true
+        schema:
+          type: string
+      responses:
+        '302':
+          description: the build to redirect to
+          headers:
+            Location:
+              example: /build/1
+              schema:
+                type: string
+
+  /job/{project-id}/{jobset-id}/{job-id}/latest-for/{system}:
+    get:
+      summary: Redirects to the latest succesful build for a job
+      parameters:
+      - name: project-id
+        in: path
+        description: project identifier
+        required: true
+        schema:
+          type: string
+      - name: jobset-id
+        in: path
+        description: jobset identifier
+        required: true
+        schema:
+          type: string
+      - name: job-id
+        in: path
+        description: job identifier
+        required: true
+        schema:
+          type: string
+      - name: system
+        in: path
+        description: system
+        required: true
+        schema:
+          type: string
+        example: x86_64-linux
+      responses:
+        '302':
+          description: the build to redirect to
+          headers:
+            Location:
+              example: /build/1
+              schema:
+                type: string
+
+  /job/{project-id}/{jobset-id}/{job-id}/latest-finished:
+    get:
+      summary: Redirects to the latest succesful build for a job from a finished evaluation
+      parameters:
+      - name: project-id
+        in: path
+        description: project identifier
+        required: true
+        schema:
+          type: string
+      - name: jobset-id
+        in: path
+        description: jobset identifier
+        required: true
+        schema:
+          type: string
+      - name: job-id
+        in: path
+        description: job identifier
+        required: true
+        schema:
+          type: string
+      responses:
+        '302':
+          description: the build to redirect to
+          headers:
+            Location:
+              example: /build/1
+              schema:
+                type: string
+
 components:
   schemas: