update openapi spec

fix api fix
checkmarble · Dec 19, 2023 · cadb40c · cadb40c
1 parent bca5b2a
commit cadb40c
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 0 deletions.
diff --git a/packages/marble-api/scripts/openapi.yaml b/packages/marble-api/scripts/openapi.yaml
@@ -495,6 +495,40 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /cases/files/${caseFileId}/download_link:
+    get:
+      tags:
+        - Cases
+      summary: Download a case file
+      operationId: downloadCaseFile
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: caseFileId
+          description: ID of the case file that needs to be downloaded
+          in: path
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: Signed url to download the case file's content
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - url
+                properties:
+                  url:
+                    type: string
+                    format: uri
+                    description: Signed url to download the case file's content
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
   /tags:
     get:
       tags:
@@ -3012,6 +3046,7 @@ components:
           required:
             - decisions
             - events
+            - files
           properties:
             decisions:
               type: array
@@ -3021,6 +3056,10 @@ components:
               type: array
               items:
                 $ref: '#/components/schemas/CaseEventDto'
+            files:
+              type: array
+              items:
+                $ref: '#/components/schemas/CaseFile'
     CaseEventDto:
       type: object
       discriminator:
@@ -3054,6 +3093,25 @@ components:
           format: date-time
         event_type:
           type: string
+    CaseFile:
+      type: object
+      required:
+        - id
+        - case_id
+        - created_at
+        - file_name
+      properties:
+        id:
+          type: string
+          format: uuid
+        case_id:
+          type: string
+          format: uuid
+        created_at:
+          type: string
+          format: date-time
+        file_name:
+          type: string
     CaseTag:
       type: object
       required:

diff --git a/packages/marble-api/src/generated/marble-api.ts b/packages/marble-api/src/generated/marble-api.ts
@@ -139,9 +139,16 @@ export type FileAddedEvent = {
     additional_note: string;
 };
 export type CaseEventDto = CaseCreatedEvent | CaseStatusUpdatedEvent | DecisionAddedEvent | CommentAddedEvent | NameUpdatedEvent | CaseTagsUpdatedEventDto | FileAddedEvent;
+export type CaseFile = {
+    id: string;
+    case_id: string;
+    created_at: string;
+    file_name: string;
+};
 export type CaseDetailDto = Case & {
     decisions: Decision[];
     events: CaseEventDto[];
+    files: CaseFile[];
 };
 export type UpdateCaseBody = {
     name?: string;
@@ -752,6 +759,25 @@ export function updateTagsForCase(caseId: string, body: {
         body
     })));
 }
+/**
+ * Download a case file
+ */
+export function downloadCaseFile(caseFileId: string, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: {
+            url: string;
+        };
+    } | {
+        status: 401;
+        data: string;
+    } | {
+        status: 403;
+        data: string;
+    }>(`/cases/files/$${encodeURIComponent(caseFileId)}/download_link`, {
+        ...opts
+    }));
+}
 /**
  * List tags
  */