browsr-types 0.4.0

Shared data models and schemas for Browsr browser automation flows.
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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Response from the /v1/search endpoint.
#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct SearchResponse {
    pub success: bool,
    pub total: usize,
    pub data: Vec<SearchResultEntry>,
}

/// A single search result entry from /v1/search.
#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct SearchResultEntry {
    pub url: String,
    pub title: String,
    pub description: String,
    pub position: usize,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub content: Option<serde_json::Value>,
}

#[derive(Serialize, Deserialize, Debug, Default, JsonSchema, Clone)]
pub struct SearchOptions {
    pub query: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<usize>,
}