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

# doc.version.page

## Module Functions

### Get Page <a name="get"></a>

**API Endpoint**: `GET /doc_project/{doc_name}/version/{doc_version}/page/{page_id}`

#### Parameters

| Parameter     | Required | Description | Example                                                            |
| ------------- | :------: | ----------- | ------------------------------------------------------------------ |
| `doc_name`    |    ✓     |             | `"my-project".to_string()`                                         |
| `doc_version` |    ✓     |             | `IdOrInt::Str("3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string())` |
| `page_id`     |    ✓     |             | `"3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()`               |

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .doc()
    .version()
    .page()
    .get(sideko_rest_api::resources::doc::version::page::GetRequest {
        doc_name: "my-project".to_string(),
        doc_version: sideko_rest_api::models::IdOrInt::Str(
            "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ),
        page_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
    })
    .await;
```

#### Response

##### Type

[Page](/src/models/page.rs)

##### Example

```rust
Page {ask_ai: true, created_at: "1970-01-01T00:00:00".to_string(), icon: Some("House".to_string()), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), label: "string".to_string(), slug: "string".to_string(), table_of_contents: true, type_: ComponentTypePageEnum::Page, mdx: "string".to_string()}
```

### Update Page <a name="patch"></a>

**API Endpoint**: `PATCH /doc_project/{doc_name}/version/{doc_version}/page/{page_id}`

#### Parameters

| Parameter           | Required | Description | Example                                                            |
| ------------------- | :------: | ----------- | ------------------------------------------------------------------ |
| `doc_name`          |    ✓     |             | `"my-project".to_string()`                                         |
| `doc_version`       |    ✓     |             | `IdOrInt::Str("3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string())` |
| `page_id`           |    ✓     |             | `"3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()`               |
| `ask_ai`            |    ✗     |             | `true`                                                             |
| `content`           |    ✗     |             | `"string".to_string()`                                             |
| `icon`              |    ✗     |             | `"House".to_string()`                                              |
| `label`             |    ✗     |             | `"string".to_string()`                                             |
| `slug`              |    ✗     |             | `"string".to_string()`                                             |
| `table_of_contents` |    ✗     |             | `true`                                                             |

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .doc()
    .version()
    .page()
    .patch(sideko_rest_api::resources::doc::version::page::PatchRequest {
        doc_name: "my-project".to_string(),
        doc_version: sideko_rest_api::models::IdOrInt::Str(
            "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ),
        page_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[Page](/src/models/page.rs)

##### Example

```rust
Page {ask_ai: true, created_at: "1970-01-01T00:00:00".to_string(), icon: Some("House".to_string()), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), label: "string".to_string(), slug: "string".to_string(), table_of_contents: true, type_: ComponentTypePageEnum::Page, mdx: "string".to_string()}
```