foundation_deployment_docker 0.1.3

//! Auto-generated API module for docker df.
//!
//! Generated by `cargo run --bin ewe_platform gen_api`.
//! DO NOT EDIT MANUALLY.
//!
//! Feature flag: `docker_df `

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

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

use super::shared::ApiResponse;

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

/// `BuildCacheDiskUsage` type.
///
/// Same shape as `super::shared::BuildCacheDiskUsageShape`.
pub type BuildCacheDiskUsage = super::shared::BuildCacheDiskUsageShape;

/// `ContainersDiskUsage` type.
///
/// Same shape as `super::shared::BuildCacheDiskUsageShape`.
pub type ContainersDiskUsage = super::shared::BuildCacheDiskUsageShape;

/// `ImagesDiskUsage` type.
///
/// Same shape as `super::shared::BuildCacheDiskUsageShape`.
pub type ImagesDiskUsage = super::shared::BuildCacheDiskUsageShape;

/// `SystemDataUsageResponse` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct SystemDataUsageResponse {
    /// `BuildCacheUsage` property.
    #[serde(rename = "BuildCacheUsage")]
    pub build_cache_usage: Option<BuildCacheDiskUsage>,
    /// `ContainerUsage` property.
    #[serde(rename = "ContainerUsage")]
    pub container_usage: Option<ContainersDiskUsage>,
    /// `ImageUsage` property.
    #[serde(rename = "ImageUsage")]
    pub image_usage: Option<ImagesDiskUsage>,
    /// `VolumeUsage` property.
    #[serde(rename = "VolumeUsage")]
    pub volume_usage: Option<VolumesDiskUsage>,
}

/// `VolumesDiskUsage` type.
///
/// Same shape as `super::shared::BuildCacheDiskUsageShape`.
pub type VolumesDiskUsage = super::shared::BuildCacheDiskUsageShape;

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

/// Arguments for [`SystemDataUsage_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct SystemDataUsageArgs {
    /// Query parameter: `type` (one per value).
    pub r#type: Vec<String>,
    /// Query parameter: `verbose`.
    pub verbose: Option<String>,
}

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

// -----------------------------------------------------------------------------
// GET /system/df
// -----------------------------------------------------------------------------

/// GET /system/df.
///
/// Takes a client and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request: a `DynNetClient`, or an `ApiClient` carrying the `BodyLimits` the response is read under
/// * `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 = system_data_usage_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn system_data_usage_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &SystemDataUsageArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<SystemDataUsageResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/system/df",);
    let endpoint_url = format!("{}{}", base_url, path);

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

    for value in &args.r#type {
        builder = builder.query("type", Some(value.as_str()));
    }
    builder = builder.query("verbose", args.verbose.as_deref());

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

    super::shared::send_json(client.into(), builder.build()).await
}