feat:Mark endpoints/responses deprecated and clarify image_url examples

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Marked several API endpoints and responses as deprecated in the OpenAPI specification, ensuring deprecation notices appear in generated docs and tooling.
  • Updated multi-language code samples to clarify that image_url supports either a base64 data URI or a public web URL, with inline comments for clarity.
  • Improves developer guidance and reduces ambiguity; no runtime behavior changes.

[coderabbitai]

Walkthrough

The 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

Cohort / File(s)	Summary
OpenAPI spec updates src/libs/Cohere/openapi.yaml	Added deprecated: true to multiple operations/responses; updated example code comments (TypeScript, Python, Java, Go, curl) to note image_url accepts base64 data URIs or web URLs.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• feat:Remove example from FinetunedModel request body in openapi.yaml #249 — Also updates src/libs/Cohere/openapi.yaml examples/metadata; closely related to deprecation flags and example adjustments.
• feat:Update openapi.yaml file in src/libs/Cohere directory #116 — Modifies the same OpenAPI file with spec updates, indicating related schema/documentation changes.
• feat:Update openapi.yaml file in src/libs/Cohere directory #113 — Changes to src/libs/Cohere/openapi.yaml similar in scope (OpenAPI/documentation structure), likely overlapping context.

Poem

In YAML fields I thump with cheer,
Deprecated paths made crystal-clear.
image_url now says its say—
base64 or webby way.
I hop through specs, ears up high,
Carrots, code, and clearer sky! 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title "feat:@coderabbitai" is not a meaningful summary of the changes in this PR: the diff shows OpenAPI YAML edits marking many endpoints as deprecated and documentation/example clarifications about image_url, whereas the title is just a handle/label and provides no information about the actual changes, making it misleading and unhelpful for reviewers or history scanning.	Please rename the PR to a concise, descriptive title that reflects the main changes, for example "openapi: mark multiple endpoints as deprecated and clarify image_url examples" or "docs(openapi): add deprecated flags to endpoints; update image_url samples" so reviewers immediately understand the purpose of the change.

✅ 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_202509211518

---

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 (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

📥 Commits

Reviewing files that changed from the base of the PR and between 111c2a6 and 01669e5.

⛔ 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 (1)

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

8772-8787: Use a vision model in the Go example when sending image_url

File: 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).