Add request/response thrift types for start workflow http endpoint

[kumar-zlai]

Summary

Needed for orchestration service till we move over these thrift files

Checklist

• Added Unit Tests
• Covered by existing CI
• Integration tested
• Documentation update

Summary by CodeRabbit

• New Features
  • Introduced support for starting workflows with detailed parameters, including node name, branch, date range, and partition specifications.
  • Responses now include the workflow identifier when a workflow is started.

[coderabbitai]

Walkthrough

Two new Thrift structs, WorkflowStartRequest and WorkflowStartResponse, were added to the orchestration service API. These structures define the parameters required to start a workflow and the response containing the workflow identifier. No existing types or logic were changed.

Changes

File	Change Summary
api/thrift/orchestration.thrift	Added WorkflowStartRequest and WorkflowStartResponse structs for workflow start API functionality.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant OrchestrationService

    Client->>OrchestrationService: WorkflowStartRequest (nodeName, branch, startDate, endDate, partitionSpecFormat, partitionSpecMillis)
    OrchestrationService-->>Client: WorkflowStartResponse (workflowId)

Loading

Poem

New structs arrive in Thrift’s domain,
Workflows can start, with fields to explain.
Request goes out, response comes back,
A workflow ID sets you on track.
In code we trust, with structs so neat—
Orchestration’s API is now complete!
🚀

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

---

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

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 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]

Actionable comments posted: 0

🧹 Nitpick comments (2)

api/thrift/orchestration.thrift (2)

259-266: Document the request struct.
Add a brief comment above WorkflowStartRequest explaining its purpose and expected parameters.

---

268-270: Document the response struct.
Add a comment for WorkflowStartResponse clarifying what workflowId represents and its format.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 2ff8387 and 1d5cd40.

📒 Files selected for processing (1)

• api/thrift/orchestration.thrift (1 hunks)

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

• GitHub Check: api_tests
• GitHub Check: service_tests
• GitHub Check: online_tests
• GitHub Check: service_commons_tests
• GitHub Check: cloud_aws_tests
• GitHub Check: online_tests
• GitHub Check: aggregator_tests
• GitHub Check: cloud_gcp_tests
• GitHub Check: service_tests
• GitHub Check: cloud_aws_tests
• GitHub Check: flink_tests
• GitHub Check: flink_tests
• GitHub Check: cloud_gcp_tests
• GitHub Check: aggregator_tests
• GitHub Check: api_tests

🔇 Additional comments (1)

api/thrift/orchestration.thrift (1)

259-266: Validate field requirements.
Confirm which fields truly can be absent; e.g. should nodeName or branch be required instead of optional?