foundation_deployment_docker 0.1.3

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

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

/// `SwarmJoinRequest` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct SwarmJoinRequest {
    /// `AdvertiseAddr` property.
    #[serde(rename = "AdvertiseAddr")]
    pub advertise_addr: Option<String>,
    /// `DataPathAddr` property.
    #[serde(rename = "DataPathAddr")]
    pub data_path_addr: Option<String>,
    /// `JoinToken` property.
    #[serde(rename = "JoinToken")]
    pub join_token: String,
    /// `ListenAddr` property.
    #[serde(rename = "ListenAddr")]
    pub listen_addr: String,
    /// `RemoteAddrs` property.
    #[serde(rename = "RemoteAddrs")]
    pub remote_addrs: Vec<String>,
}

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

/// Arguments for [`SwarmJoin_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct SwarmJoinArgs {
    /// Request body.
    pub body: SwarmJoinRequest,
}

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

// -----------------------------------------------------------------------------
// POST /swarm/join
// -----------------------------------------------------------------------------

/// POST /swarm/join.
///
/// 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 = swarm_join_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn swarm_join_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &SwarmJoinArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<()>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/swarm/join",);
    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_without_body(client.into(), builder.build()).await
}