Skip to content

Commit 4d61527

Browse files
committed
Added: use case docs for GetSearchServices
1 parent 4b5334c commit 4d61527

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/useCases.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ The different use cases currently available in the package are classified below,
8585
- [Get Application Terms of Use](#get-application-terms-of-use)
8686
- [Contact](#Contact)
8787
- [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
88+
- [Search](#Search)
89+
- [Get Search Services](#get-search-services)
8890

8991
## Collections
9092

@@ -1993,3 +1995,25 @@ In ContactDTO, it takes the following information:
19931995
- **subject**: the email subject line.
19941996
- **body**: the email body to send.
19951997
- **fromEmail**: the email to list in the reply-to field.
1998+
1999+
## Search
2000+
2001+
#### Get Search Services
2002+
2003+
Returns all [Search Services](../src/search/domain/models/SearchService.ts) available in the installation.
2004+
2005+
##### Example call:
2006+
2007+
```typescript
2008+
import { getSearchServices } from '@iqss/dataverse-client-javascript'
2009+
2010+
/* ... */
2011+
2012+
getSearchServices.execute().then((searchServices: SearchService[]) => {
2013+
/* ... */
2014+
})
2015+
2016+
/* ... */
2017+
```
2018+
2019+
_See [use case](../src/search/domain/useCases/GetSearchServices.ts) implementation_.

0 commit comments

Comments
 (0)