stormchaser-api 1.3.2

A robust, distributed workflow engine for event-driven and human-triggered workflows.
Documentation
use serde_json::Value;
use std::collections::HashMap;
use stormchaser_model::workflow::RunStatus;
/// Module for auth.
pub mod auth;
/// Module for cron.
pub mod cron;
/// Module for event rule.
pub mod event_rule;
/// Module for MCP (Model Context Protocol).
#[cfg(feature = "mcp")]
pub mod mcp;
/// Module for schema.
pub mod schema;
/// Module for step.
pub mod step;
/// Module for storage.
pub mod storage;
/// Module for webhook.
pub mod webhook;
/// Module for workflow.
pub mod workflow;

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use utoipa::{IntoParams, ToSchema};

use stormchaser_model::step::{StepInstance, StepOutput, StepStatusHistory};
use stormchaser_model::storage::{ArtifactRegistry, BackendType};
use stormchaser_model::test_report;

#[derive(Debug, Deserialize, ToSchema)]
/// Authexchangerequest.
pub struct AuthExchangeRequest {
    /// The sso token.
    pub sso_token: String,
    /// The callback url.
    pub callback_url: String,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
/// Authexchangeresponse.
pub struct AuthExchangeResponse {
    /// The access token.
    pub access_token: String,
    /// The refresh token.
    pub refresh_token: Option<String>,
    /// The token type.
    pub token_type: String,
    /// The expires in.
    pub expires_in: usize,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Authrefreshrequest.
pub struct AuthRefreshRequest {
    /// The refresh token.
    pub refresh_token: String,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Enqueuerequest.
pub struct EnqueueRequest {
    /// The workflow name.
    pub workflow_name: String,
    /// The repo url.
    pub repo_url: String,
    /// The workflow path.
    pub workflow_path: String,
    /// The git ref.
    pub git_ref: String,
    /// The inputs.
    #[schema(value_type = Object)]
    pub inputs: Value,
    /// The overrides.
    pub overrides: Option<RunOverrides>,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Runoverrides.
pub struct RunOverrides {
    /// The timeout.
    pub timeout: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
/// Enqueueresponse.
pub struct EnqueueResponse {
    /// The run id.
    pub run_id: stormchaser_model::RunId,
    /// The status.
    pub status: RunStatus,
}

#[derive(Debug, Deserialize, ToSchema, IntoParams)]
#[into_params(parameter_in = Query)]
/// Listrunsquery.
pub struct ListRunsQuery {
    /// The workflow name.
    pub workflow_name: Option<String>,
    #[schema(value_type = Option<String>)]
    #[param(value_type = Option<String>)]
    /// The status.
    pub status: Option<RunStatus>,
    /// The initiating user.
    pub initiating_user: Option<String>,
    /// The repo url.
    pub repo_url: Option<String>,
    /// The workflow path.
    pub workflow_path: Option<String>,
    /// The created after.
    pub created_after: Option<DateTime<Utc>>,
    /// The created before.
    pub created_before: Option<DateTime<Utc>>,
    /// The limit.
    pub limit: Option<usize>,
    /// The offset.
    pub offset: Option<usize>,
}

#[derive(Debug, Serialize, Deserialize, ToSchema, sqlx::FromRow)]
/// Workflowrundetail.
pub struct WorkflowRunDetail {
    /// The id.
    pub id: stormchaser_model::RunId,
    /// The workflow name.
    pub workflow_name: String,
    /// The initiating user.
    pub initiating_user: String,
    /// The repo url.
    pub repo_url: String,
    /// The workflow path.
    pub workflow_path: String,
    /// The git ref.
    pub git_ref: String,
    /// The status.
    pub status: RunStatus,
    /// The version.
    pub version: i32,
    /// The created at.
    pub created_at: DateTime<Utc>,
    /// The updated at.
    pub updated_at: DateTime<Utc>,
    /// The started resolving at.
    pub started_resolving_at: Option<DateTime<Utc>>,
    /// The started at.
    pub started_at: Option<DateTime<Utc>>,
    /// The finished at.
    pub finished_at: Option<DateTime<Utc>>,
    /// The error.
    pub error: Option<String>,
    /// The inputs.
    #[schema(value_type = Object)]
    pub inputs: Value,
    /// The secrets.
    pub secrets: Value,
    /// The source code.
    pub source_code: String,
    /// The dsl version.
    pub dsl_version: String,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
/// Workflowrunfulldetail.
pub struct WorkflowRunFullDetail {
    /// The detail.
    pub detail: WorkflowRunDetail,
    /// The steps.
    pub steps: Vec<StepDetail>,
    #[schema(value_type = Vec<Object>)]
    /// The artifacts.
    pub artifacts: Vec<ArtifactRegistry>,
    /// The test summaries.
    pub test_summaries: Vec<TestSummaryResponse>,
    #[schema(value_type = Vec<Object>)]
    /// The test cases.
    pub test_cases: Vec<test_report::TestCase>,
}

#[derive(Debug, Serialize, Deserialize, ToSchema)]
/// Stepdetail.
pub struct StepDetail {
    /// The instance.
    pub instance: StepInstance,
    /// The outputs.
    pub outputs: Vec<StepOutput>,
    /// The history.
    pub history: Vec<StepStatusHistory>,
    /// The logs.
    pub logs: Vec<String>,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Directrunrequest.
pub struct DirectRunRequest {
    /// The dsl.
    pub dsl: String,
    /// The inputs.
    #[schema(value_type = Object)]
    pub inputs: Value,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Createwebhookrequest.
pub struct CreateWebhookRequest {
    /// The name.
    pub name: String,
    /// The description.
    pub description: Option<String>,
    /// The source type.
    pub source_type: String, // e.g. "github", "generic"
    /// The secret token.
    pub secret_token: Option<String>,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Updatewebhookrequest.
pub struct UpdateWebhookRequest {
    /// The name.
    pub name: Option<String>,
    /// The description.
    pub description: Option<String>,
    /// The source type.
    pub source_type: Option<String>, // e.g. "github", "generic"
    /// The secret token.
    pub secret_token: Option<String>,
    /// Is active.
    pub is_active: Option<bool>,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Createeventrulerequest.
pub struct CreateEventRuleRequest {
    /// The name.
    pub name: String,
    /// The description.
    pub description: Option<String>,
    /// The webhook id.
    pub webhook_id: stormchaser_model::WebhookId,
    /// The event type pattern.
    pub event_type_pattern: String,
    /// The condition expr.
    pub condition_expr: Option<String>,
    /// The workflow name.
    pub workflow_name: String,
    /// The repo url.
    pub repo_url: String,
    /// The workflow path.
    pub workflow_path: String,
    /// The git ref.
    pub git_ref: String,
    /// The input mappings.
    pub input_mappings: HashMap<String, String>,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Createcronworkflowrequest.
pub struct CreateCronWorkflowRequest {
    /// The name.
    pub name: String,
    /// The description.
    pub description: Option<String>,
    /// The cronspec.
    pub cronspec: String,
    /// The workflow name.
    pub workflow_name: String,
    /// The repo url.
    pub repo_url: String,
    /// The workflow path.
    pub workflow_path: String,
    /// The git ref.
    pub git_ref: String,
    /// The inputs.
    #[schema(value_type = Object)]
    pub inputs: Value,
}

#[derive(Debug, Serialize, ToSchema)]
/// Cronworkflowresponse.
pub struct CronWorkflowResponse {
    /// The id.
    pub id: stormchaser_model::CronWorkflowId,
    /// The secret token.
    pub secret_token: String,
    /// The external job id.
    pub external_job_id: Option<String>,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Createstoragebackendrequest.
pub struct CreateStorageBackendRequest {
    /// The name.
    pub name: String,
    /// The description.
    pub description: Option<String>,
    /// The backend type.
    pub backend_type: BackendType,
    /// The config.
    #[schema(value_type = Object)]
    pub config: Value,
    /// Optional AWS role ARN.
    pub aws_assume_role_arn: Option<String>,
    /// The is default sfs.
    pub is_default_sfs: bool,
}

#[derive(Debug, Deserialize, ToSchema)]
/// Updatestoragebackendrequest.
pub struct UpdateStorageBackendRequest {
    /// The name.
    pub name: Option<String>,
    /// The description.
    pub description: Option<String>,
    /// The backend type.
    pub backend_type: Option<BackendType>,
    /// The config.
    #[schema(value_type = Object)]
    pub config: Option<Value>,
    /// Optional AWS role ARN. Set to an empty string to clear an existing ARN.
    pub aws_assume_role_arn: Option<String>,
    /// The is default sfs.
    pub is_default_sfs: Option<bool>,
}

#[derive(Debug, Serialize, Deserialize, sqlx::FromRow, ToSchema)]
/// Testreportsummary.
pub struct TestReportSummary {
    /// The id.
    pub id: stormchaser_model::TestReportId,
    /// The report name.
    pub report_name: String,
    /// The file name.
    pub file_name: String,
    /// The format.
    pub format: String,
    /// The checksum.
    pub checksum: String,
    /// The backend id.
    pub backend_id: Option<stormchaser_model::BackendId>,
    /// The remote path.
    pub remote_path: Option<String>,
    /// The created at.
    pub created_at: DateTime<Utc>,
}

#[derive(Debug, Serialize, Deserialize, sqlx::FromRow, ToSchema)]
/// Testsummaryresponse.
pub struct TestSummaryResponse {
    /// The id.
    pub id: stormchaser_model::TestReportId,
    /// The run id.
    pub run_id: stormchaser_model::RunId,
    /// The step instance id.
    pub step_instance_id: stormchaser_model::StepInstanceId,
    /// The report name.
    pub report_name: String,
    /// The total tests.
    pub total_tests: i32,
    /// The passed.
    pub passed: i32,
    /// The failed.
    pub failed: i32,
    /// The skipped.
    pub skipped: i32,
    /// The errors.
    pub errors: i32,
    /// The duration ms.
    pub duration_ms: i64,
    /// The created at.
    pub created_at: DateTime<Utc>,
}