appcore-api 1.0.1-rc.8

HTTP API host and transport contracts for AppCore Runtime.
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

// =============================================================================
//        #######
//     ###       ###     F: api.rs
//    ##   ## ##   ##    P: AppCore-Runtime
//         ## ##
//                       C: 2026/05/31 13:38:42 by dnettoRaw
//    ##   ## ##   ##    U: 2026/06/04 11:51:28 by dnettoRaw
//      ###########      S: 0.6.0
// =============================================================================

//! Raw API request/response contracts.

/// Supported API method kinds.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ApiMethod {
    /// Mutating or important command.
    Command,
    /// Side-effect-free query.
    Query,
    /// Runtime health probe.
    Health,
}

/// Transport-neutral API request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApiRequest {
    /// Logical request method.
    pub method: ApiMethod,
    /// Transport-neutral endpoint or capability path.
    pub path: String,
    /// Opaque request bytes owned by the caller.
    pub payload: Vec<u8>,
}

/// Transport-neutral API response.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApiResponse {
    /// HTTP-compatible status code.
    pub status_code: u16,
    /// Opaque response bytes owned by the endpoint.
    pub payload: Vec<u8>,
}

#[cfg(test)]
#[path = "api_tests.rs"]
mod tests;