Merge pull request #401 from PermanentOrg/deprecate_content_type_on_a…

…rchive_record_creation Deprecated the contentType parameter of createArchiveRecord requests
PermanentOrg · Oct 15, 2024 · c06c6e8 · c06c6e8
2 parents 2c3f508 + 9f1040c
commit c06c6e8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -155,7 +155,7 @@ ArchiveRecord {
 ```
 CreateArchiveRecordParams {
   s3Url: string;
-  file: Pick<File, 'contentType' | 'size'>;
+  file: Pick<Partial<File>, 'contentType'> & Pick<File, 'size'>;
   item: Pick<ArchiveRecord, 'displayName' | 'fileSystemCompatibleName'>;
   parentFolder: Pick<Folder, 'id'>;
 }
@@ -165,6 +165,9 @@ s3Url will generally be the value returned by `uploadFile`. Run
 `createArchiveRecord` to store information about uploaded files in the
 Permanent database.
 
+file.contentType is deprecated. The field is still accepted for backwards compatibility, but it is not used.
+The content type is determined by the file extension of the uploaded file.
+
 ```
 createArchiveRecord(
   clientConfiguration: ClientConfiguration,

diff --git a/src/api/createRecordVo.ts b/src/api/createRecordVo.ts
@@ -13,7 +13,7 @@ export interface CreateRecordVoRequest {
   displayName: string;
   parentFolderId: number;
   uploadFileName: string;
-  fileType: string;
+  fileType?: string;
   size: number;
 }
 

diff --git a/src/sdk/createArchiveRecord.ts b/src/sdk/createArchiveRecord.ts
@@ -13,7 +13,7 @@ import type {
 
 export interface CreateArchiveRecordParams {
   s3Url: string;
-  file: Pick<File, 'contentType' | 'size'>;
+  file: Pick<Partial<File>, 'contentType'> & Pick<File, 'size'>;
   item: Pick<ArchiveRecord, 'displayName' | 'fileSystemCompatibleName'>;
   parentFolder: Pick<Folder, 'id'>;
 }