owlauth-types 0.1.2

Public Project Auth and Control API types for OwlAuth
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

use serde::Serialize;
use utoipa::ToSchema;

/// Minimal response returned by listener liveness and readiness probes.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, ToSchema)]
pub struct HealthResponse {
    /// Stable probe status. Successful probes return `ok`.
    pub status: String,
}

impl HealthResponse {
    /// Creates a successful probe response.
    #[must_use]
    pub fn ok() -> Self {
        Self {
            status: "ok".to_owned(),
        }
    }

    /// Creates a failed readiness response.
    #[must_use]
    pub fn unavailable() -> Self {
        Self {
            status: "unavailable".to_owned(),
        }
    }
}

#[utoipa::path(
    get,
    path = "/health",
    responses(
        (status = 200, description = "The listener event loop is responsive", body = HealthResponse)
    )
)]
#[doc(hidden)]
#[must_use]
pub fn get_liveness() -> HealthResponse {
    HealthResponse::ok()
}

#[utoipa::path(
    get,
    path = "/ready",
    responses(
        (status = 200, description = "The listener can admit business traffic", body = HealthResponse),
        (status = 503, description = "A listener-critical dependency is unavailable", body = HealthResponse)
    )
)]
#[doc(hidden)]
#[must_use]
pub fn get_readiness() -> HealthResponse {
    HealthResponse::ok()
}