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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

#[serial_test::serial]
#[tokio::test]
async fn test_delete_204_success_all_params() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client
        .doc()
        .delete(sideko_rest_api::resources::doc::DeleteRequest {
            doc_name: "my-project".to_string(),
        })
        .await;
    println!("{res:?}");
    assert!(res.is_ok());
}
#[serial_test::serial]
#[tokio::test]
async fn test_list_200_success_all_params() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client.doc().list().await;
    println!("{res:?}");
    assert!(res.is_ok());
}
#[serial_test::serial]
#[tokio::test]
async fn test_get_200_success_all_params() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client
        .doc()
        .get(sideko_rest_api::resources::doc::GetRequest {
            doc_name: "my-project".to_string(),
        })
        .await;
    println!("{res:?}");
    assert!(res.is_ok());
}
#[serial_test::serial]
#[tokio::test]
async fn test_check_preview_200_success_all_params() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client
        .doc()
        .check_preview(sideko_rest_api::resources::doc::CheckPreviewRequest {
            doc_name: "my-project".to_string(),
            pathname: Some("%2Freferences%my-api%2Fmy-get-documentation".to_string()),
        })
        .await;
    println!("{res:?}");
    assert!(res.is_ok());
}
#[serial_test::serial]
#[tokio::test]
async fn test_check_preview_200_success_required_only() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client
        .doc()
        .check_preview(sideko_rest_api::resources::doc::CheckPreviewRequest {
            doc_name: "my-project".to_string(),
            ..Default::default()
        })
        .await;
    println!("{res:?}");
    assert!(res.is_ok());
}
#[serial_test::serial]
#[tokio::test]
async fn test_patch_200_success_all_params() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client
        .doc()
        .patch(sideko_rest_api::resources::doc::PatchRequest {
            logos: Some(sideko_rest_api::models::UpdateDocProjectLogos {
                dark: Some("3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()),
                favicon: Some("3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()),
                light: Some("3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()),
            }),
            name: Some("my-company-docs".to_string()),
            settings: Some(sideko_rest_api::models::UpdateDocProjectSettings {
                action_button: Some(sideko_rest_api::models::UpdateDocProjectSettingsActionButton {
                    enabled: Some(true),
                    label: Some("string".to_string()),
                    url: Some("http://www.example.com".to_string()),
                }),
                font: Some(sideko_rest_api::models::DocProjectFont {
                    base_size: 123,
                    family: sideko_rest_api::models::FontFamilyEnum::Inter,
                }),
                metadata: Some(sideko_rest_api::models::UpdateDocProjectSettingsMetadata {
                    description: Some("string".to_string()),
                    llms_txt: Some(true),
                    title: Some("string".to_string()),
                }),
                template: Some(
                    sideko_rest_api::models::DocProjectTemplate::ModernTemplate(sideko_rest_api::models::ModernTemplate {
                        dark: sideko_rest_api::models::ModernTheme {
                            primary: "string".to_string(),
                        },
                        light: sideko_rest_api::models::ModernTheme {
                            primary: "string".to_string(),
                        },
                        type_: sideko_rest_api::models::TemplateTypeModernEnum::Modern,
                    }),
                ),
            }),
            doc_name: "my-project".to_string(),
        })
        .await;
    println!("{res:?}");
    assert!(res.is_ok());
}
#[serial_test::serial]
#[tokio::test]
async fn test_create_201_success_all_params() {
    let mut client = sideko_rest_api::SidekoClient::default()
        .with_api_key_auth("API_KEY")
        .with_cookie_auth("API_KEY")
        .with_environment(sideko_rest_api::Environment::MockServer);
    let res = client
        .doc()
        .create(sideko_rest_api::resources::doc::CreateRequest {
            font: Some(sideko_rest_api::models::DocProjectFont {
                base_size: 123,
                family: sideko_rest_api::models::FontFamilyEnum::Inter,
            }),
            name: "my-company-docs".to_string(),
            template: Some(
                sideko_rest_api::models::DocProjectTemplate::ModernTemplate(sideko_rest_api::models::ModernTemplate {
                    dark: sideko_rest_api::models::ModernTheme {
                        primary: "string".to_string(),
                    },
                    light: sideko_rest_api::models::ModernTheme {
                        primary: "string".to_string(),
                    },
                    type_: sideko_rest_api::models::TemplateTypeModernEnum::Modern,
                }),
            ),
        })
        .await;
    println!("{res:?}");
    assert!(res.is_ok());
}