feat:Deprecate operations and params in src/libs/Cohere/openapi.yaml

[HavenDV]

Summary by CodeRabbit

• Chores
  • Marked multiple Cohere API operations as deprecated.
  • Deprecated a ChatConnector-related input and a boolean parameter used for search queries.
• Documentation
  • Updated API documentation to clearly indicate deprecated endpoints and parameters and guide users toward alternatives.

[coderabbitai]

Walkthrough

Multiple operations and parameters in src/libs/Cohere/openapi.yaml are marked as deprecated by adding deprecated: true. Deprecations include several path operations, a ChatConnector-related input, and the boolean parameter search_queries_only. No new endpoints, schemas, or behavior changes are introduced.

Changes

Cohort / File(s)	Summary of Changes
OpenAPI Deprecations src/libs/Cohere/openapi.yaml	Added deprecated: true to numerous path operations. Marked a ChatConnector-related items/description input as deprecated. Marked boolean parameter search_queries_only as deprecated. No schema shapes or response structures changed; no new endpoints added.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #116 — Also updates src/libs/Cohere/openapi.yaml; likely overlapping edits to operation metadata.
• feat:Update openapi.yaml file in src/libs/Cohere directory #113 — Modifies the same OpenAPI spec file; potentially related endpoint/operation changes.
• feat:Update openapi.yaml file in src/libs/Cohere directory #118 — Touches src/libs/Cohere/openapi.yaml; likely adjacent adjustments to the spec.

Poem

A rabbit taps the spec with care,
Flags of “deprecated” everywhere.
Old paths bow out with quiet grace,
Parameters yield their place.
I nibble docs, then hop along—
The map is cleaner, still as strong.
🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The provided title "feat:@coderabbitai" is not a clear, descriptive summary of the changes in this PR and reads like a bot/user tag rather than a concise change description. The changeset primarily marks multiple Cohere OpenAPI operations, a ChatConnector input, and a boolean parameter as deprecated, which the title does not communicate. Because the title is vague and does not convey the PR's main purpose, the check is inconclusive.	Please rename the pull request to a short, specific sentence that reflects the main change (for example: "Deprecate multiple Cohere OpenAPI endpoints and parameters" or "Mark ChatConnector input and several OpenAPI operations as deprecated"). Also update the PR description to briefly list the affected files and the intent so reviewers can quickly understand the scope.

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

---

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: Schema-level deprecation is valid; add a deprecation note and replacement hint.

Marking this field’s schema as deprecated: true is correct. Consider adding a custom note for SDKs (e.g., x-deprecation-message and x-replaced-by) so clients see actionable guidance.

---

168-174: Add an explicit default to match the description.

The description says “Defaults to false” but the schema lacks default: false. Add it to keep generators and validation consistent.

                 search_queries_only:
                   type: boolean
                   description: "Defaults to `false`.\n\nWhen `true`, the response will only contain a list of generated search queries, but no search will take place, and no reply from the model to the user's `message` will be generated.\n\nCompatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments\n"
+                  default: false
                   deprecated: true

---

1004-1010: Operation deprecation looks good; include a sunset/message if known.

deprecated: true at the Operation level is correct. If you have timeline/replacement, add x-deprecation-message (and optionally x-sunset) to aid client migration.

---

1128-1134: Same as above: deprecation OK; consider adding message/sunset metadata.

---

1198-1204: Same as above: deprecation OK; consider adding message/sunset metadata.

---

1271-1277: Same as above: deprecation OK; consider adding message/sunset metadata.

---

1343-1349: Same as above: deprecation OK; consider adding message/sunset metadata.

---

1421-1427: Same as above: deprecation OK; consider adding message/sunset metadata.

---

1501-1507: Same as above: deprecation OK; consider adding message/sunset metadata.

---

6623-6629: Same as above: deprecation OK; consider adding message/sunset metadata.

---

7178-7184: Same as above: deprecation OK; consider adding message/sunset metadata.

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

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