
### delete <a name="delete"></a>
Delete a specific Documentation Project



**API Endpoint**: `DELETE /doc_project/{doc_name}`

#### 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()
    .delete(sideko_rest_api::resources::doc::DeleteRequest {
        doc_name: "my-project".to_string(),
    })
    .await;
```

### list <a name="list"></a>
List Documentation Projects



**API Endpoint**: `GET /doc_project`

#### 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().list().await;
```

### get <a name="get"></a>
Get a specific Documentation Project



**API Endpoint**: `GET /doc_project/{doc_name}`

#### 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()
    .get(sideko_rest_api::resources::doc::GetRequest {
        doc_name: "my-project".to_string(),
    })
    .await;
```

### check_preview <a name="check_preview"></a>
A simple check to see if the requesting user has access to the preview doc project



**API Endpoint**: `GET /doc_project/{doc_name}/preview`

#### 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()
    .check_preview(sideko_rest_api::resources::doc::CheckPreviewRequest {
        doc_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```

### patch <a name="patch"></a>
Update an existing Documentation Project



**API Endpoint**: `PATCH /doc_project/{doc_name}`

#### 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()
    .patch(sideko_rest_api::resources::doc::PatchRequest {
        doc_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```

### create <a name="create"></a>
Create a new Documentation Project



**API Endpoint**: `POST /doc_project`

#### 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()
    .create(sideko_rest_api::resources::doc::CreateRequest {
        name: "my-company-docs".to_string(),
    })
    .await;
```
