Skip to content

Commit 39d901b

Browse files
committed
Document redirects in Hydra API
This documents useful redirects that Hydra exposes
1 parent d135b12 commit 39d901b

File tree

1 file changed

+126
-1
lines changed

1 file changed

+126
-1
lines changed

hydra-api.yaml

Lines changed: 126 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ paths:
443443
content:
444444
application/json:
445445
schema:
446-
$ref: '#/components/schemas/Error'
446+
$ref: '#/components/schemas/Error'A
447447

448448
/job/{project-id}/{jobset-id}/{job-id}/shield:
449449
get:
@@ -551,6 +551,131 @@ paths:
551551
schema:
552552
$ref: '#/components/schemas/JobsetEval'
553553

554+
/jobset/{project-id}/{jobset-id}/latest-eval:
555+
get:
556+
summary: Redirects to the latest finished evaluation for a jobset
557+
parameters:
558+
- name: project-id
559+
in: path
560+
description: project identifier
561+
required: true
562+
schema:
563+
type: string
564+
- name: jobset-id
565+
in: path
566+
description: jobset identifier
567+
required: true
568+
schema:
569+
type: string
570+
responses:
571+
'302':
572+
description: the evaluation to redirect to
573+
headers:
574+
Location:
575+
example: /eval/1?name={jobset-id}
576+
schema:
577+
type: string
578+
579+
/job/{project-id}/{jobset-id}/{job-id}/latest:
580+
get:
581+
summary: Redirects to the latest succesful build for a job
582+
parameters:
583+
- name: project-id
584+
in: path
585+
description: project identifier
586+
required: true
587+
schema:
588+
type: string
589+
- name: jobset-id
590+
in: path
591+
description: jobset identifier
592+
required: true
593+
schema:
594+
type: string
595+
- name: job-id
596+
in: path
597+
description: job identifier
598+
required: true
599+
schema:
600+
type: string
601+
responses:
602+
'302':
603+
description: the build to redirect to
604+
headers:
605+
Location:
606+
example: /build/1
607+
schema:
608+
type: string
609+
610+
/job/{project-id}/{jobset-id}/{job-id}/latest-for/{system}:
611+
get:
612+
summary: Redirects to the latest succesful build for a job
613+
parameters:
614+
- name: project-id
615+
in: path
616+
description: project identifier
617+
required: true
618+
schema:
619+
type: string
620+
- name: jobset-id
621+
in: path
622+
description: jobset identifier
623+
required: true
624+
schema:
625+
type: string
626+
- name: job-id
627+
in: path
628+
description: job identifier
629+
required: true
630+
schema:
631+
type: string
632+
- name: system
633+
in: path
634+
description: system
635+
required: true
636+
schema:
637+
type: string
638+
example: x86_64-linux
639+
responses:
640+
'302':
641+
description: the build to redirect to
642+
headers:
643+
Location:
644+
example: /build/1
645+
schema:
646+
type: string
647+
648+
/job/{project-id}/{jobset-id}/{job-id}/latest-finished:
649+
get:
650+
summary: Redirects to the latest succesful build for a job from a finished evaluation
651+
parameters:
652+
- name: project-id
653+
in: path
654+
description: project identifier
655+
required: true
656+
schema:
657+
type: string
658+
- name: jobset-id
659+
in: path
660+
description: jobset identifier
661+
required: true
662+
schema:
663+
type: string
664+
- name: job-id
665+
in: path
666+
description: job identifier
667+
required: true
668+
schema:
669+
type: string
670+
responses:
671+
'302':
672+
description: the build to redirect to
673+
headers:
674+
Location:
675+
example: /build/1
676+
schema:
677+
type: string
678+
554679
components:
555680
schemas:
556681

0 commit comments

Comments
 (0)