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

# sdk.config

## Module Functions

### Initialize SDK Configuration <a name="init"></a>

Creates a sdk config with default configurations for the api/api version

**API Endpoint**: `POST /sdk/config/init`

#### Parameters

| Parameter                  | Required | Description                                      | Example                                                     |
| -------------------------- | :------: | ------------------------------------------------ | ----------------------------------------------------------- |
| `api_name`                 |    ✓     |                                                  | `"my-project".to_string()`                                  |
| `api_version`              |    ✗     |                                                  | `ApiVersion::VersionTypeEnum(VersionTypeEnum::Latest)`      |
| `default_module_structure` |    ✗     |                                                  | `SdkModuleStructureEnum::Flat`                              |
| `llm_coding_assistant`     |    ✗     | LLM coding assistants to include rules files for | `vec![InitSdkConfigLlmCodingAssistantItemEnum::ClaudeCode]` |

#### 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()
    .config()
    .init(sideko_rest_api::resources::sdk::config::InitRequest {
        api_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```

### Sync SDK Configuration <a name="sync"></a>

Updates provided config with missing default configurations for the api version

**API Endpoint**: `POST /sdk/config/sync`

#### Parameters

| Parameter     | Required | Description                                                                                                                                     | Example                                                  |
| ------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `config`      |    ✓     |                                                                                                                                                 | `UploadFile::from_path("uploads/config.yaml").unwrap()`  |
| `api_version` |    ✗     |                                                                                                                                                 | `ApiVersion::VersionTypeEnum(VersionTypeEnum::Latest)`   |
| `openapi`     |    ✗     | Use api_version in typical use. If this field is supplied, the configuration sync will match the spec rather than any API that lives in Sideko. | `UploadFile::from_path("uploads/openapi.yaml").unwrap()` |

#### 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()
    .config()
    .sync(sideko_rest_api::resources::sdk::config::SyncRequest {
        config: sideko_rest_api::UploadFile::from_path("uploads/config.yaml")
            .unwrap(),
        openapi: Some(
            sideko_rest_api::UploadFile::from_path("uploads/openapi.yaml").unwrap(),
        ),
        ..Default::default()
    })
    .await;
```