Skip to content
Merged
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
3 changes: 3 additions & 0 deletions docs/useCases.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ The different use cases currently available in the package are classified below,
- [Delete a File](#delete-a-file)
- [Replace a File](#replace-a-file)
- [Restrict or Unrestrict a File](#restrict-or-unrestrict-a-file)
- [Update File Metadata](#update-file-metadata)
- [Metadata Blocks](#metadata-blocks)
- [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
- [Get All Facetable Metadata Fields](#get-all-facetable-metadata-fields)
Expand Down Expand Up @@ -1331,6 +1332,8 @@ import { updateFileMetadata } from '@iqss/dataverse-client-javascript'

const fileId: number | string = 123
const updateFileMetadataDTO = {
label: 'myfile.txt',
directoryLabel: 'mydir',
description: 'My description bbb.',
categories: ['Data'],
restrict: false
Expand Down
2 changes: 2 additions & 0 deletions src/files/domain/dtos/UpdateFileMetadataDTO.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
export interface UpdateFileMetadataDTO {
label?: string
directoryLabel?: string
description?: string
prevFreeform?: string
categories?: string[]
Expand Down
4 changes: 4 additions & 0 deletions test/integration/files/FilesRepository.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,8 @@ describe('FilesRepository', () => {
const testFileMetadata = {
description: 'My description test.',
categories: ['Data'],
label: 'myfile.txt',
directoryLabel: 'mydir',
restrict: false
}

Expand All @@ -670,6 +672,8 @@ describe('FilesRepository', () => {

expect(fileInfo.description).toBe(testFileMetadata.description)
expect(fileInfo.categories).toEqual(testFileMetadata.categories)
expect(fileInfo.name).toBe(testFileMetadata.label)
expect(fileInfo.directoryLabel).toBe(testFileMetadata.directoryLabel)
expect(fileInfo.restricted).toBe(testFileMetadata.restrict)
})

Expand Down