Skip to content

Commit bd9b28c

Browse files
committed
docs: add extra param indications
1 parent 1913993 commit bd9b28c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/useCases.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,8 @@ The optional `datasetVersionId` parameter can correspond to a numeric version id
287287

288288
There is an optional third parameter called `includeDeaccessioned`, which indicates whether to consider deaccessioned versions or not in the dataset search. If not set, the default value is `false`.
289289

290+
There is an optional fourth parameter called `keepRawFields`, which indicates whether or not to keep the metadata fields as they are and avoid the transformation to markdown. The default value is `false`.
291+
290292
#### Get Dataset By Private URL Token
291293

292294
Returns a [Dataset](../src/datasets/domain/models/Dataset.ts) instance, given an associated Private URL Token.
@@ -307,6 +309,8 @@ getPrivateUrlDataset.execute(token).then((dataset: Dataset) => {
307309

308310
_See [use case](../src/datasets/domain/useCases/GetPrivateUrlDataset.ts)_ definition.
309311

312+
There is an optional second parameter called `keepRawFields`, which indicates whether or not to keep the metadata fields as they are and avoid the transformation to markdown. The default value is `false`.
313+
310314
#### Get Dataset Citation Text
311315

312316
Returns the Dataset citation text.

0 commit comments

Comments
 (0)