Skip to content

📝 better docs for model search - #484

Merged
ianardee merged 1 commit into
mainfrom
better-docs
Sep 7, 2026
Merged

📝 better docs for model search#484
ianardee merged 1 commit into
mainfrom
better-docs

Conversation

@ianardee

@ianardee ianardee commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

Description

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Requires a change to the official Guide documentation.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Changes are limited to documentation improvements and non-invasive test strengthening with no functional logic modifications.

Pull request overview

This PR improves the clarity of the V2 “Model Search” API documentation and slightly strengthens the integration test to validate that returned models include expected core fields.

Changes:

  • Clarifies ModelSearch class documentation (scope, optional filters, and pagination).
  • Refines inline parameter docs for ModelSearchParameters (name and modelType).
  • Adds assertions in the model search integration test to verify id, name, and modelType are present on returned models.
File summaries
File Description
tests/v2/search/modelSearch.integration.ts Adds per-model field presence assertions to make integration coverage more robust.
src/v2/search/models/modelSearchParameters.ts Updates parameter JSDoc to better describe filtering behavior.
src/v2/search/models/modelSearch.ts Expands class-level JSDoc to clarify scope, optional filters, and pagination.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@ianardee
ianardee merged commit 96ad1e4 into main Sep 7, 2026
38 of 41 checks passed
@ianardee
ianardee deleted the better-docs branch September 7, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants