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

# doc.deployment

## Module Functions

### List Documentation Deployments <a name="list"></a>

Retrieves all deployments for a doc project

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

#### Parameters

| Parameter  | Required | Description | Example                         |
| ---------- | :------: | ----------- | ------------------------------- |
| `doc_name` |    ✓     |             | `"my-project".to_string()`      |
| `limit`    |    ✗     |             | `123`                           |
| `target`   |    ✗     |             | `DeploymentTargetEnum::Preview` |

#### 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()
    .deployment()
    .list(sideko_rest_api::resources::doc::deployment::ListRequest {
        doc_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

Vec of [Deployment](/src/models/deployment.rs)

##### Example

```rust
vec![Deployment {created_at: "1970-01-01T00:00:00".to_string(), current_preview: true, current_prod: true, doc_version: 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}, id: "string".to_string(), metadata: std::collections::HashMap::<String, serde_json::Value>::new(), status: DeploymentStatusEnum::Building, target: DeploymentTargetEnum::Preview}]
```

### Get Documentation Deployment <a name="get"></a>

Retrieves single deployment

**API Endpoint**: `GET /doc_project/{doc_name}/deployment/{deployment_id}`

#### Parameters

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

#### Response

##### Type

[Deployment](/src/models/deployment.rs)

##### Example

```rust
Deployment {created_at: "1970-01-01T00:00:00".to_string(), current_preview: true, current_prod: true, doc_version: 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}, id: "string".to_string(), metadata: std::collections::HashMap::<String, serde_json::Value>::new(), status: DeploymentStatusEnum::Building, target: DeploymentTargetEnum::Preview}
```

### Trigger Documentation Deployment <a name="trigger"></a>

Deploys a new generated version of documentation with guides & linked APIs

**API Endpoint**: `POST /doc_project/{doc_name}/deployment`

#### Parameters

| Parameter        | Required | Description | Example                                              |
| ---------------- | :------: | ----------- | ---------------------------------------------------- |
| `doc_name`       |    ✓     |             | `"my-project".to_string()`                           |
| `target`         |    ✓     |             | `DeploymentTargetEnum::Preview`                      |
| `doc_version_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()
    .deployment()
    .trigger(sideko_rest_api::resources::doc::deployment::TriggerRequest {
        target: sideko_rest_api::models::DeploymentTargetEnum::Preview,
        doc_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[Deployment](/src/models/deployment.rs)

##### Example

```rust
Deployment {created_at: "1970-01-01T00:00:00".to_string(), current_preview: true, current_prod: true, doc_version: 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}, id: "string".to_string(), metadata: std::collections::HashMap::<String, serde_json::Value>::new(), status: DeploymentStatusEnum::Building, target: DeploymentTargetEnum::Preview}
```