ordinary-api 0.6.0-pre.13

API server for Ordinary
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc = include_str!("../README.md")]
#![warn(clippy::all, clippy::pedantic)]
#![allow(
    clippy::needless_for_each,
    clippy::missing_errors_doc,
    clippy::cast_precision_loss,
    clippy::match_wildcard_for_single_variants,
    clippy::similar_names
)]

// Copyright (C) 2026 Ordinary Labs, LLC.
//
// SPDX-License-Identifier: AGPL-3.0-only

use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

/// Client components for facilitating interaction with [`OrdinaryApiServer`]
#[cfg(feature = "client")]
pub mod client;

/// Server components for setting up an [`OrdinaryApiServer`]
#[cfg(feature = "server")]
pub mod server;

fn permissions_field(idx: u8) -> ordinary_types::Field {
    ordinary_types::Field {
        idx,
        name: "permissions".into(),
        kind: ordinary_types::Kind::List {
            kind: Box::new(ordinary_types::Kind::Enum {
                name: "permissions".into(),
                opts: vec![
                    ordinary_types::EnumOpt {
                        idx: 0,
                        name: "admin".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 1,
                        name: "read".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 2,
                        name: "write".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 3,
                        name: "update".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 4,
                        name: "upload".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 5,
                        name: "install".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 6,
                        name: "deploy".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 7,
                        name: "bridge".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 8,
                        name: "kill".into(),
                    },
                    ordinary_types::EnumOpt {
                        idx: 9,
                        name: "erase".into(),
                    },
                ],
            }),
        },
        ..Default::default()
    }
}

#[must_use]
pub fn api_invite_claims() -> Vec<ordinary_types::Field> {
    vec![
        ordinary_types::Field {
            idx: 1,
            name: "account".into(),
            kind: ordinary_types::Kind::String,
            ..Default::default()
        },
        ordinary_types::Field {
            idx: 2,
            name: "domain".into(),
            kind: ordinary_types::Kind::String,
            ..Default::default()
        },
        permissions_field(3),
    ]
}

#[must_use]
pub fn api_account_claims() -> Vec<ordinary_types::Field> {
    vec![
        ordinary_types::Field {
            idx: 1,
            name: "domain".into(),
            kind: ordinary_types::Kind::String,
            ..Default::default()
        },
        permissions_field(2),
    ]
}

#[derive(Serialize, Deserialize, ToSchema)]
pub struct ApiInfo {
    pub system_cpu_count: usize,
    pub system_cpu_usage: String,

    pub system_memory_total: String,
    pub system_memory_used: String,
    pub system_memory_free: String,
    pub system_memory_available: String,

    pub process_cpu_usage: String,
    pub process_cpu_time: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub process_threads: Option<usize>,

    pub process_memory_real: String,
    pub process_memory_virtual: String,

    pub process_disk_read: String,
    pub process_disk_write: String,
}