feat:Mark endpoints deprecated in OpenAPI and update image_url examples

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Marked several API endpoints as deprecated in the public API specification; deprecation notices now appear in docs and client tooling.
  • Updated code samples to clarify that image_url accepts either a base64 data URI or a web URL.
  • Aligned example responses and added deprecation annotations to relevant response sections (e.g., 504 ServiceUnavailable) to reflect current API status.

[coderabbitai]

Walkthrough

Marked several endpoints as deprecated in the OpenAPI spec and updated example snippets to clarify that image_url accepts base64 data URIs or web URLs. Added deprecation annotations to some response sections. No changes to runtime behavior or exported entities.

Changes

Cohort / File(s)	Summary of Changes
OpenAPI deprecations src/libs/Cohere/openapi.yaml	Added deprecated: true to multiple endpoint path definitions; added deprecation annotations in select response sections (e.g., 504 ServiceUnavailable).
Sample example clarifications src/libs/Cohere/openapi.yaml	Updated multi-language code examples with a comment noting image_url can be a base64 data URI or a web URL.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #113 — Also modifies src/libs/Cohere/openapi.yaml; likely part of coordinated spec updates.
• feat:Update openapi.yaml structure in src/libs/Cohere directory #115 — Changes the same OpenAPI spec file; probable follow-up or complementary annotations.
• feat:Update openapi.yaml file in src/libs/Cohere directory #120 — Touches src/libs/Cohere/openapi.yaml; potentially related spec refinements.

Poem

A rabbit taps the spec with care,
Deprecations flagged—beware!
Samples whisper, “URLs or base64,”
Clearer paths than e’er before.
I thump my foot, then hop away—
Docs aligned to guide the way. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The PR title "feat:@coderabbitai" is not a clear, descriptive summary of the branch's changes. The changeset primarily marks multiple OpenAPI endpoints as deprecated and updates sample examples in src/libs/Cohere/openapi.yaml, which the title does not convey. Because it reads like an author/bot tag rather than a concise summary of intent, it is insufficient for teammates scanning history.	Rename the PR to a concise, specific title that summarizes the main change, for example "deprecate multiple OpenAPI endpoints and update sample examples". Use a conventional prefix only when paired with a clear description (e.g., "feat(openapi): deprecate endpoints and update samples"). Update the title before merging so changelogs remain useful; maintainers may rename the PR if preferred.

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

---

📜 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 3fe7515.

⛔ 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: LGTM: Connectors parameter properly deprecated.

The deprecation is appropriate for marking this parameter as outdated while maintaining backward compatibility.

---

171-171: LGTM: Search queries only parameter properly deprecated.

The deprecation is appropriate for marking this parameter as outdated while maintaining backward compatibility.

---

1007-1007: LGTM: Multiple endpoints consistently marked as deprecated.

The deprecation annotations are properly applied across all these endpoint definitions, maintaining consistency in the API specification.

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

---

8775-8775: Enhanced documentation improves developer experience.

The added comments in code examples across multiple languages (TypeScript, Python, Java, Go) clearly document that image_url accepts both base64 data URIs and web URLs, which significantly improves the developer experience.

Also applies to: 8778-8778, 8781-8781, 8784-8784

---

8775-8786: Consistency verified — comment is uniform across samples. The phrase "Can be either a base64 data URI or a web URL." appears identically in the JS, Python, Java, Go examples and in the OpenAPI description.

---

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