feat(wip): skeleton for new API endpoints

Cargo.toml

@@ -38,6 +38,8 @@ tower = "0.4"
 tracing = "0.1"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 axum = "0.7.4"
+chrono = { version = "0.4.34", default-features = false, features = ["std", "clock", "serde"] }
+log = { version = "0.4.21", features = ["serde"] }
 
 [build-dependencies]
 tonic-build = { version = "0.11", features = ["prost"] }

src/features/admin/api_version/interface.rs

@@ -0,0 +1,21 @@
+//! The public interface of this endpoint
+
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+
+/// The request for getting the API Version, this is empty because
+/// Any query will return the given response (authentication happens
+// at a higher layer).
+#[derive(Copy, Clone, Deserialize, Serialize)]
+pub struct ApiVersionRequest;
+
+#[derive(Clone, Serialize, Deserialize)]
+/// The response returning the API Version information.
+pub struct ApiVersionResponse {
+    /// The current API Version
+    version: String,
+    /// The current commit sha
+    commit: String,
+    /// The timestamp this build was done at
+    build: DateTime<Utc>,
+}

src/features/admin/api_version/mod.rs

@@ -0,0 +1,3 @@
+//! Contains API endpoints for getting build target information for the currently running service
+
+pub mod interface;

src/features/admin/log_level/get/interface.rs

@@ -0,0 +1,17 @@
+//! The public interface for getting the log level
+
+use log::Level;
+use serde::{Deserialize, Serialize};
+
+/// The request for getting the log level, empty because
+/// the request is empty.
+#[derive(Copy, Clone, Deserialize, Serialize)]
+pub struct GetLogLevelRequest;
+
+/// The response for getting the leg level, [`tracing`] doesn't implement
+/// [`Serialize`] so we use the one from [`log`] as an intermediary.
+#[derive(Copy, Clone, Deserialize, Serialize)]
+pub struct GetLogLevelResponse {
+    /// The log level we currently are at
+    level: Level,
+}

src/features/admin/log_level/get/mod.rs

@@ -0,0 +1,3 @@
+//! The interface for setting the current log level
+
+mod interface;

src/features/admin/log_level/mod.rs

@@ -0,0 +1,4 @@
+//! Contains API endpoints for manipulating the log level
+
+pub mod get;
+pub mod set;

src/features/admin/log_level/set/interface.rs

@@ -0,0 +1,16 @@
+//! The public interface for defining setting the log level
+
+use log::Level;
+use serde::{Deserialize, Serialize};
+
+/// The request for setting the log level
+#[derive(Copy, Clone, Serialize, Deserialize)]
+pub struct SetLogLevelRequest {
+    /// The current log level, [`tracing`] doesn't implement [`serde`] so
+    // we convert between the two internally.
+    level: Level,
+}
+
+/// The response for setting the log level, essentially nothing but an Ack
+#[derive(Copy, Clone, Serialize, Deserialize)]
+pub struct SetLogLevelResponse;

src/features/admin/log_level/set/mod.rs

@@ -0,0 +1,3 @@
+//! The endpoint for getting the current log level
+
+mod interface;

src/features/admin/mod.rs

@@ -0,0 +1,4 @@
+//! Contains API endpoints for administrative features
+
+mod api_version;
+mod log_level;

src/features/mod.rs

@@ -1,5 +1,6 @@
 //! Contains various feature implementations for the ratings backend.
 
+pub mod admin;
 pub mod chart;
 pub mod common;
 pub mod pb;