Single file specifications refresh (54ce45f)

onfido · Jan 7, 2025 · 46d2c4a · 46d2c4a
1 parent 54ce45f
commit 46d2c4a
Show file tree

Hide file tree

Showing 3 changed files with 143 additions and 0 deletions.
diff --git a/generated/artifacts/openapi-reference/openapi.json b/generated/artifacts/openapi-reference/openapi.json
@@ -501,6 +501,61 @@
         "tags": ["Core Resources | Workflow Runs"]
       }
     },
+    "/workflow_runs/{workflow_run_id}/evidence_folder": {
+      "get": {
+        "description": "Retrieves the evidence folder for the designated Workflow Run\n",
+        "operationId": "download_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 evidence folder.",
+                "schema": {
+                  "format": "uri",
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "200": {
+            "content": {
+              "application/zip": {
+                "schema": {
+                  "format": "binary",
+                  "type": "string"
+                }
+              }
+            },
+            "description": "The evidence folder binary data."
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Unexpected error"
+          }
+        },
+        "summary": "Retrieve Workflow Run Evidence Folder",
+        "tags": ["Core Resources | Workflow Runs"]
+      }
+    },
     "/documents": {
       "get": {
         "description": "All documents belonging to an applicant can be listed from this endpoint",

diff --git a/generated/artifacts/openapi-yaml/openapi/openapi.yaml b/generated/artifacts/openapi-yaml/openapi/openapi.yaml
@@ -334,6 +334,42 @@ 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 evidence folder for the designated Workflow Run
+      operationId: download_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 evidence folder.
+              schema:
+                format: uri
+                type: string
+        "200":
+          content:
+            application/zip:
+              schema:
+                format: binary
+                type: string
+          description: The evidence folder binary data.
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+          description: Unexpected error
+      summary: Retrieve Workflow Run Evidence Folder
   /documents:
     get:
       description: All documents belonging to an applicant can be listed from this

diff --git a/generated/artifacts/openapi/openapi.json b/generated/artifacts/openapi/openapi.json
@@ -465,6 +465,58 @@
         "summary" : "Retrieve Workflow Run Evidence Summary File"
       }
     },
+    "/workflow_runs/{workflow_run_id}/evidence_folder" : {
+      "get" : {
+        "description" : "Retrieves the evidence folder for the designated Workflow Run\n",
+        "operationId" : "download_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 evidence folder.",
+                "schema" : {
+                  "format" : "uri",
+                  "type" : "string"
+                }
+              }
+            }
+          },
+          "200" : {
+            "content" : {
+              "application/zip" : {
+                "schema" : {
+                  "format" : "binary",
+                  "type" : "string"
+                }
+              }
+            },
+            "description" : "The evidence folder binary data."
+          },
+          "default" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Error"
+                }
+              }
+            },
+            "description" : "Unexpected error"
+          }
+        },
+        "summary" : "Retrieve Workflow Run Evidence Folder"
+      }
+    },
     "/documents" : {
       "get" : {
         "description" : "All documents belonging to an applicant can be listed from this endpoint",