Add name and description to v1/models list

[mostlygeek]

Before:

After (for clients with support)

Summary by CodeRabbit

• New Features

  • Added optional "name" and "description" fields to model configurations, allowing models to display additional metadata in API responses when set.

• Bug Fixes

  • Improved handling to ensure that empty or whitespace-only "name" and "description" fields are omitted from model listings.

• Tests

  • Enhanced tests to verify correct inclusion and omission of the new metadata fields in model responses.

[coderabbitai]

Walkthrough

Optional name and description metadata fields were added to model configurations, with updates to the config file example, struct definitions, and YAML unmarshaling logic. The model listing handler was refactored to include these fields only when non-empty, and corresponding tests were updated to validate correct parsing and API responses.

Changes

Files	Change Summary
config.example.yaml	Added name and description fields to the "llama" model config; updated model file path.
proxy/config.go	Added Name and Description fields to ModelConfig struct; updated YAML unmarshaling to support these fields.
proxy/config_posix_test.go	Updated test YAML and expected structs to include name and description fields for models and groups.
proxy/proxymanager.go	Refactored listModelsHandler to include name and description in API response only if non-empty; streamlined logic.
proxy/proxymanager_test.go	Enhanced tests to check presence/absence of name and description in API response based on field content.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ProxyManager
    participant Config

    Client->>ProxyManager: GET /v1/models
    ProxyManager->>Config: Retrieve model configurations
    loop For each model
        Config-->>ProxyManager: ModelConfig (with Name, Description)
        ProxyManager->>ProxyManager: If Name/Description non-empty, add to response
    end
    ProxyManager-->>Client: JSON array of models (with optional name, description fields)

Loading

Suggested labels

enhancement, configuration

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3bd1b23 and b91be32.

📒 Files selected for processing (5)

• config.example.yaml (1 hunks)
• proxy/config.go (2 hunks)
• proxy/config_posix_test.go (2 hunks)
• proxy/proxymanager.go (1 hunks)
• proxy/proxymanager_test.go (4 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

proxy/proxymanager_test.go (1)

proxy/config.go (2)

• Config (141-157)
• ModelConfig (20-40)

🔇 Additional comments (10)

proxy/config.go (2)

31-33: LGTM! Clean addition of optional metadata fields.

The new Name and Description fields are properly structured with appropriate YAML tags and helpful comments referencing the related issue.

---

55-56: LGTM! Proper default initialization.

The new fields are correctly initialized with empty string defaults in the UnmarshalYAML method, maintaining consistency with other optional string fields.

config.example.yaml (2)

52-52: LGTM! Model path update for consistency.

The model file path change aligns with the example model name being "llama".

---

54-64: LGTM! Excellent documentation for new fields.

The documentation clearly explains:

• Fields are optional with empty string defaults
• Conditional inclusion in v1/models API response
• Meaningful example values provided

This will help users understand how to configure these new metadata fields.

proxy/config_posix_test.go (1)

107-108: LGTM! Proper test coverage for new fields.

The test correctly validates that the new name and description fields are properly loaded from YAML configuration and stored in the ModelConfig struct.

Also applies to: 173-174

proxy/proxymanager_test.go (2)

187-194: LGTM! Excellent test setup for edge cases.

The test properly sets up different scenarios:

• model1 with meaningful name and description values
• model2 with whitespace-only values to test trimming logic

This ensures the conditional inclusion behavior is properly validated.

---

260-273: LGTM! Comprehensive validation of conditional field inclusion.

The test assertions correctly validate:

• Fields are included when they have meaningful values (model1)
• Fields are excluded when empty or whitespace-only (model2 and model3)
• Proper type checking for string values

This ensures the API response behaves correctly according to the specification.

proxy/proxymanager.go (3)

291-292: LGTM! Good performance optimizations.

Preallocating the slice with the correct capacity and computing the timestamp once improves efficiency and reduces allocations.

---

306-311: LGTM! Correct conditional inclusion logic.

The implementation properly:

• Trims whitespace from name and description fields
• Only includes fields in the response when they contain meaningful content
• Handles empty and whitespace-only values correctly

This matches the expected behavior described in the configuration documentation.

---

317-325: LGTM! Cleaner response handling.

The refactored code:

• Simplifies CORS header handling with c.GetHeader("Origin")
• Uses gin's c.JSON method for cleaner response encoding
• Maintains the same functionality with less code

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.