komga_sdk/apis/
tasks_api.rs

1/*
2 * Komga API
3 *
4 * Komga REST API.  ## Reference  Check the API reference: - on the [Komga website](https://komga.org/docs/openapi/komga-api) - on any running Komga instance at `/swagger-ui.html` - on [GitHub](https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json)  ## Authentication  Most endpoints require authentication. Authentication is done using either: - Basic Authentication - Passing an API Key in the `X-API-Key` header  ## Sessions  Upon successful authentication, a session is created, and can be reused.  - By default, a `KOMGA-SESSION` cookie is set via `Set-Cookie` response header. This works well for browsers and clients that can handle cookies. - If you specify a header `X-Auth-Token` during authentication, the session ID will be returned via this same header. You can then pass that header again for subsequent requests to reuse the session.  If you need to set the session cookie later on, you can call `/api/v1/login/set-cookie` with `X-Auth-Token`. The response will contain the `Set-Cookie` header.  ## Remember Me  During authentication, if a request parameter `remember-me` is passed and set to `true`, the server will also return a `komga-remember-me` cookie. This cookie will be used to login automatically even if the session has expired.  ## Logout  You can explicitly logout an existing session by calling `/api/logout`. This would return a `204`.  ## Deprecation  API endpoints marked as deprecated will be removed in the next major version.
5 *
6 * The version of the OpenAPI document: 1.23.4
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12use reqwest;
13use serde::{Deserialize, Serialize, de::Error as _};
14use crate::{apis::ResponseContent, models};
15use super::{Error, configuration, ContentType};
16
17
18/// struct for typed errors of method [`empty_task_queue`]
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(untagged)]
21pub enum EmptyTaskQueueError {
22    Status400(models::ValidationErrorResponse),
23    UnknownValue(serde_json::Value),
24}
25
26
27/// Cancel all tasks queued  Required role: **ADMIN**
28pub async fn empty_task_queue(configuration: &configuration::Configuration, ) -> Result<i32, Error<EmptyTaskQueueError>> {
29
30    let uri_str = format!("{}/api/v1/tasks", configuration.base_path);
31    let mut req_builder = configuration.client.request(reqwest::Method::DELETE, &uri_str);
32
33    if let Some(ref user_agent) = configuration.user_agent {
34        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
35    }
36    if let Some(ref apikey) = configuration.api_key {
37        let key = apikey.key.clone();
38        let value = match apikey.prefix {
39            Some(ref prefix) => format!("{} {}", prefix, key),
40            None => key,
41        };
42        req_builder = req_builder.header("X-API-Key", value);
43    };
44    if let Some(ref auth_conf) = configuration.basic_auth {
45        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
46    };
47
48    let req = req_builder.build()?;
49    let resp = configuration.client.execute(req).await?;
50
51    let status = resp.status();
52    let content_type = resp
53        .headers()
54        .get("content-type")
55        .and_then(|v| v.to_str().ok())
56        .unwrap_or("application/octet-stream");
57    let content_type = super::ContentType::from(content_type);
58
59    if !status.is_client_error() && !status.is_server_error() {
60        let content = resp.text().await?;
61        match content_type {
62            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
63            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `i32`"))),
64            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `i32`")))),
65        }
66    } else {
67        let content = resp.text().await?;
68        let entity: Option<EmptyTaskQueueError> = serde_json::from_str(&content).ok();
69        Err(Error::ResponseError(ResponseContent { status, content, entity }))
70    }
71}
72
komga_sdk/apis/tasks_api.rs

komga_sdk/apis/
tasks_api.rs
