aw-models: Add schemars support

Author: johan-bjareholt

Cargo.lock

@@ -15,6 +15,6 @@ path = "src/lib.rs"
 [dependencies]
 chrono = { version = "0.4", features = ["serde"] }
 log = "0.4"
-serde = "1.0"
+serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-serde_derive = "1.0"
+schemars = { version = "0.7", features = ["chrono"] }

aw-models/Cargo.toml

@@ -1,12 +1,14 @@
 use chrono::DateTime;
 use chrono::Utc;
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
 use serde_json::map::Map;
 use serde_json::value::Value;
 use std::collections::HashMap;
 
 use crate::Event;
 
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
 pub struct Bucket {
     #[serde(skip)]
     pub bid: Option<i64>,
@@ -24,7 +26,7 @@ pub struct Bucket {
     pub last_updated: Option<DateTime<Utc>>, // TODO: Should probably be moved into metadata field
 }
 
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
 pub struct BucketMetadata {
     #[serde(default)]
     pub start: Option<DateTime<Utc>>,
@@ -40,7 +42,7 @@ impl Default for BucketMetadata {
     }
 }
 
-#[derive(Clone, Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, JsonSchema, Clone)]
 pub struct BucketsExport {
     pub buckets: HashMap<String, Bucket>,
 }

aw-models/src/bucket.rs

@@ -1,3 +1,5 @@
+use serde::{Deserialize, Serialize};
+
 // Max duration of a i64 nanosecond is 2562047.7880152157 hours
 // ((2**64)/2)/1000000000/60/60
 

aw-models/src/duration.rs

@@ -1,17 +1,31 @@
 use chrono::DateTime;
 use chrono::Duration;
 use chrono::Utc;
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
 use serde_json::Map;
 use serde_json::Value;
 
 use crate::duration::DurationSerialization;
 
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
 pub struct Event {
+    /// An unique id for this event.
+    /// Will be assigned once the event has reached the servers datastore.
+    ///
+    /// **WARNING:** If you set the ID and insert the event to the server it will replace the previous
+    /// event with that ID. Only do this if you are completely sure what you are doing.
     pub id: Option<i64>,
+    /// An rfc3339 timestamp which represents the start of the event
     pub timestamp: DateTime<Utc>,
+    /// Duration of the event as a floating point number in seconds.
+    /// Appended to the timestamp it can represent the end of the event
+    /// Maximum precision is nanoseconds.
     #[serde(with = "DurationSerialization", default = "default_duration")]
+    #[schemars(with = "f64")]
     pub duration: Duration,
+    /// Can contain any arbitrary JSON data that represents the value of the event.
+    /// All events in a bucket should follow the format of it's respective bucket-type.
     pub data: Map<String, Value>,
 }
 
@@ -47,6 +61,8 @@ fn default_duration() -> Duration {
 
 #[test]
 fn test_event() {
+    use serde_json::json;
+
     let e = Event {
         id: None,
         timestamp: Utc::now(),

aw-models/src/event.rs

@@ -0,0 +1,10 @@
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, JsonSchema)]
+pub struct Info {
+    pub hostname: String,
+    pub version: String,
+    pub testing: bool,
+    pub device_id: String,
+}

aw-models/src/info.rs

@@ -1,11 +1,13 @@
 use chrono::{DateTime, Utc};
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
 
-#[derive(Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, JsonSchema)]
 pub struct Key {
     pub key: String,
 }
 
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
+#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug, PartialEq)]
 pub struct KeyValue {
     pub key: String,
     pub value: String,

aw-models/src/key_value.rs

@@ -1,9 +1,3 @@
-extern crate serde;
-#[cfg_attr(test, macro_use)] // Only macro use for tests
-extern crate serde_json;
-#[macro_use]
-extern crate serde_derive;
-extern crate chrono;
 #[macro_use]
 extern crate log;
 
@@ -12,7 +6,7 @@ extern crate log;
 #[macro_use]
 macro_rules! json_map {
     { $( $key:literal : $value:expr),* } => {{
-        use serde_json::Value;
+        use serde_json::{Value};
         use serde_json::map::Map;
         #[allow(unused_mut)]
         let mut map : Map<String, Value> = Map::new();
@@ -26,6 +20,7 @@ macro_rules! json_map {
 mod bucket;
 mod duration;
 mod event;
+mod info;
 mod key_value;
 mod query;
 mod timeinterval;
@@ -34,6 +29,7 @@ pub use self::bucket::Bucket;
 pub use self::bucket::BucketMetadata;
 pub use self::bucket::BucketsExport;
 pub use self::event::Event;
+pub use self::info::Info;
 pub use self::key_value::Key;
 pub use self::key_value::KeyValue;
 pub use self::query::Query;

aw-models/src/lib.rs

@@ -1,5 +1,8 @@
+use serde::Deserialize;
+
 use crate::TimeInterval;
 
+// TODO Implement serialize once TimeInterval has implemented it
 #[derive(Deserialize, Clone, Debug)]
 pub struct Query {
     //#[serde(with = "DurationSerialization")]

aw-models/src/query.rs

@@ -6,6 +6,8 @@ use chrono::DateTime;
 use chrono::Duration;
 use chrono::Utc;
 
+// TODO: Implement serialize
+
 #[derive(Clone, Debug)]
 pub struct TimeInterval {
     start: DateTime<Utc>,