harbor-api 2.0.0

These APIs provide services for manipulating Harbor project.
Documentation
/*
 * Harbor API
 *
 * These APIs provide services for manipulating Harbor project.
 *
 * The version of the OpenAPI document: 2.0
 * 
 * Generated by: https://openapi-generator.tech
 */


use reqwest;
use serde::{Deserialize, Serialize, de::Error as _};
use crate::{apis::ResponseContent, models};
use super::{Error, configuration, ContentType};

/// struct for passing parameters to the method [`get_report_log`]
#[derive(Clone, Debug)]
pub struct GetReportLogParams {
    /// The name of the project
    pub project_name: String,
    /// The name of the repository. If it contains slash, encode it twice over with URL encoding. e.g. a/b -> a%2Fb -> a%252Fb
    pub repository_name: String,
    /// The reference of the artifact, can be digest or tag
    pub reference: String,
    /// The report id to get the log
    pub report_id: String,
    /// An unique ID for the request
    pub x_request_id: Option<String>
}

/// struct for passing parameters to the method [`scan_artifact`]
#[derive(Clone, Debug)]
pub struct ScanArtifactParams {
    /// The name of the project
    pub project_name: String,
    /// The name of the repository. If it contains slash, encode it twice over with URL encoding. e.g. a/b -> a%2Fb -> a%252Fb
    pub repository_name: String,
    /// The reference of the artifact, can be digest or tag
    pub reference: String,
    /// An unique ID for the request
    pub x_request_id: Option<String>,
    pub scan_type: Option<models::HarborScanType>
}

/// struct for passing parameters to the method [`stop_scan_artifact`]
#[derive(Clone, Debug)]
pub struct StopScanArtifactParams {
    /// The name of the project
    pub project_name: String,
    /// The name of the repository. If it contains slash, encode it twice over with URL encoding. e.g. a/b -> a%2Fb -> a%252Fb
    pub repository_name: String,
    /// The reference of the artifact, can be digest or tag
    pub reference: String,
    /// The scan type: Vulnerabilities, SBOM
    pub scan_type: models::HarborScanType,
    /// An unique ID for the request
    pub x_request_id: Option<String>
}


/// struct for typed errors of method [`get_report_log`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum GetReportLogError {
    Status400(models::Errors),
    Status401(models::Errors),
    Status403(models::Errors),
    Status404(models::Errors),
    Status500(models::Errors),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`scan_artifact`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ScanArtifactError {
    Status400(models::Errors),
    Status401(models::Errors),
    Status403(models::Errors),
    Status404(models::Errors),
    Status422(models::Errors),
    Status500(models::Errors),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`stop_scan_artifact`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum StopScanArtifactError {
    Status400(models::Errors),
    Status401(models::Errors),
    Status403(models::Errors),
    Status404(models::Errors),
    Status422(models::Errors),
    Status500(models::Errors),
    UnknownValue(serde_json::Value),
}


/// Get the log of the scan report
pub async fn get_report_log(configuration: &configuration::Configuration, params: GetReportLogParams) -> Result<String, Error<GetReportLogError>> {

    let uri_str = format!("{}/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/log", configuration.base_path, project_name=crate::apis::urlencode(params.project_name), repository_name=crate::apis::urlencode(params.repository_name), reference=crate::apis::urlencode(params.reference), report_id=crate::apis::urlencode(params.report_id));
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(param_value) = params.x_request_id {
        req_builder = req_builder.header("X-Request-Id", param_value.to_string());
    }
    if let Some(ref auth_conf) = configuration.basic_auth {
        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Ok(content),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `String`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<GetReportLogError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Scan the specified artifact
pub async fn scan_artifact(configuration: &configuration::Configuration, params: ScanArtifactParams) -> Result<(), Error<ScanArtifactError>> {

    let uri_str = format!("{}/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan", configuration.base_path, project_name=crate::apis::urlencode(params.project_name), repository_name=crate::apis::urlencode(params.repository_name), reference=crate::apis::urlencode(params.reference));
    let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);

    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(param_value) = params.x_request_id {
        req_builder = req_builder.header("X-Request-Id", param_value.to_string());
    }
    if let Some(ref auth_conf) = configuration.basic_auth {
        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
    };
    req_builder = req_builder.json(&params.scan_type);

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();

    if !status.is_client_error() && !status.is_server_error() {
        Ok(())
    } else {
        let content = resp.text().await?;
        let entity: Option<ScanArtifactError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Cancelling a scan job for a particular artifact
pub async fn stop_scan_artifact(configuration: &configuration::Configuration, params: StopScanArtifactParams) -> Result<(), Error<StopScanArtifactError>> {

    let uri_str = format!("{}/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/stop", configuration.base_path, project_name=crate::apis::urlencode(params.project_name), repository_name=crate::apis::urlencode(params.repository_name), reference=crate::apis::urlencode(params.reference));
    let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);

    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(param_value) = params.x_request_id {
        req_builder = req_builder.header("X-Request-Id", param_value.to_string());
    }
    if let Some(ref auth_conf) = configuration.basic_auth {
        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
    };
    req_builder = req_builder.json(&params.scan_type);

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();

    if !status.is_client_error() && !status.is_server_error() {
        Ok(())
    } else {
        let content = resp.text().await?;
        let entity: Option<StopScanArtifactError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}