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

# sdk.doc

## Module Functions

### Get SDK Documentation <a name="create"></a>

Gets documentation for a specific SDK including usage examples

**API Endpoint**: `POST /sdk/{sdk_id}/doc`

#### Parameters

| Parameter        | Required | Description                                           | Example                          |
| ---------------- | :------: | ----------------------------------------------------- | -------------------------------- |
| `sdk_id`         |    ✓     | The SDK ID to get documentation for                   | `"h1jasdf123".to_string()`       |
| `modules_filter` |    ✗     | Optional array of module names to filter the response | `vec!["user.admin".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()
    .doc()
    .create(sideko_rest_api::resources::sdk::doc::CreateRequest {
        modules_filter: Some(vec!["user.admin".to_string()]),
        sdk_id: "h1jasdf123".to_string(),
    })
    .await;
```

#### Response

##### Type

[SdkDocResponse](/src/models/sdk_doc_response.rs)

##### Example

```rust
SdkDocResponse {client_init: "def x".to_string(), modules: vec![ModuleDoc {content: "## Markdown SDK Docs".to_string(), module: "user.admin".to_string()}]}
```