diff --git a/src/main/java/com/mindee/v2/search/models/ModelSearchParameters.java b/src/main/java/com/mindee/v2/search/models/ModelSearchParameters.java index 05c188bad..98ea9a5ac 100644 --- a/src/main/java/com/mindee/v2/search/models/ModelSearchParameters.java +++ b/src/main/java/com/mindee/v2/search/models/ModelSearchParameters.java @@ -7,18 +7,21 @@ import lombok.Getter; /** - * Search parameters for models. + * Search for models within the organization linked to the API key. + * All search filters are optional. + * If no search filters are given, all models belonging to the organization are returned. + * Results are paginated. */ @Getter @EqualsAndHashCode(callSuper = true) public class ModelSearchParameters extends BaseSearchParameters { /** - * Case-insensitive search term for the model name + * Filter models by partial name match, case-insensitive. */ private final String name; /** - * Case-insensitive search term for the model type + * Filter by an exact model type. */ private final String modelType; @@ -72,7 +75,7 @@ public static final class Builder extends BaseSearchParameters.BaseBuilder 1); assertEquals(1, response.getPagination().getPage()); } @Test - public void ModelSearch_mustReturnEmpty() throws Exception { + public void ModelSearch_mustReturnEmpty() { ModelSearchResponse response = client .search(ModelSearchParameters.builder().name("je n'existe pas tralala").build()); @@ -53,7 +58,7 @@ public void ModelSearch_mustReturnEmpty() throws Exception { @Test @SuppressWarnings("deprecation") - public void ModelSearch_mustReturnEmptyObsolete() throws Exception { + public void ModelSearch_mustReturnEmptyObsolete() { SearchResponse response = client.searchModels("je n'existe pas tralala"); assertNotNull(response);