Skip to content

Commit 7c3afd2

Browse files
committed
docs: add docs for (un)assigning roles on datasets and collections
1 parent 196b7fa commit 7c3afd2

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

docs/useCases.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ 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+
- [Assign a Role on a Collection](#assign-a-role-on-a-collection)
29+
- [Unassign a Role on a Collection](#unassign-a-role-on-a-collection)
2830
- [Templates](#Templates)
2931
- [Templates read use cases](#templates-read-use-cases)
3032
- [Get a Template](#get-a-template)
@@ -63,6 +65,8 @@ The different use cases currently available in the package are classified below,
6365
- [Link Dataset Type with Metadata Blocks](#link-dataset-type-with-metadata-blocks)
6466
- [Set Available Licenses For Dataset Type](#set-available-licenses-for-dataset-type)
6567
- [Delete a Dataset Type](#delete-a-dataset-type)
68+
- [Assign a Role on a Dataset](#assign-a-role-on-a-dataset)
69+
- [Unassign a Role on a Dataset](#unassign-a-role-on-a-dataset)
6670
- [Files](#Files)
6771
- [Files read use cases](#files-read-use-cases)
6872
- [Get a File](#get-a-file)
@@ -576,6 +580,49 @@ deleteCollectionFeaturedItem.execute(featuredItemId)
576580

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

583+
#### Assign a Role on a Collection
584+
585+
Assigns a role on a collection, given a collection identifier, a role assignee and a role alias.
586+
587+
##### Example call:
588+
589+
```typescript
590+
import { assignRoleOnCollection } from '@iqss/dataverse-client-javascript'
591+
592+
/* ... */
593+
594+
const collectionIdOrAlias = 12345
595+
const roleAssignee = "@myUser"
596+
const roleAlias = "curator"
597+
598+
assignRoleOnCollection.execute(collectionIdOrAlias, roleAssignee, roleAlias)
599+
600+
/* ... */
601+
```
602+
603+
_See [use case](../src/collections/domain/useCases/AssignRoleOnCollection.ts)_ definition.
604+
605+
#### Unassign a Role on a Collection
606+
607+
Unassigns a role on a collection, given a collection identifier and a role assignment identifier.
608+
609+
##### Example call:
610+
611+
```typescript
612+
import { unassignRoleOnCollection } from '@iqss/dataverse-client-javascript'
613+
614+
/* ... */
615+
616+
const collectionIdOrAlias = 12345
617+
const roleAssignmentId = 67890
618+
619+
unassignRoleOnCollection.execute(collectionIdOrAlias, roleAssignmentId)
620+
621+
/* ... */
622+
```
623+
624+
_See [use case](../src/collections/domain/useCases/UnassignRoleOnCollection.ts)_ definition.
625+
579626
## Templates
580627

581628
### Templates Read Use Cases
@@ -1516,6 +1563,49 @@ deleteDatasetType.execute(datasetTypeId).then(() => {
15161563

15171564
_See [use case](../src/datasets/domain/useCases/DeleteDatasetType.ts) implementation_.
15181565

1566+
#### Assign a Role on a Dataset
1567+
1568+
Assigns a role on a dataset, given a dataset identifier, a role assignee and a role alias.
1569+
1570+
##### Example call:
1571+
1572+
```typescript
1573+
import { assignRoleOnDataset } from '@iqss/dataverse-client-javascript'
1574+
1575+
/* ... */
1576+
1577+
const datasetId = 1
1578+
const roleAssignee = "@myUser"
1579+
const roleAlias = "curator"
1580+
1581+
assignRoleOnDataset.execute(datasetId, roleAssignee, roleAlias)
1582+
1583+
/* ... */
1584+
```
1585+
1586+
_See [use case](../src/datasets/domain/useCases/AssignRoleOnDataset.ts)_ definition.
1587+
1588+
#### Unassign a Role on a Dataset
1589+
1590+
Unassigns a role on a dataset, given a dataset identifier and a role assignment identifier.
1591+
1592+
##### Example call:
1593+
1594+
```typescript
1595+
import { unassignRoleOnDataset } from '@iqss/dataverse-client-javascript'
1596+
1597+
/* ... */
1598+
1599+
const datasetId = 1
1600+
const roleAssignmentId = 67890
1601+
1602+
unassignRoleOnDataset.execute(datasetId, roleAssignmentId)
1603+
1604+
/* ... */
1605+
```
1606+
1607+
_See [use case](../src/datasets/domain/useCases/UnassignRoleOnDataset.ts)_ definition.
1608+
15191609
## Files
15201610

15211611
### Files read use cases

0 commit comments

Comments
 (0)