Skip to content

feat:Add is_deprecated boolean property to model schema in OpenAPI spec#223

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202507041830
Jul 4, 2025
Merged

feat:Add is_deprecated boolean property to model schema in OpenAPI spec#223
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202507041830

Conversation

@HavenDV
Copy link
Copy Markdown
Contributor

@HavenDV HavenDV commented Jul 4, 2025

Summary by CodeRabbit

  • New Features
    • Added a new field to the model details response that indicates whether a model is deprecated.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 4, 2025

Walkthrough

A new boolean property, is_deprecated, has been added to the model schema in the OpenAPI specification for the /v1/models/{model} GET endpoint response. This property indicates whether the model is deprecated. No other changes to the schema or API behavior have been made.

Changes

File Change Summary
src/libs/Cohere/openapi.yaml Added is_deprecated boolean property to /v1/models/{model} response schema.

Poem

A toggle appears, so clear and bright,
Marking models old, now out of sight.
"Deprecated?" the schema asks with care,
So clients know which models to spare.
YAML lines updated, neat and tight—
The API grows wiser overnight!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3698e69 and 581db3b.

⛔ Files ignored due to path filters (1)
  • src/libs/Cohere/Generated/Cohere.Models.GetModelResponse.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/Cohere/openapi.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test / Build, test and publish
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)

15959-15963: No changes needed for is_deprecated or defaults
The is_deprecated field is intentionally named to avoid colliding with OpenAPI’s schema‐level deprecated keyword. We follow the existing pattern of omitting default/nullable on boolean response properties (e.g. is_fine_tuned) and code generators don’t generally consume response defaults. The shared Model schema (used by both ListModelsResponse and GetModelResponse) already includes is_deprecated, ensuring consistency across endpoints.

Likely an incorrect or invalid review comment.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in a Comment
  • Commit Unit Tests in branch bot/update-openapi_202507041830

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
🪧 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 auto-generate unit tests to generate unit tests for 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@HavenDV HavenDV enabled auto-merge (squash) July 4, 2025 18:31
@coderabbitai coderabbitai Bot changed the title feat:@coderabbitai feat:Add is_deprecated boolean property to model schema in OpenAPI spec Jul 4, 2025
@HavenDV HavenDV merged commit fd36837 into main Jul 4, 2025
3 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202507041830 branch July 4, 2025 18:33
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.

1 participant