feat:Add deprecation markers in Cohere OpenAPI: desc, param, 11 ops #277
Conversation
WalkthroughDeprecated markers were added to elements in src/libs/Cohere/openapi.yaml: a ChatConnector description block, the search_queries_only parameter, and multiple operations (11) including those referencing ServiceUnavailable and GatewayTimeout responses. No functional logic or control flow changed; updates are metadata to indicate deprecation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
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. Comment |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (8)
src/libs/Cohere/openapi.yaml (8)
1128-1134: Same as above: deprecation OK; add replacement and timelineReplicate the deprecation rationale and optional
x-sunsethere to guide users.
1198-1204: Same as above: deprecation OK; document the alternativeProvide the “use instead” target and optional sunset date.
1271-1277: Same as aboveAdd
x-deprecation-reasonand considerx-sunset.
1343-1349: Same as aboveDocument migration path; plan SDK regen and release notes.
1421-1427: Same as aboveInclude explicit replacement endpoint/param and optional sunset metadata.
1501-1507: Same as aboveKeep deprecation consistent across related operations and examples.
6623-6629: Same as aboveConfirm deprecation is reflected in examples/docs for this path.
7178-7184: Same as aboveAdd rationale/replacement and align docs/SDKs.
🧹 Nitpick comments (3)
src/libs/Cohere/openapi.yaml (3)
168-174: Deprecation is fine; add replacement guidance and (optionally) a sunsetMarking
search_queries_onlydeprecated is OK. Please add a clear “use instead” note and, if known, a sunset via a vendor extension to aid SDKs and docs.search_queries_only: type: boolean description: "Defaults to `false`. ..." deprecated: true + x-deprecation-reason: "TBD: replaced by <new param/endpoint>." + x-sunset: "YYYY-MM-DD"
1004-1010: Operation-level deprecation: placement looks correct; add migration path and sunset
deprecated: trueat the operation level is valid. Provide what to call instead and optionallyx-sunsetso client SDKs can surface timelines.Consider also planning a future 410 or removal date in changelog and regenerating SDKs.
63-69: Add a vendor deprecation reason (array typing is already correct)connectors in src/libs/Cohere/openapi.yaml (≈ lines 61–66) is a schema array (type: array + items present) — do not move items. It is marked deprecated: true but lacks a deprecation rationale; add a vendor extension, e.g.
deprecated: true
x-deprecation-reason: "Replaced by <new field/flow>."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (21)
src/libs/Cohere/Generated/Cohere.CohereClient.Chat.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Classify.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Generate.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Summarize.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.CreateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.DeleteConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.GetConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.ListConnectors.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.OAuthAuthorizeConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ConnectorsClient.UpdateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Chat.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Classify.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Generate.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Summarize.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.CreateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.DeleteConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.GetConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.ListConnectors.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.OAuthAuthorizeConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IConnectorsClient.UpdateConnector.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.ChatRequest.g.csis 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
Summary by CodeRabbit
Documentation
Chores