ironflow-api 2.41.0

REST API for ironflow run management and observability
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

//! Approval delegation request and response DTOs.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use uuid::Uuid;
use validator::Validate;

use ironflow_store::entities::ApprovalDelegation;

/// Approval delegation response.
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Serialize)]
pub struct ApprovalDelegationResponse {
    /// Delegation ID.
    pub id: Uuid,
    /// User handing over their approval power.
    pub from_user_id: Uuid,
    /// User receiving the approval power.
    pub to_user_id: Uuid,
    /// Start of the validity window (inclusive).
    pub valid_from: DateTime<Utc>,
    /// End of the validity window (exclusive).
    pub valid_until: DateTime<Utc>,
    /// Glob on the workflow name. `None` means every workflow.
    pub workflow_filter: Option<String>,
    /// When the delegation was created.
    pub created_at: DateTime<Utc>,
}

impl From<ApprovalDelegation> for ApprovalDelegationResponse {
    fn from(d: ApprovalDelegation) -> Self {
        Self {
            id: d.id,
            from_user_id: d.from_user_id,
            to_user_id: d.to_user_id,
            valid_from: d.valid_from,
            valid_until: d.valid_until,
            workflow_filter: d.workflow_filter,
            created_at: d.created_at,
        }
    }
}

/// Create delegation request body.
///
/// The delegator is always the authenticated caller: a delegation can only be
/// granted by the person handing over their own approval power.
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Deserialize, Validate)]
pub struct CreateApprovalDelegationRequest {
    /// User receiving the delegated approval power.
    pub to_user_id: Uuid,
    /// Start of the window. Defaults to now when omitted.
    pub valid_from: Option<DateTime<Utc>>,
    /// End of the window (exclusive).
    pub valid_until: DateTime<Utc>,
    /// Optional glob on the workflow name, e.g. `"deploy-*"`. `None` = all workflows.
    pub workflow_filter: Option<String>,
}

/// Query parameters for listing delegations.
///
/// Both user filters are honoured for an admin only; a non-admin always sees
/// exactly the delegations they granted or received. Pagination applies to
/// everyone.
#[cfg_attr(feature = "openapi", derive(utoipa::IntoParams, utoipa::ToSchema))]
#[derive(Debug, Deserialize)]
pub struct ListApprovalDelegationsQuery {
    /// Only delegations granted by this user.
    pub from_user_id: Option<Uuid>,
    /// Only delegations received by this user.
    pub to_user_id: Option<Uuid>,
    /// Page number (1-based, defaults to 1).
    pub page: Option<u32>,
    /// Items per page (defaults to 20, max 100).
    pub per_page: Option<u32>,
}