feat:Update OpenAPI schema: Remove additionalProperties constraint on data property

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated OpenAPI specification to allow more flexible data types in document references
  • Modified description of data property to reflect broader type support

[coderabbitai]

Walkthrough

The pull request involves modifications to the openapi.yaml file in the Cohere library's schema definition. Specifically, the changes relate to the data property, where the additionalProperties constraint has been removed, and the description updated. This alteration allows for more flexible value types within the data dictionary, expanding from a strict string-string mapping to a string-any dictionary structure.

Changes

File	Change Summary
src/libs/Cohere/openapi.yaml	- Removed additionalProperties constraint for data property - Updated description to indicate "string-any" dictionary instead of "string-string" dictionary

Possibly related PRs

• feat:Update OpenAPI spec: Restructure delta property for tool-related events #135: Modifies openapi.yaml schema structure, potentially related to overall file organization
• feat:Add tool_choice parameter to OpenAI specification for tool control #138: Adds new tool_choice parameter in openapi.yaml, indicating ongoing schema modifications

Suggested reviewers

• github-actions

Poem

🐰 In YAML's realm of type and might,
A schema shifts with flexible delight
From strings so strict to any's embrace
Our data dances with newfound grace
A rabbit's code, now wild and free! 🌈

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

12143-12143: Documentation inconsistency in plurality

The description changed from "documents" to "document" (singular). This seems inconsistent with the property being an object that can contain multiple entries.

Consider updating to:

-          description: "A relevant document that the model can cite to generate a more accurate reply. Each document is a string-any dictionary.\n"
+          description: "Relevant documents that the model can cite to generate a more accurate reply. Each document is a string-any dictionary.\n"

---

12143-12143: Consider adding schema validation for common types

While allowing any type provides flexibility, consider adding a pattern or enum for commonly expected value types to guide API consumers.

Example addition:

oneOf:
  - type: string
  - type: number
  - type: boolean
  - type: object
    additionalProperties: true

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e243066 and 0840311.

⛔ Files ignored due to path filters (3)

• src/libs/Cohere/Generated/Cohere.Models.Document.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.DocumentData.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test / Build, test and publish

🔇 Additional comments (1)

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

12143-12143: ⚠️ Potential issue

Breaking Change: Schema modification affects API contract

The change from a string-string to string-any dictionary is a breaking change that could impact existing clients. This modification allows for more flexible value types but might break implementations that expect string values.

Let's verify the impact on existing implementations: