diff --git a/generated/artifacts/openapi-yaml/openapi/openapi.yaml b/generated/artifacts/openapi-yaml/openapi/openapi.yaml index 1ffd94fe..ee2c278c 100644 --- a/generated/artifacts/openapi-yaml/openapi/openapi.yaml +++ b/generated/artifacts/openapi-yaml/openapi/openapi.yaml @@ -334,6 +334,35 @@ paths: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve Workflow Run Evidence Summary File + /workflow_runs/{workflow_run_id}/evidence_folder: + get: + description: | + Retrieves the signed evidence folder for the designated Workflow Run + operationId: download_signed_evidence_folder + parameters: + - description: Workflow Run ID + in: path + name: workflow_run_id + required: true + schema: + format: uuid + type: string + responses: + "302": + description: Found + headers: + Location: + description: Link to the signed evidence folder. + schema: + format: uri + type: string + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Retrieve Workflow Run Evidence Summary File /documents: get: description: All documents belonging to an applicant can be listed from this diff --git a/openapi.yaml b/openapi.yaml index 2dea46f6..6fb6f793 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -45,6 +45,8 @@ paths: $ref: paths/workflow_runs.yaml#/retrieve /workflow_runs/{workflow_run_id}/signed_evidence_file: $ref: paths/workflow_runs.yaml#/signed_evidence_file + /workflow_runs/{workflow_run_id}/evidence_folder: + $ref: paths/workflow_runs.yaml#/evidence_folder # Documents /documents: $ref: paths/documents.yaml#/documents diff --git a/paths/workflow_runs.yaml b/paths/workflow_runs.yaml index 0b4b1512..079631c6 100644 --- a/paths/workflow_runs.yaml +++ b/paths/workflow_runs.yaml @@ -126,3 +126,29 @@ signed_evidence_file: format: binary default: $ref: ../responses/default_error.yaml + +evidence_folder: + get: + summary: Retrieve Workflow Run Evidence Folder + operationId: download_signed_evidence_folder + description: > + Retrieves the signed evidence folder for the designated Workflow Run + parameters: + - name: workflow_run_id + in: path + description: Workflow Run ID + required: true + schema: + type: string + format: uuid + responses: + "302": + description: Found + headers: + Location: + description: Link to the signed evidence folder. + schema: + type: string + format: uri + default: + $ref: ../responses/default_error.yaml \ No newline at end of file diff --git a/schemas/webhooks/definitions.yaml b/schemas/webhooks/definitions.yaml index 3f204fc9..8511bc48 100644 --- a/schemas/webhooks/definitions.yaml +++ b/schemas/webhooks/definitions.yaml @@ -73,6 +73,7 @@ webhook_event_type: - report.completed - workflow_timeline_file.created - workflow_signed_evidence_file.created + - workflow_evidence_folder.created webhook_url: type: string