chore: use to /api/v1/workflow/:id/execute

[UlisesGascon]

Related to #1 and OpenPathfinder/visionBoard#250

Summary by CodeRabbit

• Bug Fixes
  • Updated the workflow execution endpoint to use the correct API path, ensuring consistent and reliable workflow execution.

[coderabbitai]

Walkthrough

The changes update the workflow execution endpoint in both the API client and its associated test suite, switching from /run to /execute. All logic, payloads, and response handling remain the same, with modifications limited to the endpoint path used in HTTP POST requests.

Changes

File(s)	Change Summary
src/api-client.ts	Updated the runWorkflow function to use /execute endpoint.
src/tests/cli-commands.test.ts	Changed mocked API endpoint from /run to /execute in all tests.

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant APIClient
  participant Server

  CLI->>APIClient: runWorkflow(workflowId, payload)
  APIClient->>Server: POST /api/v1/workflow/{workflowId}/execute
  Server-->>APIClient: Response (success or error)
  APIClient-->>CLI: Result

Loading

Possibly related PRs

• feat: add command workflow execute #9: Introduced the original runWorkflow function and CLI command using the /run endpoint, which this PR now updates to /execute.

Poem

A hop to the endpoint, a skip to the path,
From /run to /execute, we’ve made the swap at last.
The tests all agree, the client is keen,
Workflows now execute, swift and serene.
🐇✨

---

📜 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 61cd39c and 18768dd.

📒 Files selected for processing (2)

• src/__tests__/cli-commands.test.ts (4 hunks)
• src/api-client.ts (1 hunks)

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

• GitHub Check: Test on windows-latest with Node 22.x
• GitHub Check: Test on windows-latest with Node 24.x
• GitHub Check: Test on windows-latest with Node 20.x
• GitHub Check: Analyze (actions)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

src/api-client.ts (1)

86-86: LGTM! Endpoint update is consistent with PR objectives.

The change from /run to /execute aligns with the PR description to update the workflow execution endpoint. The logic and error handling remain intact.

Note: The function name runWorkflow remains unchanged while the endpoint is now /execute. This creates a minor semantic inconsistency, but it's not a breaking change and maintains API compatibility for consumers of this function.

src/__tests__/cli-commands.test.ts (1)

521-521: Excellent test coverage for the endpoint update.

All test scenarios for the executeWorkflow command have been properly updated to use the new /execute endpoint:

• Successful workflow execution
• Unsuccessful workflow execution
• API error handling
• Network error handling

The test logic, payloads, and assertions remain unchanged, ensuring comprehensive validation of the updated endpoint.

Also applies to: 541-541, 561-561, 576-576

✨ 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.