Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding support for the download evidence folder endpoint #123

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions generated/artifacts/openapi-yaml/openapi/openapi.yaml
Copy link
Contributor

@dvacca-onfido dvacca-onfido Oct 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miguelfteixeira please move your comments inside the original files (as files inside the generated folder are automatically built)

@HoneyryderChuck please remove generated files from PR and run ./shell/run-prettier.sh script to make the linter is happy about the changes, as in README.md.

Original file line number Diff line number Diff line change
Expand Up @@ -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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Retrieves the signed evidence folder for the designated Workflow Run
Retrieves the evidence folder for the designated Workflow Run

operationId: download_signed_evidence_folder

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
operationId: download_signed_evidence_folder
operationId: download_workflow_run_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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Link to the signed evidence folder.
description: Link to the 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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: Retrieve Workflow Run Evidence Summary File
summary: Retrieve Workflow Run Evidence Folder

/documents:
get:
description: All documents belonging to an applicant can be listed from this
Expand Down
2 changes: 2 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 26 additions & 0 deletions paths/workflow_runs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions schemas/webhooks/definitions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading