feat: add POST /api/v1/bulk-import endpoint

[UlisesGascon]

Related #216

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint for bulk import operations, allowing users to submit data for bulk processing and receive status updates.
  • Updated API documentation to include the new bulk import endpoint and improved schema naming for operation completion responses.

• Bug Fixes

  • Improved error handling for invalid payloads and non-existent operations in bulk import requests, providing clear error responses.

• Tests

  • Expanded test coverage for the new bulk import endpoint, including success and failure scenarios.
  • Temporarily skipped integration tests related to bulk import for further review.

[UlisesGascon]

@coderabbitai resume

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new POST /api/v1/bulk-import API endpoint was introduced, along with OpenAPI documentation and comprehensive tests. The bulk import logic was refactored to accept validated data directly, and the endpoint now handles validation, error reporting, and operation execution. Related test suites were updated, including skipping a redundant integration suite.

Changes

File(s)	Change Summary
src/httpServer/routers/apiV1.js	Added POST /bulk-import endpoint with validation, error handling, and operation execution.
src/httpServer/swagger/api-v1.yml	Added OpenAPI docs for /api/v1/bulk-import; renamed schema WorkflowCompleted to OperationCompleted.
src/importers/index.js	Refactored bulkImport to new signature; removed file/data validation and file reading logic.
tests/httpServer/apiV1.test.js	Added/extended tests for the new bulk import endpoint, including success and error scenarios.
tests/importers.test.js	Skipped the "Integration: bulkImport" test suite.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Router
    participant Validator
    participant Importer
    participant DB

    Client->>API_Router: POST /api/v1/bulk-import {id, payload}
    API_Router->>API_Router: Find operation by id
    alt Operation not found
        API_Router-->>Client: 404 Not Found
    else Operation found
        API_Router->>Validator: validateBulkImport(payload)
        alt Validation fails
            API_Router-->>Client: 400 Bad Request
        else Validation succeeds
            API_Router->>Importer: bulkImport({operationId, knex, data})
            Importer->>DB: Upsert data (manual checks)
            Importer-->>API_Router: Success/Failure result
            alt Success
                API_Router-->>Client: 202 Accepted + success message
            else Failure
                API_Router-->>Client: 500 Internal Server Error
            end
        end
    end

Loading

Possibly related PRs

• feat: add GET /api/v1/bulk-import endpoint #252: Adds a GET /api/v1/bulk-import endpoint and tests for listing bulk import operations, complementing this PR's POST endpoint for performing imports.

Poem

In the warren, code is hopping,
Bulk imports now—no more stopping!
POST arrives, the checks go through,
Errors handled, tests anew.
Swagger’s docs are crystal clear,
Operation done—let’s all cheer!
🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a1755c5 and a5dc116.

📒 Files selected for processing (5)

• __tests__/httpServer/apiV1.test.js (3 hunks)
• __tests__/importers.test.js (1 hunks)
• src/httpServer/routers/apiV1.js (2 hunks)
• src/httpServer/swagger/api-v1.yml (3 hunks)
• src/importers/index.js (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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]

✅ Actions performed

Reviews resumed.