-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat:Mark deprecations in Cohere OpenAPI; update image_url format examples #279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughMultiple API operations and parameters in src/libs/Cohere/openapi.yaml were marked deprecated. Additionally, image_url examples across several language snippets were updated to clarify accepted formats (base64 data URI or web URL). No new endpoints were added; changes are confined to the OpenAPI spec and inline example comments. Changes
Sequence Diagram(s)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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
src/libs/Cohere/openapi.yaml (3)
171-171: Schema property deprecation looks correct; add migration guidance.Deprecating
search_queries_onlyat the schema-property level is valid. Consider appending the replacement and EOL date in the description (or a customx-deprecation-message) for SDKs/docs.
1007-1007: Operation-level deprecations: add migration pointers and sunset timeline.Marking operations
deprecated: trueis correct. Improve DX by:
- Stating the replacement endpoint/version in each operation description.
- Documenting a deprecation/sunset date and behavior after sunset (410 vs. continued 200).
- Optionally add a
Sunsetresponse header and anx-*deprecation message for generators.Also applies to: 1131-1131, 1201-1201, 1274-1274, 1346-1346, 1424-1424, 1504-1504, 6626-6626, 7181-7181
8775-8775: Nice clarity on image_url formats; consider adding a base64 data URI example.Examples read well across TS/Py/Java/Go. Add one additional snippet showing a data URI (e.g.,
data:image/png;base64,....) to prevent ambiguity and confirm SDK handling. Also double-check key naming consistency (imageUrlvsimage_url) matches each SDK.Also applies to: 8778-8778, 8781-8781, 8784-8784
📜 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(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 (1)
src/libs/Cohere/openapi.yaml (1)
66-66: Incorrect — 'deprecated: true' is already on the connectors schema propertyVerified src/libs/Cohere/openapi.yaml: connectors property contains
deprecated: trueat line 66 (context lines 60–68). The reviewer’s suggestion to move it to a "parameter object" is not applicable becauseconnectorsis a requestBody schema property, not an OpenAPI parameter.
- If you intend to deprecate the connectors array in the request body: keep
deprecated: truewhere it is (no change).- If you intend to deprecate the item type itself: add
deprecated: trueunder components/schemas/ChatConnector.- If you intended a parameter-level deprecation, convert
connectorsto a Parameter object (or define a components/parameters entry) and setdeprecated: truethere.Likely an incorrect or invalid review comment.
Summary by CodeRabbit
Documentation
Chores