-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(qes): add documents endpoint (#99)
- Loading branch information
1 parent
c72f1bf
commit aa11368
Showing
3 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
documents: | ||
post: | ||
summary: Retrieves the signed document or application form | ||
operationId: download_qes_document | ||
description: > | ||
Retrieves the signed document or application form depending on the file_id provided. | ||
parameters: | ||
- name: workflow_run_id | ||
in: query | ||
required: true | ||
description: The unique identifier of the Workflow Run for which you want to retrieve the signed document. | ||
schema: | ||
type: string | ||
format: uuid | ||
- name: file_id | ||
in: query | ||
required: true | ||
description: The unique identifier of the file which you want to retrieve. | ||
schema: | ||
type: string | ||
format: uuid | ||
|
||
responses: | ||
"302": | ||
description: Found | ||
headers: | ||
Location: | ||
description: Pre-signed URL to download the file. | ||
schema: | ||
type: string | ||
format: uri | ||
"200": | ||
description: The signed document PDF binary data. | ||
content: | ||
application/pdf: | ||
schema: | ||
type: string | ||
format: binary | ||
default: | ||
$ref: ../responses/default_error.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters