📝 better docs for model search

Author: ianardee

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<ModelSearchResponse> {
   /**
-   * 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;
 

src/test/java/com/mindee/v2/search/ModelSearchIT.java

@@ -33,6 +33,11 @@ public void ModelSearch_mustHaveResults() throws Exception {
     assertNotNull(response);
     assertNotNull(response.getModels());
     assertFalse(response.getModels().isEmpty());
+    for (var model : response.getModels()) {
+      assertFalse(model.getId().isEmpty());
+      assertFalse(model.getName().isEmpty());
+      assertFalse(model.getModelType().isEmpty());
+    }
     assertNotNull(response.getPagination());
     assertTrue(response.getPagination().getTotalItems() > 1);
     assertEquals(1, response.getPagination().getPage());