foundation_deployment_docker 0.1.3

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

#![cfg(feature = "docker_exec")]
#![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};

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

use super::shared::ApiResponse;

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

/// `ContainerExecRequest` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ContainerExecRequest {
    /// `AttachStderr` property.
    #[serde(rename = "AttachStderr")]
    pub attach_stderr: Option<bool>,
    /// `AttachStdin` property.
    #[serde(rename = "AttachStdin")]
    pub attach_stdin: Option<bool>,
    /// `AttachStdout` property.
    #[serde(rename = "AttachStdout")]
    pub attach_stdout: Option<bool>,
    /// `Cmd` property.
    #[serde(rename = "Cmd")]
    pub cmd: Option<Vec<String>>,
    /// `ConsoleSize` property.
    #[serde(rename = "ConsoleSize")]
    pub console_size: Option<Vec<i64>>,
    /// `DetachKeys` property.
    #[serde(rename = "DetachKeys")]
    pub detach_keys: Option<String>,
    /// `Env` property.
    #[serde(rename = "Env")]
    pub env: Option<Vec<String>>,
    /// `Privileged` property.
    #[serde(rename = "Privileged")]
    pub privileged: Option<bool>,
    /// `Tty` property.
    #[serde(rename = "Tty")]
    pub tty: Option<bool>,
    /// `User` property.
    #[serde(rename = "User")]
    pub user: Option<String>,
    /// `WorkingDir` property.
    #[serde(rename = "WorkingDir")]
    pub working_dir: Option<String>,
}

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

/// Arguments for [`ContainerExec_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct ContainerExecArgs {
    /// Path parameter: `id`.
    pub id: String,
    /// Request body.
    pub body: ContainerExecRequest,
}

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

// -----------------------------------------------------------------------------
// POST /containers/{id}/exec
// -----------------------------------------------------------------------------

/// POST /containers/{id}/exec.
///
/// 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 = container_exec_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn container_exec_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ContainerExecArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<IDResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/containers/{}/exec", args.id,);
    let endpoint_url = format!("{}{}", base_url, path);

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

    builder = builder
        .body_json(&args.body)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

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

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