From b88b06dd3c857ad4fcd23f406fa95960803aa067 Mon Sep 17 00:00:00 2001
From: Arian van Putten <arian@mercury.com>
Date: Thu, 20 Jul 2023 14:05:48 +0200
Subject: [PATCH] Document redirects in Hydra API

This documents useful redirects that Hydra exposes
---
 hydra-api.yaml | 125 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 125 insertions(+)

diff --git a/hydra-api.yaml b/hydra-api.yaml
index aa89b015..df9af7ef 100644
--- a/hydra-api.yaml
+++ b/hydra-api.yaml
@@ -574,6 +574,131 @@ paths:
               schema:
                 $ref: '#/components/schemas/JobsetEvalBuilds'
 
+  /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: