feat:Mark deprecated paths/responses and update image_url docs in OpenAPI

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated multi-language examples (TypeScript, Python, Go, Java, curl) to clarify image_url support for both base64 data URIs and web URLs.
  • Aligned example comments and guidance with newly deprecated endpoints.
• Chores
  • Marked several API endpoints and related responses as deprecated, including certain 504 response mappings, to indicate upcoming sunset and guide migration.

[coderabbitai]

Walkthrough

The OpenAPI spec at src/libs/Cohere/openapi.yaml was updated to mark multiple paths and responses as deprecated and to refresh multi-language code samples with notes on image_url handling (accepting base64 data URIs or web URLs). No exported/public API signatures were changed.

Changes

Cohort / File(s)	Summary
OpenAPI spec updates src/libs/Cohere/openapi.yaml	Added deprecated: true to several paths, response components (incl. 504 mappings), and endpoint wrappers; updated TypeScript, Python, Go, Java, and curl code samples to clarify image_url can be base64 data URIs or web URLs and aligned samples with deprecation flags.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #93 — Also modifies src/libs/Cohere/openapi.yaml, indicating related OpenAPI spec edits.
• feat:Update openapi.yaml file in src/libs/Cohere directory #120 — Updates the same OpenAPI file; likely adjacent deprecation or example adjustments.
• feat:Update openapi.yaml file in src/libs/Cohere directory #113 — Touches src/libs/Cohere/openapi.yaml, suggesting closely related spec changes.

Suggested reviewers

• github-actions

Poem

I thump my paws on parchment plain,
Deprecated paths now marked and sane.
image_url hops two ways to go—
base64 or webward flow.
In YAML fields I softly tread,
A tidy warren, green-tagged red.
🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The PR title "feat:@coderabbitai" does not describe the actual changes; this PR marks multiple OpenAPI paths/responses as deprecated and updates code samples, but the title appears to be a tag/mention rather than a concise summary of the primary change, so it fails the guideline for a clear, specific title.	Please rename the PR to a short, specific sentence describing the main change, for example "chore(openapi): mark multiple endpoints deprecated and update code samples".

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

---

📜 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 fb8655d.

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

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

66-66: Valid OpenAPI deprecation usage.

The deprecated: true field is properly used according to OpenAPI 3.0 specification to mark parameters as deprecated.

---

171-171: Valid OpenAPI deprecation usage.

The deprecated: true field is properly used according to OpenAPI 3.0 specification to mark parameters as deprecated.

---

1007-1007: Valid OpenAPI endpoint deprecation usage.

The deprecated: true field is correctly placed within endpoint blocks to mark operations as deprecated according to OpenAPI specification.

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

---

8775-8787: Code examples updated with helpful inline documentation.

The code samples across multiple languages (TypeScript, Python, Java, Go) now include clear inline comments explaining that image URLs "can be either a base64 data URI or a web URL." This improves developer experience by clarifying the expected input formats.

---

66-66: Verify impact of deprecated parameter usage across the codebase.

The connectors and search_queries_only parameters are now marked as deprecated. Ensure that any client code, documentation, or examples that rely on these parameters are updated to reflect their deprecated status or migrated to alternative approaches.

Also applies to: 171-171

---

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