feat:Mark params and operations as deprecated in src/libs/Cohere/openapi.yaml

[HavenDV]

Summary by CodeRabbit

• Documentation

  • Updated API reference to mark several endpoints as deprecated.
  • Marked the “search_queries_only” parameter as deprecated.
  • Marked the ChatConnector-related parameter used for connector-based enrichment as deprecated.
  • Deprecation status now clearly indicated in generated SDKs and API explorers.

• Chores

  • Refreshed OpenAPI metadata to reflect current deprecation status across affected operations and parameters.

[coderabbitai]

Walkthrough

Adds deprecated: true flags in src/libs/Cohere/openapi.yaml for specific parameters and multiple path operations, including the parameter referencing #/components/schemas/ChatConnector, the boolean parameter search_queries_only, and several operations, notably those listing ServiceUnavailable and GatewayTimeout responses.

Changes

Cohort / File(s)	Summary of Changes
Deprecated parameters src/libs/Cohere/openapi.yaml	Marked parameter referencing #/components/schemas/ChatConnector as deprecated; marked boolean parameter search_queries_only as deprecated.
Deprecated operations src/libs/Cohere/openapi.yaml	Added deprecated: true to multiple path operations, including those with responses referencing ServiceUnavailable (503) and GatewayTimeout (504).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat:Update openapi.yaml file in src/libs/Cohere directory #119 — Also updates src/libs/Cohere/openapi.yaml; likely adjacent deprecation or spec tweaks.
• feat:Update openapi.yaml file in src/libs/Cohere directory #118 — Modifies the same OpenAPI spec file; potentially related parameter/operation metadata changes.
• feat:Update openapi.yaml file in src/libs/Cohere directory #120 — Touches src/libs/Cohere/openapi.yaml; could overlap with operation annotations.

Poem

A rabbit taps the spec with care,
Flags of “deprecated” everywhere.
Parameters bow, old paths retire,
503s, 504s conspire.
I twitch my nose, commit and hop—
Onward to newer endpoints—pop! 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title "feat:@coderabbitai" is a short bot/automation tag and does not describe the primary change in this PR (adding deprecated: true flags to src/libs/Cohere/openapi.yaml); it is therefore too vague for a reviewer to understand the intent at a glance. A PR title should briefly summarize the main change, but this one neither mentions OpenAPI nor the deprecation updates made. Because the title is non-descriptive and does not convey the main change, the check is inconclusive.	Please replace the title with a concise, descriptive summary such as "chore(openapi/cohere): mark deprecated parameters and operations in src/libs/Cohere/openapi.yaml" or "docs(openapi): deprecate ChatConnector and search_queries_only in Cohere spec" so reviewers immediately see the PR's intent.

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

---

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

♻️ Duplicate comments (8)

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

1128-1134: Same placement check as above. Ensure deprecated is at the Operation level.

Duplicate of the previous comment; please lint this block too.

---

1198-1204: Same placement check as above.

---

1271-1277: Same placement check as above.

---

1343-1349: Same placement check as above.

---

1421-1427: Same placement check as above.

---

1501-1507: Same placement check as above.

---

6623-6629: Same placement check as above.

---

7178-7184: Same placement check as above.

🧹 Nitpick comments (2)

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

63-69: Clarify the deprecation scope and guidance for consumers.

If the intent is to deprecate this request-body field (the array of ChatConnector items), schema-level deprecated: true is fine. If instead the whole parameter is deprecated (e.g., a query/header param), place deprecated: true on the Parameter Object, not just its schema. Also, add explicit migration guidance (what to use instead) so SDKs and docs surface a clear path.

Consider appending a short deprecation note to description (replacement and removal timeline). If helpful, I can draft consistent deprecation text across all affected fields.

---

168-174: Provide migration path for search_queries_only and confirm deprecation level.

Schema-level deprecated: true marks the field as deprecated; confirm that this is the intended scope. Add replacement guidance in description (e.g., the new flag/endpoint to use) to avoid ambiguity in generated docs/SDKs.

I can generate a one-liner deprecation blurb template if you share the replacement.

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

⛔ 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

🔇 Additional comments (1)

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

1004-1010: No change needed — deprecated is correctly attached to the Operation object.

Verified in src/libs/Cohere/openapi.yaml (around lines 1002–1010): deprecated: true is a sibling of responses (not nested under '503'/'504').