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

# sdk.metadata

## Module Functions

### Update the metadata of an SDK <a name="update"></a>

Updates the SDK metadata, like the remote repository URL

**API Endpoint**: `PATCH /sdk/{sdk_id}`

#### Parameters

| Parameter  | Required | Description                      | Example                                              |
| ---------- | :------: | -------------------------------- | ---------------------------------------------------- |
| `sdk_id`   |    ✓     | The unique identifier of the SDK | `"8b6b6a52-2ea4-4644-bc1f-233a2dd81b9b".to_string()` |
| `released` |    ✗     |                                  | `true`                                               |
| `repo_url` |    ✗     | Remote git repository URL        | `"https://github.com/sideko-inc/sideko".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
    .sdk()
    .metadata()
    .update(sideko_rest_api::resources::sdk::metadata::UpdateRequest {
        repo_url: sideko_rest_api::Patch::new(
            "https://github.com/sideko-inc/sideko".to_string(),
        ),
        sdk_id: "8b6b6a52-2ea4-4644-bc1f-233a2dd81b9b".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[SdkGeneration](/src/models/sdk_generation.rs)

##### Example

```rust
SdkGeneration {api_version_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), created_at: "1970-01-01T00:00:00".to_string(), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), language: SdkLanguageEnum::Csharp, name: "my_sdk_py".to_string(), released: true, repo_url: Some("https://github.com/sideko-inc/sideko".to_string()), successful: true, version: "0.1.0".to_string()}
```