Skip to content

fix(openapi): CreateManyArgs does not take array as input#1246

Merged
ymc9 merged 3 commits intodevfrom
fix/issue-create-many-array
Apr 12, 2024
Merged

fix(openapi): CreateManyArgs does not take array as input#1246
ymc9 merged 3 commits intodevfrom
fix/issue-create-many-array

Conversation

@ymc9
Copy link
Member

@ymc9 ymc9 commented Apr 12, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced API flexibility by allowing the data property to include either a single object or an array of objects.
    • Introduced a new skipDuplicates property to enable skipping of records with unique constraints or existing IDs.
    • Updated schema logic for creating multiple instances of a model with the addition of an optional skipDuplicates field.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 12, 2024

Walkthrough

Walkthrough

The recent updates aim to enhance data handling capabilities in the RPCOpenAPIGenerator class, enabling support for both singular objects and arrays of objects. The introduction of the skipDuplicates boolean property across various schemas enhances data integrity by facilitating the exclusion of duplicate entries, optimizing API interactions.

Changes

File Path Change Summary
.../openapi/src/rpc-generator.ts Modified data property to support single or multiple objects; added skipDuplicates property.
.../openapi/tests/baseline/rpc-3.0.0.baseline.yaml Updated data property to allow schema references or arrays; added skipDuplicates.
.../openapi/tests/baseline/rpc-type-coverage-3.0.0.baseline.yaml
.../openapi/tests/baseline/rpc-type-coverage-3.1.0.baseline.yaml
Modified data property to allow schema references or arrays; added skipDuplicates.
.../schema/src/plugins/zod/transformer.ts Added an optional skipDuplicates field to the createMany object schema definition.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3c74061 and 63de916.
Files selected for processing (2)
  • packages/plugins/openapi/tests/baseline/rpc-type-coverage-3.0.0.baseline.yaml (1 hunks)
  • packages/plugins/openapi/tests/baseline/rpc-type-coverage-3.1.0.baseline.yaml (1 hunks)
Files not reviewed due to errors (1)
  • rpc-type-coverage-3.1.0.baseline.yaml (no review received)
Additional comments not posted (2)
packages/plugins/openapi/tests/baseline/rpc-type-coverage-3.0.0.baseline.yaml (2)

2020-2024: The update to the data property to accept either a single object or an array of objects is correctly implemented using the oneOf keyword. This change aligns with the PR objectives to enhance API flexibility for batch operations.


2025-2028: The addition of the skipDuplicates property with a clear description is a good practice. It helps in preventing the insertion of duplicate records by checking unique fields or IDs, which enhances data integrity.


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@ymc9 ymc9 merged commit 8137481 into dev Apr 12, 2024
@ymc9 ymc9 deleted the fix/issue-create-many-array branch April 12, 2024 07:04
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.

1 participant