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

# doc.version

## Module Functions

### List Documentation Project Versions <a name="list"></a>

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

#### Parameters

| Parameter  | Required | Description | Example                    |
| ---------- | :------: | ----------- | -------------------------- |
| `doc_name` |    ✓     |             | `"my-project".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()
    .list(sideko_rest_api::resources::doc::version::ListRequest {
        doc_name: "my-project".to_string(),
    })
    .await;
```

#### Response

##### Type

Vec of [DocVersion](/src/models/doc_version.rs)

##### Example

```rust
vec![DocVersion {created_at: "1970-01-01T00:00:00".to_string(), doc_project_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), status: DocVersionStatusEnum::Draft, version: 1}]
```

### Get Documentation Project Version <a name="get"></a>

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

#### Parameters

| Parameter     | Required | Description | Example                                                            |
| ------------- | :------: | ----------- | ------------------------------------------------------------------ |
| `doc_name`    |    ✓     |             | `"my-project".to_string()`                                         |
| `doc_version` |    ✓     |             | `IdOrInt::Str("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()
    .get(sideko_rest_api::resources::doc::version::GetRequest {
        doc_name: "my-project".to_string(),
        doc_version: sideko_rest_api::models::IdOrInt::Str(
            "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ),
    })
    .await;
```

#### Response

##### Type

[DocVersion](/src/models/doc_version.rs)

##### Example

```rust
DocVersion {created_at: "1970-01-01T00:00:00".to_string(), doc_project_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), status: DocVersionStatusEnum::Draft, version: 1}
```

## Submodules

- [api_link](api_link/README.md) - api_link
- [dropdown](dropdown/README.md) - dropdown
- [external_link](external_link/README.md) - external_link
- [page](page/README.md) - page
- [sidebar](sidebar/README.md) - sidebar
- [space](space/README.md) - space
- [title](title/README.md) - title
- [topbar](topbar/README.md) - topbar