feat: add GET /api/v1/workflow endpoint

[UlisesGascon]

Related #216

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint (GET /api/v1/workflow) to retrieve a list of all workflows, each with an ID and description.
  • Updated API documentation to include the new endpoint and its responses.

• Tests

  • Added tests to verify the new workflow listing endpoint returns the expected data and handles errors.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new API endpoint, GET /api/v1/workflow, was introduced to list all workflows. Supporting changes include a new function to retrieve workflow descriptors, updates to the OpenAPI specification, and corresponding tests to verify correct responses and error handling for the new endpoint.

Changes

File(s)	Change Summary
src/cli/workflows.js	Added workflows array and exported getAllWorkflows function returning workflow descriptors.
src/httpServer/routers/apiV1.js	Added GET /workflow endpoint that returns all workflows using getAllWorkflows; handles errors with 500.
src/httpServer/swagger/api-v1.yml	Documented new /api/v1/workflow GET endpoint in OpenAPI spec with response schemas and error handling.
tests/httpServer/apiV1.test.js	Added tests for /api/v1/workflow endpoint, including success and a placeholder for error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Router
    participant Workflows_Module

    Client->>API_Router: GET /api/v1/workflow
    API_Router->>Workflows_Module: getAllWorkflows()
    Workflows_Module-->>API_Router: [ {id, description}, ... ]
    API_Router-->>Client: 200 OK, JSON array of workflows
    alt Error occurs
        API_Router-->>Client: 500 Internal Server Error, error message
    end

Loading

Possibly related PRs

• Include HTTP API backbone  #221: Adds the HTTP API backbone and health check endpoint, which the new /api/v1/workflow endpoint builds upon.

Poem

A hop, a skip, a brand new route,
Workflows listed, there's no doubt!
With tests in tow and docs in line,
The API grows—oh, how divine!
🐇✨
Now every bunny can see,
What workflows there might be!

---

📜 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 35ee87b and fcb32fb.

📒 Files selected for processing (4)

• __tests__/httpServer/apiV1.test.js (2 hunks)
• src/cli/workflows.js (2 hunks)
• src/httpServer/routers/apiV1.js (2 hunks)
• src/httpServer/swagger/api-v1.yml (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.