foundation_deployment_docker 0.1.0

Docker Engine API v1.53 client over DynNetClient + valtron (bollard-free)
Documentation
//! Auto-generated API module for docker nodes.
//!
//! Generated by `cargo run --bin ewe_platform gen_api`.
//! DO NOT EDIT MANUALLY.
//!
//! Feature flag: `docker_nodes `

#![cfg(feature = "docker_nodes")]
#![allow(clippy::too_many_arguments, clippy::type_complexity)]
#![allow(clippy::missing_errors_doc, clippy::doc_markdown, clippy::useless_format)]
#![allow(unused_imports)]

use foundation_netio::{DynNetClient, PreparedRequestBuilder};
use foundation_netio::shared::client::http_client::HttpClient;
use serde::{Deserialize, Serialize};
use foundation_macros::JsonHash;

// Import shared types used by this module
use super::shared::ObjectVersion;

use super::shared::ApiResponse;

// =============================================================================
// TYPE DECLARATIONS
// =============================================================================

/// `NodeStatus` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NodeStatus {
    /// Addr property.
    #[serde(rename = "Addr")]
    pub addr: Option<String>,
    /// Message property.
    #[serde(rename = "Message")]
    pub message: Option<String>,
    /// State property.
    #[serde(rename = "State")]
    pub state: Option<NodeState>,
}

/// `ManagerStatus` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ManagerStatus {
    /// Addr property.
    #[serde(rename = "Addr")]
    pub addr: Option<String>,
    /// Leader property.
    #[serde(rename = "Leader")]
    pub leader: Option<bool>,
    /// Reachability property.
    #[serde(rename = "Reachability")]
    pub reachability: Option<Reachability>,
}

/// `Reachability` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct Reachability {
    #[serde(flatten)]
    pub data: std::collections::HashMap<String, serde_json::Value>,
}

/// `NodeState` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NodeState {
    #[serde(flatten)]
    pub data: std::collections::HashMap<String, serde_json::Value>,
}

/// `EngineDescription` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct EngineDescription {
    /// EngineVersion property.
    #[serde(rename = "EngineVersion")]
    pub engine_version: Option<String>,
    /// Labels property.
    #[serde(rename = "Labels")]
    pub labels: Option<serde_json::Value>,
    /// Plugins property.
    #[serde(rename = "Plugins")]
    pub plugins: Option<Vec<std::collections::HashMap<String, serde_json::Value>>>,
}

/// `GenericResources` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct GenericResources {
    #[serde(flatten)]
    pub data: std::collections::HashMap<String, serde_json::Value>,
}

/// `Platform` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct Platform {
    /// Architecture property.
    #[serde(rename = "Architecture")]
    pub architecture: Option<String>,
    /// OS property.
    #[serde(rename = "OS")]
    pub os: Option<String>,
}

/// `NodeDescription` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NodeDescription {
    /// Engine property.
    #[serde(rename = "Engine")]
    pub engine: Option<EngineDescription>,
    /// Hostname property.
    #[serde(rename = "Hostname")]
    pub hostname: Option<String>,
    /// Platform property.
    #[serde(rename = "Platform")]
    pub platform: Option<Platform>,
    /// Resources property.
    #[serde(rename = "Resources")]
    pub resources: Option<ResourceObject>,
    /// TLSInfo property.
    #[serde(rename = "TLSInfo")]
    pub tls_info: Option<TLSInfo>,
}

/// `Node` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct Node {
    /// CreatedAt property.
    #[serde(rename = "CreatedAt")]
    pub created_at: Option<String>,
    /// Description property.
    #[serde(rename = "Description")]
    pub description: Option<NodeDescription>,
    /// ID property.
    #[serde(rename = "ID")]
    pub id: Option<String>,
    /// ManagerStatus property.
    #[serde(rename = "ManagerStatus")]
    pub manager_status: Option<ManagerStatus>,
    /// Spec property.
    #[serde(rename = "Spec")]
    pub spec: Option<NodeSpec>,
    /// Status property.
    #[serde(rename = "Status")]
    pub status: Option<NodeStatus>,
    /// UpdatedAt property.
    #[serde(rename = "UpdatedAt")]
    pub updated_at: Option<String>,
    /// Version property.
    #[serde(rename = "Version")]
    pub version: Option<ObjectVersion>,
}

/// `ResourceObject` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ResourceObject {
    /// GenericResources property.
    #[serde(rename = "GenericResources")]
    pub generic_resources: Option<Vec<std::collections::HashMap<String, serde_json::Value>>>,
    /// MemoryBytes property.
    #[serde(rename = "MemoryBytes")]
    pub memory_bytes: Option<i64>,
    /// NanoCPUs property.
    #[serde(rename = "NanoCPUs")]
    pub nano_cp_us: Option<i64>,
}

