feat:Extend ImageUrl schema with optional detail property and update url description #190
Conversation
WalkthroughThe OpenAPI specification for the Cohere API was updated by extending the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant CohereAPI
Client->>CohereAPI: Submit ImageUrl with url and optional detail property
CohereAPI-->>Client: Process image using specified detail ("auto", "low", "high") and respond
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/libs/Cohere/openapi.yaml (1)
15906-15907: Use a YAML block scalar for theurldescriptionThe inline quoted description with a trailing
\nis harder to read and maintain. Convert it to a block scalar for clarity and consistency.@@ properties: - url: - type: string - description: "URL of an image. Can be either a base64 data URI or a web URL.\n" + url: + type: string + description: | + URL of an image. Can be either a base64 data URI or a web URL.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
src/libs/Cohere/Generated/Cohere.Models.ImageContent.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.ImageUrl.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.ImageUrlDetail.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/JsonConverters.ImageUrlDetail.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/JsonConverters.ImageUrlDetailNullable.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Cohere/openapi.yaml(1 hunks)
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)
15898-15904: Specify schema default fordetailto match documentation and simplify descriptionThe description claims that
"auto"is the default, but there's nodefaultfield in the schema. Without it, client code generators and validators won’t assume"auto". Add adefault: autoentry. Optionally, switch to a YAML block scalar to avoid inline escaping.[raise_critical_issue, suggest_optional_refactor]
@@ properties: - detail: - enum: - - auto - - low - - high - type: string - description: "Controls the level of detail in image processing. \"auto\" is the default and lets the system choose, \"low\" is faster but less detailed, and \"high\" preserves maximum detail. You can save tokens and speed up responses by using detail: \"low\".\n" + detail: + type: string + enum: + - auto + - low + - high + default: auto + description: | + Controls the level of detail in image processing. "auto" is the default and lets the system choose, + "low" is faster but less detailed, and "high" preserves maximum detail. You can save tokens + and speed up responses by using detail: "low".
Summary by CodeRabbit
New Features
Documentation