feat:Add deprecated:true to 2 params and 11 ops in Cohere openapi.yaml #257
Conversation
WalkthroughAdds deprecated: true flags in src/libs/Cohere/openapi.yaml for two parameters and multiple operations (11 endpoints). No other schema content or behavior is modified. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ 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
🧹 Nitpick comments (8)
src/libs/Cohere/openapi.yaml (8)
63-69: Confirm deprecation scope for the connectors array.Placing
deprecated: trueat this schema level deprecates the entire array property (i.e., the parameter as a whole), not the referencedChatConnectorschema nor specific item values. If the intent is to retire only certain connector IDs or theChatConnectortype, adjust accordingly (e.g., deprecate enum values or the referenced schema).Consider appending a brief deprecation note with the recommended alternative and, optionally, a vendor extension like
x-sunset: 'YYYY-MM-DD'for clarity. Do you want me to propose a targeted diff once the intended replacement is confirmed?
168-174: Deprecatingsearch_queries_onlyis fine; add guidance for clients.Marking the property as deprecated is non‑breaking, but client SDKs will start warning. Add a short sentence in the description with the alternative flag/flow and, optionally, a
x-sunset/x-deprecation-reasonvendor extension to aid codegen and docs.Also verify that examples and request samples in this spec (and docs) stop showcasing this field to avoid mixed signals.
1128-1134: LGTM — correct operation-level deprecation.Add a brief “Use ” note if available to reduce ambiguity in generated docs.
1198-1204: LGTM — deprecation applied consistently.If an EOL date exists, consider
x-sunsetto signal timelines.
1343-1349: LGTM.Consider adding a deprecation sentence in the operation description for clarity in rendered docs.
1501-1507: LGTM.No action needed; optional doc note as above.
7178-7184: LGTM.Final nit: if examples remain under
x-fern-examplesfor this op, consider tagging them deprecated or adding a replacement example.
1004-1010: Operation marked deprecated; include migration hint and (optionally) a sunset.This is valid OAS placement. Consider adding a one‑liner in the operation description pointing to the replacement endpoint and optionally
x-sunsetfor downstream tooling.Run to inventory all deprecations and spot any lingering examples that still reference deprecated ops/params:
#!/bin/bash set -euo pipefail file=src/libs/Cohere/openapi.yaml echo "All deprecated entries (with context):" rg -nC2 '^\s*deprecated:\s*true' "$file" echo -e "\nProbable operation-level deprecations (near responses/operationId):" rg -nC3 -U '(?s)^\s*(get|post|put|patch|delete):.*?\n\s*deprecated:\s*true' "$file" echo -e "\nCheck examples referencing deprecated params:" rg -n 'search_queries_only|connectors' "$file" -n -C2
📜 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
🔇 Additional comments (3)
src/libs/Cohere/openapi.yaml (3)
1271-1277: Looks good.No schema impact beyond signaling; ensure server continues to serve these until removal.
1421-1427: LGTM.Confirm that SDK generation (Fern or others) consumes
deprecatedas expected and doesn’t accidentally hide critical endpoints before the replacement is broadly available.
6623-6629: LGTM.Maintain consistency: if some sibling operations on the same path are deprecated, verify all intended ones are marked.
Summary by CodeRabbit
Deprecations
Documentation