/// `TLSInfo` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct TLSInfo {
    /// CertIssuerPublicKey property.
    #[serde(rename = "CertIssuerPublicKey")]
    pub cert_issuer_public_key: Option<String>,
    /// CertIssuerSubject property.
    #[serde(rename = "CertIssuerSubject")]
    pub cert_issuer_subject: Option<String>,
    /// TrustRoot property.
    #[serde(rename = "TrustRoot")]
    pub trust_root: Option<String>,
}

/// `NodeSpec` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NodeSpec {
    /// Availability property.
    #[serde(rename = "Availability")]
    pub availability: Option<String>,
    /// Labels property.
    #[serde(rename = "Labels")]
    pub labels: Option<serde_json::Value>,
    /// Name property.
    #[serde(rename = "Name")]
    pub name: Option<String>,
    /// Role property.
    #[serde(rename = "Role")]
    pub role: Option<String>,
}

// =============================================================================
// ARGS TYPES (per-endpoint)
// =============================================================================

/// Arguments for [`NodeList_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NodeListArgs {
    /// Query parameter: `filters`.
    pub filters: Option<String>,
}

/// Arguments for [`NodeInspect_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NodeInspectArgs {
    /// Path parameter: `id`.
    pub id: String,
}

/// Arguments for [`NodeDelete_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NodeDeleteArgs {
    /// Path parameter: `id`.
    pub id: String,
    /// Query parameter: `force`.
    pub force: Option<String>,
}

// =============================================================================
// CLIENT FUNCTIONS (per-endpoint)
// =============================================================================

// -----------------------------------------------------------------------------
// GET /nodes
// -----------------------------------------------------------------------------

/// GET /nodes.
///
/// Takes a `DynNetClient` and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = node_list_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn node_list_request<F>(
    client: DynNetClient,
    args: &NodeListArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<serde_json::Value>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/nodes",
    );
    let endpoint_url = format!("{}{}", base_url, path);

    let mut builder = PreparedRequestBuilder::get(&endpoint_url)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

    builder = builder.query("filters", args.filters.as_deref());

    if let Some(f) = builder_mod {
        f(&mut builder);
    }

    let response = client.send_async(builder.build()).await
        .map_err(|e| super::shared::ApiError::RequestSendFailed(e.to_string()))?;

    let status: usize = response.get_status().into();
    let headers = response.get_headers_ref().clone();
    if status < 200 || status >= 300 {
        return Err(super::shared::ApiError::HttpStatus { code: status as u16, headers, body: None });
    }
    let body_bytes = foundation_netio::shared::client::body_reader::collect_bytes_from_send_safe(response.take_body());
    let parsed: serde_json::Value = serde_json::from_slice(&body_bytes).map_err(|e: serde_json::Error| super::shared::ApiError::ParseFailed(e.to_string()))?;
    Ok(ApiResponse { status: status as u16, headers, body: parsed })
}

// -----------------------------------------------------------------------------
// GET /nodes/{id}
// -----------------------------------------------------------------------------

/// GET /nodes/{id}.
///
/// Takes a `DynNetClient` and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = node_inspect_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn node_inspect_request<F>(
    client: DynNetClient,
    args: &NodeInspectArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<Node>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/nodes/{}",
        args.id,
    );
    let endpoint_url = format!("{}{}", base_url, path);

    let mut builder = PreparedRequestBuilder::get(&endpoint_url)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

    if let Some(f) = builder_mod {
        f(&mut builder);
    }

    let response = client.send_async(builder.build()).await
        .map_err(|e| super::shared::ApiError::RequestSendFailed(e.to_string()))?;

    let status: usize = response.get_status().into();
    let headers = response.get_headers_ref().clone();
    if status < 200 || status >= 300 {
        return Err(super::shared::ApiError::HttpStatus { code: status as u16, headers, body: None });
    }
    let body_bytes = foundation_netio::shared::client::body_reader::collect_bytes_from_send_safe(response.take_body());
    let parsed: Node = serde_json::from_slice(&body_bytes).map_err(|e: serde_json::Error| super::shared::ApiError::ParseFailed(e.to_string()))?;
    Ok(ApiResponse { status: status as u16, headers, body: parsed })
}

// -----------------------------------------------------------------------------
// DELETE /nodes/{id}
// -----------------------------------------------------------------------------

/// DELETE /nodes/{id}.
///
/// Takes a `DynNetClient` and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = node_delete_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn node_delete_request<F>(
    client: DynNetClient,
    args: &NodeDeleteArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<()>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/nodes/{}",
        args.id,
    );
    let endpoint_url = format!("{}{}", base_url, path);

    let mut builder = PreparedRequestBuilder::delete(&endpoint_url)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

    builder = builder.query("force", args.force.as_deref());

    if let Some(f) = builder_mod {
        f(&mut builder);
    }

    let response = client.send_async(builder.build()).await
        .map_err(|e| super::shared::ApiError::RequestSendFailed(e.to_string()))?;

    let status: usize = response.get_status().into();
    let headers = response.get_headers_ref().clone();
    if status < 200 || status >= 300 {
        return Err(super::shared::ApiError::HttpStatus { code: status as u16, headers, body: None });
    }
    Ok(ApiResponse { status: status as u16, headers, body: () })
}