diff --git a/api/client.yaml b/api/client.yaml index 8d7adaf2..1f29fb0c 100644 --- a/api/client.yaml +++ b/api/client.yaml @@ -595,7 +595,7 @@ paths: /search: get: tags: [Watchman] - summary: Search SDNs + summary: Search operationId: search parameters: - name: X-Request-ID diff --git a/docs/search.md b/docs/search.md index 671ee74d..679b3a68 100644 --- a/docs/search.md +++ b/docs/search.md @@ -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=` -- Name search +- Name search, Searches OFAC, SSI, DPs, and BIS Entities - `?name=` - - An Address can be included + - An Address can be included, Only Searches the OFAC list - `address=&city=&state=&providence=&zip=&country=` -- ID search +- ID search, Only searches the OFAC list - `?id=` -- Alt Name search +- Alt Name search, Only searches the OFAC list - `?altName=` -- Address search +- Address search, Only searches the OFAC list - `&address=&city=&state=&providence=&zip=&country=` ## 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' ```