feat:Mark deprecated operations and update image_url docs in Cohere OpenAPI

[HavenDV]

Summary by CodeRabbit

• Documentation

  • Updated code samples (JavaScript/TypeScript, Python, Java, Go) to note that image_url supports base64 data URIs and web URLs, with minor formatting improvements.

• Chores

  • Marked multiple API endpoints and operations as deprecated in the public OpenAPI specification to provide clearer deprecation signaling across the API surface.

[coderabbitai]

Walkthrough

Added deprecated: true markers across numerous OpenAPI path items and operations in src/libs/Cohere/openapi.yaml, and updated embedded multi-language code samples to note that image_url may be a base64 data URI or a web URL. No non-deprecation API shape changes.

Changes

Cohort / File(s)	Summary
OpenAPI deprecation flags src/libs/Cohere/openapi.yaml	Marked multiple paths and operations with deprecated: true, including several top-level path entries and specific operation wrappers.
Embedded docs/code samples src/libs/Cohere/openapi.yaml	Updated examples (JS/TS, Python, Java, Go) to add inline comment about image_url accepting base64 data URIs or web URLs; minor formatting adjustments.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #120 — Also updates OpenAPI declarations in src/libs/Cohere/openapi.yaml.
• feat:Update openapi.yaml structure in src/libs/Cohere directory #115 — Modifies the same OpenAPI file; related deprecation/metadata edits.
• feat:Update openapi.yaml file in src/libs/Cohere directory #113 — Touches src/libs/Cohere/openapi.yaml; likely adjacent OpenAPI changes.

Suggested reviewers

• github-actions

Poem

I thump my paw: “Deprecated, see?”
Paths grow quiet like autumn’s tree.
Notes for images, base64 or URL—
carrots aligned, all ends that swell.
YAML burrows neat and tight,
I hop along—metadata right. 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title "feat:@coderabbitai" is vague and does not describe the PR's actual changes (the OpenAPI YAML updates that add deprecated: true to many paths plus minor documentation/example edits); it reads like an automated tag or mention rather than a concise summary of the primary change.	Please replace the title with a short, descriptive summary such as "chore(openapi): mark multiple endpoints deprecated and update examples" so reviewers can immediately understand the PR's purpose.

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

---

📜 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 111c2a6 and f998efb.

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

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

66-66: Deprecation marker properly applied.

The deprecated: true field is correctly positioned and formatted according to OpenAPI 3.0 specification standards. This properly marks the connectors parameter as deprecated.

---

171-171: Deprecation marker properly applied.

The deprecated: true field is correctly positioned and formatted according to OpenAPI 3.0 specification standards. This properly marks the search_queries_only parameter as deprecated.

---

1007-1007: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

1131-1131: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

1201-1201: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

1274-1274: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

1346-1346: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

1424-1424: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

1504-1504: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

6626-6626: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

7181-7181: Deprecation marker properly applied.

The deprecated: true field is correctly positioned at the operation level to mark the entire API endpoint as deprecated. The indentation and placement are consistent with OpenAPI specification requirements.

---

8775-8786: Code sample updates look good.

The multi-language code samples have been appropriately updated to include clarifying comments about image_url accepting both base64 data URIs and web URLs. The comment is consistently added across all language samples:

• JavaScript/TypeScript: // Can be either a base64 data URI or a web URL.
• Python: # Can be either a base64 data URI or a web URL.
• Java: // Can be either a base64 data URI or a web URL.
• Go: // Can be either a base64 data URI or a web URL.

The examples remain functionally correct and the added documentation improves developer understanding of the parameter's flexibility.

---

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.}