openai-interface 0.11.0

//! Cancel an upload via `POST /uploads/{upload_id}/cancel`.
//!
//! > ![warn] This module is untested!
//! > If you encounter any issues, please report them on the repository.
//!
//! Cancelling discards all uploaded parts; the returned [`Upload`]
//! carries the `cancelled` status.

use url::Url;

use crate::{
    errors::OapiError,
    rest::post::{Post, PostNoStream},
    uploads::Upload,
};

/// Cancels an in-progress upload session.
#[derive(Debug, Clone, serde::Serialize)]
pub struct CancelUploadRequest<'a> {
    /// The ID of the upload session to cancel, e.g. `upload_...`.
    #[serde(skip)]
    pub upload_id: &'a str,
}

impl Post for CancelUploadRequest<'_> {
    fn is_streaming(&self) -> bool {
        false
    }

    /// Builds the URL for the request.
    ///
    /// `base_url` should be like <https://api.openai.com/v1>
    fn build_url(&self, base_url: &str) -> Result<String, OapiError> {
        let mut url = Url::parse(base_url.trim_end_matches('/')).map_err(OapiError::UrlError)?;
        url.path_segments_mut()
            .map_err(|_| OapiError::UrlCannotBeBase(base_url.to_string()))?
            .push("uploads")
            .push(self.upload_id)
            .push("cancel");
        Ok(url.to_string())
    }
}

impl PostNoStream for CancelUploadRequest<'_> {
    type Response = Upload;
}