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

# lint

## Module Functions

### Lint OpenAPI <a name="run"></a>

**API Endpoint**: `POST /lint`

#### Parameters

| Parameter     | Required | Description | Example                                                  |
| ------------- | :------: | ----------- | -------------------------------------------------------- |
| `api_name`    |    ✗     |             | `"my-project".to_string()`                               |
| `api_version` |    ✗     |             | `ApiVersion::VersionTypeEnum(VersionTypeEnum::Latest)`   |
| `openapi`     |    ✗     |             | `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
    .lint()
    .run(sideko_rest_api::resources::lint::RunRequest {
        openapi: Some(
            sideko_rest_api::UploadFile::from_path("uploads/openapi.yaml").unwrap(),
        ),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[LintReport](/src/models/lint_report.rs)

##### Example

```rust
LintReport {results: vec![LintResult {category: "string".to_string(), how_to_fix: "string".to_string(), location: LintLocation {end_column: 123, end_line: 123, path: "string".to_string(), start_column: 123, start_line: 123}, message: "string".to_string(), rule: "string".to_string(), severity: LintSeverityEnum::Error}], summary: LintSummary {errors: 123, infos: 123, warns: 123}}
```