Skip to content

Commit b8a8478

Browse files
committed
fix: update documentation
1 parent 5c76eb4 commit b8a8478

File tree

2 files changed

+4
-11
lines changed

2 files changed

+4
-11
lines changed

docs/useCases.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,11 +1257,9 @@ The following error might arise from the `AddUploadedFileToDataset` use case:
12571257

12581258
- AddUploadedFileToDatasetError: This error indicates that there was an error while adding the uploaded file to the dataset.
12591259

1260-
#### Updating File Metadata Use Cases
1260+
#### Update File Metadata
12611261

1262-
This use case is designed to update or edit metadata information for a specific file by a numeric identifier or persistemt identifier.
1263-
1264-
##### Update File Metadata
1262+
Updates Metadata of a File.
12651263

12661264
###### Example call:
12671265

@@ -1284,13 +1282,7 @@ await updateFileMetadata.execute(fileId, updateFileMetadataDTO).then((fileId) =>
12841282

12851283
_See [use case](../src/files/domain/useCases/UpdateFileMetadata.ts) implementation_.
12861284

1287-
This use case supports the following optional parameters for updateFileMetadataDTO:
1288-
1289-
- **description**: (string)
1290-
- **prevFreeform**: (string)
1291-
- **categories**: (string[])
1292-
- **dataFileTags**: (string[])
1293-
- **restrict**: (boolean)
1285+
The `fileId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
12941286

12951287
#### Delete a File
12961288

src/files/domain/useCases/UpdateFileMetadata.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export class UpdateFileMetadata implements UseCase<void> {
1111

1212
/**
1313
* Updates the metadata for a particular File.
14+
* More detailed information about the file restriction behavior can be found in https://guides.dataverse.org/en/latest/api/native-api.html#updating-file-metadata
1415
*
1516
* @param {number | string} [fileId] - The file identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
1617
* @param {UpdateFileMetadataDTO} [updateFileMetadataDTO] - The DTO containing the metadata updates.

0 commit comments

Comments
 (0)