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

# cli

## Module Functions

### Check for CLI Updates <a name="check_updates"></a>

Checks if a given CLI has updates or notices

**API Endpoint**: `GET /cli/updates/{cli_version}`

#### Parameters

| Parameter     | Required | Description           | Example               |
| ------------- | :------: | --------------------- | --------------------- |
| `cli_version` |    ✓     | semver of running cli | `"0.1.0".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
    .cli()
    .check_updates(sideko_rest_api::resources::cli::CheckUpdatesRequest {
        cli_version: "0.1.0".to_string(),
    })
    .await;
```

#### Response

##### Type

Vec of [CliUpdate](/src/models/cli_update.rs)

##### Example

```rust
vec![CliUpdate {message: "Requires update to 0.2.0 for security patch".to_string(), severity: CliUpdateSeverityEnum::Info}]
```