sideko_rest_api 0.9.2

Rust API Client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

#[derive(Debug)]
pub struct DeploymentClient<'a> {
    base_client: &'a mut crate::core::base_client::BaseClient,
}
impl<'a> DeploymentClient<'a> {
    pub(crate) fn _new(
        base_client: &'a mut crate::core::base_client::BaseClient,
    ) -> Self {
        Self { base_client }
    }
    /// List Documentation Deployments
    ///
    /// Retrieves all deployments for a doc project
    ///
    /// GET /doc_project/{doc_name}/deployment
    pub async fn list(
        &mut self,
        request: super::request_types::ListRequest,
    ) -> crate::SdkResult<Vec<crate::models::Deployment>> {
        let url = self
            .base_client
            .build_url(
                &format!(
                    "/doc_project/{}/deployment", crate
                    ::core::params::format_string_param(& request.doc_name)
                ),
                None,
            );
        let mut builder = reqwest::Client::default().get(&url);
        let mut queries = crate::core::params::QueryParams::default();
        queries
            .add_option(
                "limit",
                &request.limit,
                crate::core::params::QueryStyle::Form,
                true,
            );
        queries
            .add_option(
                "target",
                &request.target,
                crate::core::params::QueryStyle::Form,
                true,
            );
        builder = builder.query(&queries.params);
        builder = builder.header("x-sideko-sdk-language", "rust");
        builder = self
            .base_client
            .apply_auths_to_builder(builder, &["ApiKeyAuth", "CookieAuth"])
            .await?;
        let mut response = builder.send().await?;
        response = self.base_client.error_for_status("GET", response).await?;
        crate::core::response::process_json::<Vec<crate::models::Deployment>>(response)
            .await
    }
    /// Get Documentation Deployment
    ///
    /// Retrieves single deployment
    ///
    /// GET /doc_project/{doc_name}/deployment/{deployment_id}
    pub async fn get(
        &mut self,
        request: super::request_types::GetRequest,
    ) -> crate::SdkResult<crate::models::Deployment> {
        let url = self
            .base_client
            .build_url(
                &format!(
                    "/doc_project/{}/deployment/{}", crate
                    ::core::params::format_string_param(& request.doc_name), crate
                    ::core::params::format_string_param(& request.deployment_id)
                ),
                None,
            );
        let mut builder = reqwest::Client::default().get(&url);
        builder = builder.header("x-sideko-sdk-language", "rust");
        builder = self
            .base_client
            .apply_auths_to_builder(builder, &["ApiKeyAuth", "CookieAuth"])
            .await?;
        let mut response = builder.send().await?;
        response = self.base_client.error_for_status("GET", response).await?;
        crate::core::response::process_json::<crate::models::Deployment>(response).await
    }
    /// Trigger Documentation Deployment
    ///
    /// Deploys a new generated version of documentation with guides & linked APIs
    ///
    /// POST /doc_project/{doc_name}/deployment
    pub async fn trigger(
        &mut self,
        request: super::request_types::TriggerRequest,
    ) -> crate::SdkResult<crate::models::Deployment> {
        let url = self
            .base_client
            .build_url(
                &format!(
                    "/doc_project/{}/deployment", crate
                    ::core::params::format_string_param(& request.doc_name)
                ),
                None,
            );
        let mut builder = reqwest::Client::default().post(&url);
        builder = builder.header("x-sideko-sdk-language", "rust");
        builder = builder.header("content-type", "application/json");
        builder = builder
            .json(
                &crate::models::NewDeployment {
                    doc_version_id: request.doc_version_id,
                    target: request.target,
                },
            );
        builder = self
            .base_client
            .apply_auths_to_builder(builder, &["ApiKeyAuth", "CookieAuth"])
            .await?;
        let mut response = builder.send().await?;
        response = self.base_client.error_for_status("POST", response).await?;
        crate::core::response::process_json::<crate::models::Deployment>(response).await
    }
}