foundation_deployment_docker 0.1.3

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

#![cfg(feature = "docker_commit")]
#![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
// =============================================================================

/// `ContainerConfig` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ContainerConfig {
    /// `ArgsEscaped` property.
    #[serde(rename = "ArgsEscaped")]
    pub args_escaped: Option<bool>,
    /// `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>>,
    /// `Domainname` property.
    #[serde(rename = "Domainname")]
    pub domainname: Option<String>,
    /// `Entrypoint` property.
    #[serde(rename = "Entrypoint")]
    pub entrypoint: Option<Vec<String>>,
    /// `Env` property.
    #[serde(rename = "Env")]
    pub env: Option<Vec<String>>,
    /// `ExposedPorts` property.
    #[serde(rename = "ExposedPorts")]
    pub exposed_ports: Option<serde_json::Value>,
    /// `Healthcheck` property.
    #[serde(rename = "Healthcheck")]
    pub healthcheck: Option<HealthConfig>,
    /// `Hostname` property.
    #[serde(rename = "Hostname")]
    pub hostname: Option<String>,
    /// `Image` property.
    #[serde(rename = "Image")]
    pub image: Option<String>,
    /// `Labels` property.
    #[serde(rename = "Labels")]
    pub labels: Option<serde_json::Value>,
    /// `NetworkDisabled` property.
    #[serde(rename = "NetworkDisabled")]
    pub network_disabled: Option<bool>,
    /// `OnBuild` property.
    #[serde(rename = "OnBuild")]
    pub on_build: Option<Vec<String>>,
    /// `OpenStdin` property.
    #[serde(rename = "OpenStdin")]
    pub open_stdin: Option<bool>,
    /// `Shell` property.
    #[serde(rename = "Shell")]
    pub shell: Option<Vec<String>>,
    /// `StdinOnce` property.
    #[serde(rename = "StdinOnce")]
    pub stdin_once: Option<bool>,
    /// `StopSignal` property.
    #[serde(rename = "StopSignal")]
    pub stop_signal: Option<String>,
    /// `StopTimeout` property.
    #[serde(rename = "StopTimeout")]
    pub stop_timeout: Option<i64>,
    /// `Tty` property.
    #[serde(rename = "Tty")]
    pub tty: Option<bool>,
    /// `User` property.
    #[serde(rename = "User")]
    pub user: Option<String>,
    /// `Volumes` property.
    #[serde(rename = "Volumes")]
    pub volumes: Option<serde_json::Value>,
    /// `WorkingDir` property.
    #[serde(rename = "WorkingDir")]
    pub working_dir: Option<String>,
}

/// `HealthConfig` type.
///
/// Same shape as `super::shared::HealthConfigShape`.
pub type HealthConfig = super::shared::HealthConfigShape;

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

/// Arguments for [`ImageCommit_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct ImageCommitArgs {
    /// Query parameter: `container`.
    pub container: Option<String>,
    /// Query parameter: `repo`.
    pub repo: Option<String>,
    /// Query parameter: `tag`.
    pub tag: Option<String>,
    /// Query parameter: `comment`.
    pub comment: Option<String>,
    /// Query parameter: `author`.
    pub author: Option<String>,
    /// Query parameter: `pause`.
    pub pause: Option<String>,
    /// Query parameter: `changes`.
    pub changes: Option<String>,
    /// Request body.
    pub body: ContainerConfig,
}

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

// -----------------------------------------------------------------------------
// POST /commit
// -----------------------------------------------------------------------------

/// POST /commit.
///
/// 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 = image_commit_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn image_commit_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ImageCommitArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<IDResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/commit",);
    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.query("container", args.container.as_deref());
    builder = builder.query("repo", args.repo.as_deref());
    builder = builder.query("tag", args.tag.as_deref());
    builder = builder.query("comment", args.comment.as_deref());
    builder = builder.query("author", args.author.as_deref());
    builder = builder.query("pause", args.pause.as_deref());
    builder = builder.query("changes", args.changes.as_deref());

    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
}