feat:Mark endpoints/responses deprecated and clarify image_url examples #301
Conversation
WalkthroughThe OpenAPI specification in src/libs/Cohere/openapi.yaml was updated to mark multiple endpoints and responses as deprecated and to revise example snippets across languages by adding a comment clarifying that image_url supports base64 data URIs or web URLs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
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. Comment |
![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 (11)
src/libs/Cohere/openapi.yaml (11)
63-69: Deprecation flag added for connectors array — add rationale and replacement.
Please augment the schema with a clear deprecation note and pointer to the recommended alternative so SDKs/docs surface helpful guidance.
- Add: x-deprecation-reason, and mention the replacement in description.
168-174: Property deprecated without migration path.
As above, include deprecation rationale and the suggested replacement or equivalent behavior in the description and via x-deprecation-reason.
1004-1010: Operation marked deprecated — include “replaced by” and sunset details.
Add:
- description: “Deprecated: use .”
- x-replaced-by: <path + method>
- Optional: x-sunset: and response header doc for Sunset.
1128-1134: Same deprecation metadata missing here.
Replicate the “replaced by” and “sunset” additions for consistency across docs/SDKs.
1198-1204: Add deprecation rationale and replacement.
Mirror the metadata (description note, x-replaced-by, x-sunset) here as well.
1271-1277: Incomplete deprecation signaling.
Please add x-deprecation-reason and replacement endpoint pointer.
1343-1349: Ensure SDKs/docs show where to migrate.
Add description deprecation note, x-replaced-by, and optional x-sunset.
1421-1427: Repeat missing deprecation metadata.
Include rationale and migration target.
1501-1507: Deprecation without migration path.
Add replacement endpoint information and optional sunset timeline.
6623-6629: Operation deprecated — document where callers should move.
Add description note, x-replaced-by, and (optionally) x-sunset.
7178-7184: Same as above: add migration guidance.
Please include x-deprecation-reason and replacement endpoint pointer.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (21)
src/libs/Cohere/Generated/Cohere.CohereClient.Chat.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Classify.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Generate.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Summarize.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.CreateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.DeleteConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.GetConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.ListConnectors.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.OAuthAuthorizeConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.UpdateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Chat.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Classify.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Generate.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Summarize.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.CreateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.DeleteConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.GetConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.ListConnectors.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.OAuthAuthorizeConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.UpdateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.ChatRequest.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Cohere/openapi.yaml(12 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test / Build, test and publish
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)
8772-8787: Use a vision model in the Go example when sending image_urlFile: src/libs/Cohere/openapi.yaml (lines 8772-8787)
Go example uses a non‑vision model while sending image_url — align with other samples by switching to a vision model.- Model: "command-a-03-2025", + Model: "command-a-vision-07-2025",
- Add a second curl example demonstrating a base64 data URI (curl can’t carry comments).
Summary by CodeRabbit