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

# doc.version.external_link

## Module Functions

### Update External Link <a name="patch"></a>

**API Endpoint**: `PATCH /doc_project/{doc_name}/version/{doc_version}/external_link/{external_link_id}`

#### Parameters

| Parameter          | Required | Description | Example                                                            |
| ------------------ | :------: | ----------- | ------------------------------------------------------------------ |
| `doc_name`         |    ✓     |             | `"my-project".to_string()`                                         |
| `doc_version`      |    ✓     |             | `IdOrInt::Str("3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string())` |
| `external_link_id` |    ✓     |             | `"3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()`               |
| `href`             |    ✗     |             | `"http://www.example.com".to_string()`                             |
| `icon`             |    ✗     |             | `"House".to_string()`                                              |
| `id`               |    ✗     |             | `"3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()`               |
| `label`            |    ✗     |             | `"string".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()
    .version()
    .external_link()
    .patch(sideko_rest_api::resources::doc::version::external_link::PatchRequest {
        doc_name: "my-project".to_string(),
        doc_version: sideko_rest_api::models::IdOrInt::Str(
            "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ),
        external_link_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[ExternalLinkComponent](/src/models/external_link_component.rs)

##### Example

```rust
ExternalLinkComponent {created_at: "1970-01-01T00:00:00".to_string(), href: "http://www.example.com".to_string(), icon: Some("House".to_string()), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), label: "string".to_string(), type_: ComponentTypeExternalLinkEnum::ExternalLink}
```