📝 better docs for model search

src/v2/search/models/modelSearch.ts

@@ -3,7 +3,12 @@ import { BaseSearch } from "@/v2/search/baseSearch.js";
 import { ModelSearchResponse } from "@/v2/search/models/modelSearchResponse.js";
 
 /**
- * Search 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.
  */
 export class ModelSearch extends BaseSearch {
   /** @inheritDoc */

src/v2/search/models/modelSearchParameters.ts

@@ -13,12 +13,12 @@ export interface ModelSearchParametersConstructor extends BaseSearchParametersCo
  */
 export class ModelSearchParameters extends BaseSearchParameters {
   /**
-   * Case-insensitive search term for the model name
+   * Filter models by partial name match, case-insensitive.
    */
   name?: string;
 
   /**
-   * Case-insensitive search term for the model type
+   * Filter by an exact model type.
    */
   modelType?: string;
 

tests/v2/search/modelSearch.integration.ts

@@ -18,6 +18,11 @@ describe("MindeeV2 - Integration - Model Search", { timeout: 120000 }, () => {
     const response: ModelSearchResponse = await client.search(ModelSearch, {});
     assert.ok(response);
     assert.ok(response.models.length > 0);
+    for (const model of response.models) {
+      assert.ok(model.id);
+      assert.ok(model.name);
+      assert.ok(model.modelType);
+    }
     assert.ok(response.pagination);
     assert.ok(response.pagination.totalItems >= 1);
     assert.equal(response.pagination.page, 1);