Skip to content

Commit

Permalink
docs: clarify endpoints don't include all lists
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdecaf committed Sep 21, 2022
1 parent 2176c5e commit 33497ec
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion api/client.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@ paths:
/search:
get:
tags: [Watchman]
summary: Search SDNs
summary: Search
operationId: search
parameters:
- name: X-Request-ID
Expand Down
16 changes: 9 additions & 7 deletions docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,29 @@ menubar: docs-menu

# Search

Moov Watchman offers numerous search options for inspecting the SDN and related data.
Moov Watchman offers numerous search options for inspecting the OFAC, SDN, CSL, and other related data. Certain endpoints don't inspect all supported lists.

## Supported combinations

- All fields
- All fields, all lists
- `?q=<string>`
- Name search
- Name search, Searches OFAC, SSI, DPs, and BIS Entities
- `?name=<string>`
- An Address can be included
- An Address can be included, Only Searches the OFAC list
- `address=<string>&city=<string>&state=<string>&providence=<string>&zip=<string>&country=<string>`
- ID search
- ID search, Only searches the OFAC list
- `?id=<string>`
- Alt Name search
- Alt Name search, Only searches the OFAC list
- `?altName=<string>`
- Address search
- Address search, Only searches the OFAC list
- `&address=<string>&city=<string>&state=<string>&providence=<string>&zip=<string>&country=<string>`

## All in one

The most common endpoint for searching across all data Watchman has indexed. To perform this search make an HTTP query like the following:

See the [API documentation](https://moov-io.github.io/watchman/api/#get-/search) for full request/response data.

```
curl 'http://localhost:8084/search?q=nicolas+maduro&limit=1'
```
Expand Down

0 comments on commit 33497ec

Please sign in to comment.