Skip to content

Commit 8115382

Browse files
committed
docs: add docs for setting default contributor role
1 parent dca9254 commit 8115382

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/useCases.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The different use cases currently available in the package are classified below,
2525
- [Update Collection Featured Items](#update-collection-featured-items)
2626
- [Delete Collection Featured Items](#delete-collection-featured-items)
2727
- [Delete a Collection Featured Item](#delete-a-collection-featured-item)
28+
- [Set Default Contributor Role](#set-default-contributor-role)
2829
- [Templates](#Templates)
2930
- [Templates read use cases](#templates-read-use-cases)
3031
- [Get a Template](#get-a-template)
@@ -576,6 +577,27 @@ deleteCollectionFeaturedItem.execute(featuredItemId)
576577

577578
_See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItem.ts)_ definition.
578579

580+
#### Set Default Contributor Role
581+
582+
Sets the default contributor role of a collection, given a collection identifier and a role alias.
583+
584+
##### Example call:
585+
586+
```typescript
587+
import { setDefaultContributorRole } from '@iqss/dataverse-client-javascript'
588+
589+
/* ... */
590+
591+
const collectionIdOrAlias = 12345
592+
const roleAlias = 'curator'
593+
594+
setDefaultContributorRole.execute(collectionIdOrAlias, roleAlias)
595+
596+
/* ... */
597+
```
598+
599+
_See [use case](../src/collections/domain/useCases/SetDefaultContributorRole.ts)_ definition.
600+
579601
## Templates
580602

581603
### Templates Read Use Cases

0 commit comments

Comments
 (0)