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

# doc.preview

## Module Functions

### Deletes Preview Password <a name="delete_password"></a>

**API Endpoint**: `DELETE /doc_project/{doc_name}/password`

#### Parameters

| Parameter  | Required | Description | Example                             |
| ---------- | :------: | ----------- | ----------------------------------- |
| `doc_name` |    ✓     |             | `"my-project".to_string()`          |
| `name`     |    ✓     |             | `"My customer preview".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()
    .preview()
    .delete_password(sideko_rest_api::resources::doc::preview::DeletePasswordRequest {
        name: "My customer preview".to_string(),
        doc_name: "my-project".to_string(),
    })
    .await;
```

### List Preview Passwords <a name="list_passwords"></a>

Lists generated passwords for a documentation project preview environment

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

#### 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()
    .preview()
    .list_passwords(sideko_rest_api::resources::doc::preview::ListPasswordsRequest {
        doc_name: "my-project".to_string(),
    })
    .await;
```

#### Response

##### Type

Vec of [DocPreviewPassword](/src/models/doc_preview_password.rs)

##### Example

```rust
vec![DocPreviewPassword {name: "My customer preview".to_string(), password: "asdfj12124inklwgas123".to_string()}]
```

### Create Preview Password <a name="create_password"></a>

Generate a password to grant access to a private preview environment

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

#### Parameters

| Parameter  | Required | Description | Example                             |
| ---------- | :------: | ----------- | ----------------------------------- |
| `doc_name` |    ✓     |             | `"my-project".to_string()`          |
| `name`     |    ✓     |             | `"My customer preview".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()
    .preview()
    .create_password(sideko_rest_api::resources::doc::preview::CreatePasswordRequest {
        name: "My customer preview".to_string(),
        doc_name: "my-project".to_string(),
    })
    .await;
```

#### Response

##### Type

[DocPreviewPassword](/src/models/doc_preview_password.rs)

##### Example

```rust
DocPreviewPassword {name: "My customer preview".to_string(), password: "asdfj12124inklwgas123".to_string()}
```