comindly-api 0.5.0-beta.10

comindly's API: the requests and answers of an engine's /api/v1, shared by the engine and the command line.
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Status {
    Queued,
    Running,
    Succeeded,
    Failed,
    Cancelled,
    /// The process stopped while it ran; what was saved stays, and it can run again.
    Interrupted,
    /// Stopped by a restart; it continues by itself once a server is back.
    Paused,
}

impl Status {
    pub fn finished(self) -> bool {
        !matches!(self, Status::Queued | Status::Running | Status::Paused)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct JobRecord {
    pub id: String,
    pub kind: String,
    pub started_by: Option<String>,
    pub status: Status,
    pub created: String,
    #[serde(default)]
    pub started: Option<String>,
    pub finished: Option<String>,
    pub error: Option<String>,
    /// The request that started it, as in its `X-Request-Id`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub request_id: Option<String>,
    /// What to run again after a restart; a job without it cannot continue.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub request: Option<serde_json::Value>,
    /// The running job's last sign of life, so a starting server leaves a live one alone.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub beat: Option<String>,
}