opendatasoft-explore-api 0.1.0

HTTP client for Opendatasoft Explore API v2
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

//! Schema for Opendatasoft Explore API v2

use chrono::{DateTime, Utc};
use serde_derive::Deserialize;
use serde_derive::Serialize;
use serde_json::Value as JsonValue;

/*  -------------------------------------------------------------
    links
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Link {
    pub href: String,
    pub rel: String,
}

/*  -------------------------------------------------------------
    dataset
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Dataset {
    pub links: Vec<Link>,
    pub dataset: DatasetProperties,
}

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct DatasetProperties {
    pub dataset_id: String,
    pub dataset_uid: String,
    pub attachments: Vec<AttachmentProperties>,
    pub has_records: bool,
    pub data_visible: bool,
    /// A map of available features for a dataset, with the fields they apply to.
    pub features: Vec<String>,
    pub metas: JsonValue,
    pub fields: Vec<DatasetField>,
    #[serde(rename = "additionalProperties", default, skip_serializing_if = "Option::is_none")]
    pub additional_properties: Option<JsonValue>,
}

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct DatasetField {
    pub name: String,
    pub label: String,
    #[serde(rename = "type")]
    pub field_type: String,
    pub annotations: JsonValue,
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/*  -------------------------------------------------------------
    results_dataset
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct DatasetsCollection {
    pub total_count: usize,
    pub links: Vec<Link>,
    pub datasets: Vec<Dataset>,
}

/*  -------------------------------------------------------------
    facet_value_enumeration
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct FacetValueEnumeration {
    pub name: String,
    pub count: usize,
    pub value: String,
    pub state: String,
}

/*  -------------------------------------------------------------
    facet_enumeration
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct FacetEnumeration {
    pub name: String,
    pub facets: Vec<FacetValueEnumeration>,
}

/*  -------------------------------------------------------------
    aggregation
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Aggregation {
    pub count: usize,
    pub cou_name_en: String,
}

/*  -------------------------------------------------------------
    record
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Record {
    pub record: RecordProperties,
    pub links: Vec<Link>,
}

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct RecordProperties {
    pub id: String,
    pub timestamp: DateTime<Utc>,
    pub size: usize,
    pub fields: JsonValue,
}

/*  -------------------------------------------------------------
    results
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct Results {
    pub total_count: usize,
    pub links: Vec<Link>,
    pub records: Vec<ResultsRecord>,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ResultsRecord {
    Aggregation(Aggregation),
    Record(Record),
}

/*  -------------------------------------------------------------
    attachment
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Attachment {
    pub href: String,
    pub metas: AttachmentProperties,
}

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct AttachmentProperties {
    #[serde(rename = "mime-type", default, skip_serializing_if = "Option::is_none")]
    pub mime_type: Option<String>,
    pub title: String,
    pub url: String,
    pub id: String,
}

/*  -------------------------------------------------------------
    Response to /catalog/datasets/{dataset_id}/attachments
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct AttachmentCollection {
    pub links: Vec<Link>,
    pub attachments: Vec<Attachment>,
}

/*  -------------------------------------------------------------
    Response to /catalog/facets
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -    */

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct FacetsCollection {
    pub links: Vec<Link>,
    pub facets: Vec<FacetEnumeration>,
}