Skip to content

Commit 4b5334c

Browse files
committed
Added: missing docs for GetCollectionItems use case
1 parent e03fa21 commit 4b5334c

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/useCases.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,8 @@ This use case supports the following optional parameters depending on the search
222222
- **limit**: (number) Limit for pagination.
223223
- **offset**: (number) Offset for pagination.
224224
- **collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
225+
- **searchServiceName**: The search service name on which to execute the search (Optional).
226+
- **showTypeCounts**: If true, the response will include the count per object type (Optional).
225227

226228
#### List My Data Collection Items
227229

src/collections/domain/useCases/GetCollectionItems.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ export class GetCollectionItems implements UseCase<CollectionItemSubset> {
1010
this.collectionsRepository = collectionsRepository
1111
}
1212

13-
/** TODO: document searchServiceName
13+
/**
1414
* Returns an instance of CollectionItemSubset that contains reduced information for each item that the calling user can access in the installation.
1515
* If the collectionId parameter is not set, the use case will return items starting from the root collection.
1616
*
1717
* @param {string} [collectionId] - Collection id (optional).
1818
* @param {number} [limit] - Limit for pagination (optional).
1919
* @param {number} [offset] - Offset for pagination (optional).
2020
* @param {CollectionSearchCriteria} [collectionSearchCriteria] - Supports filtering the collection items by different properties (optional).
21+
* @param {string} [searchServiceName] - The search service name on which to execute the search (optional).
2122
* @param {boolean} [showTypeCounts] - If true, the response will include the count per object type (optional).
2223
* @returns {Promise<CollectionItemSubset>}
2324
*/

0 commit comments

Comments
 (0)