Skip to content

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Sep 18, 2025

Summary by CodeRabbit

  • Documentation

    • Marked multiple public API endpoints and select parameters as deprecated in the OpenAPI specification, ensuring clear deprecation signals in docs and generated SDKs.
    • Updated examples for image inputs across TypeScript, Python, Java, Go, and Node to clarify that image_url accepts base64 data URIs or web URLs.
  • Chores

    • Standardized deprecation flags across affected operations for consistent visibility in tooling and documentation.

@coderabbitai
Copy link

coderabbitai bot commented Sep 18, 2025

Walkthrough

Multiple 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

Cohort / File(s) Summary
Deprecations in OpenAPI operations and params
src/libs/Cohere/openapi.yaml
Added deprecated: true to numerous path operations, a ChatConnector-related parameter, and the search_queries_only parameter.
Image examples updated (multi-language comments)
src/libs/Cohere/openapi.yaml
In TypeScript, Python, Java, Go, and Node samples, added comments noting image_url may be a base64 data URI or a web URL; curl sample unchanged.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

I twitch my ears at the spec’s new fate,
Old paths flagged gently: “deprecate.”
Images now speak in URLs or base64 streams,
Docs aligned like tidy clover seams.
I thump approval—hop, hop, hooray!
The map is clearer for devs today. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title "feat:@coderabbitai" is not a clear, descriptive summary of the PR; it reads like a bot/tag and does not indicate that the OpenAPI spec was changed to mark many endpoints as deprecated or that image_url examples were clarified, so it fails the concise and specific title criteria. Replace the title with a short, specific sentence that highlights the main change, for example: "openapi: deprecate multiple endpoints and clarify image_url examples" or "chore(openapi): mark legacy operations deprecated and update image examples"; avoid emojis, file lists, or vague labels.
✅ 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_202509182118

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@HavenDV HavenDV enabled auto-merge (squash) September 18, 2025 21:19
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Mark deprecations in Cohere OpenAPI; update image_url format examples Sep 18, 2025
Copy link

@coderabbitai coderabbitai bot left a 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_only at the schema-property level is valid. Consider appending the replacement and EOL date in the description (or a custom x-deprecation-message) for SDKs/docs.


1007-1007: Operation-level deprecations: add migration pointers and sunset timeline.

Marking operations deprecated: true is 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 Sunset response header and an x-* 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 (imageUrl vs image_url) matches each SDK.

Also applies to: 8778-8778, 8781-8781, 8784-8784

📜 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 98d08f3.

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

Verified src/libs/Cohere/openapi.yaml: connectors property contains deprecated: true at line 66 (context lines 60–68). The reviewer’s suggestion to move it to a "parameter object" is not applicable because connectors is a requestBody schema property, not an OpenAPI parameter.

  • If you intend to deprecate the connectors array in the request body: keep deprecated: true where it is (no change).
  • If you intend to deprecate the item type itself: add deprecated: true under components/schemas/ChatConnector.
  • If you intended a parameter-level deprecation, convert connectors to a Parameter object (or define a components/parameters entry) and set deprecated: true there.

Likely an incorrect or invalid review comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants