feat:Deprecate endpoints/responses and clarify image_url in Cohere OpenAPI

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Marked several API endpoints and related responses as deprecated in the reference to guide migration.
  • Clarified image_url accepted formats (base64 data URI or web URL) across code samples (JS/TS, Python, Java, Go, etc.), with added contextual notes.
  • Updated examples to reflect deprecations, including gateway timeout references.
  • No functional API changes; public signatures remain unchanged.

[coderabbitai]

Walkthrough

The OpenAPI spec at src/libs/Cohere/openapi.yaml was updated to mark multiple endpoints and response blocks as deprecated and to add inline clarifications in code examples regarding image_url formats. No API signatures were changed.

Changes

Cohort / File(s)	Summary of Changes
Deprecation annotations src/libs/Cohere/openapi.yaml	Added deprecated: true to various paths and response entries, flagging multiple endpoints/responses as deprecated.
Example/comment updates src/libs/Cohere/openapi.yaml	Updated multi-language code samples with comments clarifying that image_url accepts base64 data URIs or web URLs; minor contextual comments added.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #104 — Also updates src/libs/Cohere/openapi.yaml; likely adjacent changes to the same spec.
• feat:Update openapi.yaml file in src/libs/Cohere directory #120 — Modifies the same OpenAPI file; potentially overlapping or sequential spec edits.
• feat:Update openapi.yaml file in src/libs/Cohere directory #118 — Related adjustments within src/libs/Cohere/openapi.yaml, indicating concurrent spec maintenance.

Poem

A nibble of notes in YAML rows,
I hop through paths where deprecation grows.
Samples whisper, “URLs or base64,”
Carrots of clarity—nothing more.
Ears perked high, I sign with glee:
“Specs are tidy—thump-thump—yippee!” 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title "feat:@coderabbitai" is too terse and reads like a bot/user handle rather than a summary of the changes; it does not describe the main work in the PR. The changeset shows OpenAPI endpoints/responses were marked deprecated and several code samples were updated, which the current title does not convey. Because the title is vague and non-descriptive, it is inconclusive whether it accurately represents the PR's purpose.	Rename the PR to a concise, descriptive title that reflects the primary change, for example: "docs(openapi): mark multiple endpoints/responses as deprecated and update code examples" or "chore(openapi): add deprecated markers to OpenAPI spec." Include a clear scope (openapi/docs) and an imperative summary and remove the "@coderabbitai" handle from the title. This will make the PR's intent immediately clear to reviewers and keep repository history meaningful.

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

---

📜 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 15886e4.

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

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

66-66: LGTM! Proper deprecated marking on deprecated connectors parameter

The deprecated: true marking follows OpenAPI 3.0 best practices for deprecating parameters. This communicates to API consumers that they should transition away from using this parameter.

---

171-171: LGTM! Proper deprecated marking on search_queries_only parameter

The deprecated: true marking follows OpenAPI 3.0 best practices for deprecating parameters. This properly signals to API consumers that this parameter is deprecated and should be transitioned out of usage.

---

1007-1007: LGTM! Proper deprecated marking on multiple endpoints

Both OpenAPI v2.0 and OpenAPI v3.x support deprecating operations by setting deprecated: true on the endpoint. This follows the standard pattern for marking entire endpoints as deprecated. Consumers of the API will be informed about the deprecation through generated documentation tools like Swagger UI and Redoc.

Also applies to: 1131-1131, 1201-1201, 1274-1274, 1346-1346, 1424-1424, 1504-1504, 6626-6626, 7181-7181

---

8775-8786: LGTM! Helpful inline comments added to code samples

The inline comments clarifying that image_url can be either a base64 data URI or a web URL provide valuable guidance to developers across multiple language examples (TypeScript, Python, Java, Go). This improves developer experience without changing API functionality.

---

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