feat:OpenAPI deprecations and clarify image_url base64 or URL in SDK

[HavenDV]

Summary by CodeRabbit

• Documentation

  • Updated SDK examples (TypeScript, JavaScript, Go, Python, Java) to clarify that image_url accepts either a base64 data URI or a web URL.
  • Clarified behavior in examples without changing curl functionality.

• Chores

  • Marked several API endpoints and related responses as deprecated in the public API specification, including gateway timeout and service unavailability responses, to reflect current support status.

[coderabbitai]

Walkthrough

The OpenAPI spec at src/libs/Cohere/openapi.yaml was updated to add deprecation markers to multiple endpoints and response components, particularly service-unavailable and gateway-timeout responses. Public SDK code samples were updated with comments clarifying that image_url may be a base64 data URI or a web URL.

Changes

Cohort / File(s)	Summary
OpenAPI deprecations src/libs/Cohere/openapi.yaml	Added deprecated: true to multiple path items/endpoints and to response entries, including 504 and ServiceUnavailable/GatewayTimeout in components/responses.
SDK sample comment tweaks src/libs/Cohere/openapi.yaml	Inserted inline comments in TypeScript, Go, Python, Java, and JavaScript examples noting that image_url accepts base64 data URIs or web URLs; curl context unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #119 — Also modifies src/libs/Cohere/openapi.yaml; likely adjacent changes to the same spec surface.
• feat:Update openapi.yaml structure in src/libs/Cohere directory #115 — Updates the same OpenAPI structure; potential overlap or sequencing with this deprecation pass.
• feat:Update openapi.yaml file in src/libs/Cohere directory #108 — Touches src/libs/Cohere/openapi.yaml; may interact with the example or response sections updated here.

Poem

A rabbit taps the YAML drum,
Marked “deprecated,” beats go thrum—
Endpoints bow and take their leave,
Samples whisper what to weave:
“Data URI or webby trail!”
Ears perk up, we ship the tale—
Hop-hop, changelog on the trail. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The pull request title "feat:@coderabbitai" is vague and does not describe the primary changes in this PR (OpenAPI endpoint deprecations and updated SDK example comments); it reads like an automation/author tag rather than a concise summary that helps reviewers understand the main change.	Please update the title to a short, specific sentence summarizing the main change (for example: "Mark OpenAPI endpoints as deprecated and clarify image_url usage in SDK examples").

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ 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_202509211238

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/libs/Cohere/openapi.yaml (1)

8772-8787: Examples improved; align model IDs across languages

The “base64 data URI or web URL” comments are helpful. Minor nit: TS/Python/Java use command-a-vision-07-2025, while Go uses command-a-03-2025. Consider standardizing to one model to avoid confusion.

-            Model: "command-a-03-2025",
+            Model: "command-a-vision-07-2025",

Please confirm that imageUrl (TS/Java/Go) vs image_url (Python/cURL) is the intended SDK-specific casing.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 111c2a6 and 2563ae7.

⛔ Files ignored due to path filters (21)

• src/libs/Cohere/Generated/Cohere.CohereClient.Chat.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.CohereClient.Classify.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.CohereClient.Generate.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.CohereClient.Summarize.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ConnectorsClient.CreateConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ConnectorsClient.DeleteConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ConnectorsClient.GetConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ConnectorsClient.ListConnectors.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ConnectorsClient.OAuthAuthorizeConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ConnectorsClient.UpdateConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Chat.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Classify.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Generate.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Summarize.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.IConnectorsClient.CreateConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.IConnectorsClient.DeleteConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.IConnectorsClient.GetConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.IConnectorsClient.ListConnectors.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.IConnectorsClient.OAuthAuthorizeConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.IConnectorsClient.UpdateConnector.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.ChatRequest.g.cs is 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 (11)

src/libs/Cohere/openapi.yaml (11)

168-174: Property-level deprecation LGTM; add guidance to consumers

The boolean schema placement is correct. Consider adding a brief “Deprecated: use X instead” note to the description to help SDK users, and ensure changelog/docs reflect the deprecation.

---

1004-1010: Operation-level deprecation LGTM

deprecated: true at the operation level is valid. Ensure replacement endpoint is documented in the operation description or external docs.

---

1128-1134: Consistent deprecation across operations

Looks good and consistent with hunk 3.

---

1198-1204: LGTM

No issues spotted.

---

1271-1277: LGTM

Operation correctly marked deprecated.

---

1343-1349: LGTM

Consistent with prior hunks.

---

1421-1427: LGTM

No structural issues.

---

1501-1507: LGTM

Deprecation placement is correct.

---

6623-6629: LGTM

Consistent application.

---

7178-7184: LGTM

All good here.

---

63-69: Incorrect — deprecated already on the array property; no change required
In src/libs/Cohere/openapi.yaml the connectors entry has items: $ref (lines 63–64) while description and deprecated: true are applied to the array/property (lines 65–66). No change needed.

Likely an incorrect or invalid review comment.