utoipa init commit

Author: parmesant

Cargo.lock

@@ -22,6 +22,8 @@ arrow-flight = { version = "52.1.0", features = [ "tls" ] }
 tonic = {version = "0.11.0", features = ["tls", "transport", "gzip", "zstd"] }
 tonic-web = "0.11.0"
 tower-http = { version = "0.4.4", features = ["cors"] }
+utoipa = {version = "4.2.3", features = ["actix_extras","chrono","openapi_extensions","preserve_order"]}
+utoipa-swagger-ui = {version = "7.1.0", features = ["actix-web"]}
 
 ### actix dependencies
 actix-web-httpauth = "0.8"

server/Cargo.toml

@@ -25,6 +25,7 @@ use datafusion::arrow::datatypes::Schema;
 use regex::Regex;
 use serde::{Deserialize, Serialize};
 use std::fmt;
+use utoipa::ToSchema;
 
 pub mod parser;
 pub mod rule;
@@ -39,7 +40,7 @@ use crate::{storage, utils};
 pub use self::rule::Rule;
 use self::target::Target;
 
-#[derive(Default, Debug, serde::Serialize, serde::Deserialize)]
+#[derive(Default, Debug, serde::Serialize, serde::Deserialize, ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct Alerts {
     pub version: AlertVerison,

server/src/alerts/mod.rs

@@ -48,6 +48,18 @@ use std::path::PathBuf;
 ///         "path": store_endpoint
 ///     }
 /// }
+#[utoipa::path(
+    get,
+    tag = "about",
+    context_path = "/api/v1",
+    path = "/about",
+    responses(
+        (status = 200, body = Value)
+    ),
+    security(
+        ("basic_auth" = [])
+    )
+)]
 pub async fn about() -> Json<serde_json::Value> {
     let meta = StorageMetadata::global();
 

server/src/handlers/http/about.rs

@@ -26,8 +26,9 @@ use itertools::Itertools;
 use reqwest::Response;
 use serde::{Deserialize, Serialize};
 use url::Url;
+use utoipa::ToSchema;
 
-#[derive(Debug, Default, Serialize, Deserialize)]
+#[derive(Debug, Default, Serialize, Deserialize, ToSchema)]
 pub struct QueriedStats {
     pub stream: String,
     pub time: DateTime<Utc>,
@@ -81,7 +82,7 @@ impl ClusterInfo {
     }
 }
 
-#[derive(Debug, Default, Serialize, Deserialize)]
+#[derive(Debug, Default, Serialize, Deserialize, ToSchema)]
 pub struct IngestionStats {
     pub count: u64,
     pub size: String,
@@ -114,7 +115,7 @@ impl IngestionStats {
     }
 }
 
-#[derive(Debug, Default, Serialize, Deserialize)]
+#[derive(Debug, Default, Serialize, Deserialize, ToSchema)]
 pub struct StorageStats {
     pub size: String,
     pub format: String,

server/src/handlers/http/cluster/utils.rs

@@ -21,10 +21,32 @@ use actix_web::HttpResponse;
 
 use crate::option::CONFIG;
 
+#[utoipa::path(
+    get,
+    tag = "health check",
+    context_path = "/api/v1",
+    path = "/liveness",
+    responses(
+        (status = 200, description = "The server is live.")
+    )
+)]
 pub async fn liveness() -> HttpResponse {
     HttpResponse::new(StatusCode::OK)
 }
 
+#[utoipa::path(
+    get,
+    tag = "health check",
+    context_path = "/api/v1",
+    path = "/readiness",
+    responses(
+        (status = 200, description = "The object store is live."),
+        (status = 503, description = "Service Unavailable.")
+    ),
+    security(
+        ("basic_auth" = [])
+    )
+)]
 pub async fn readiness() -> HttpResponse {
     if CONFIG.storage().get_object_store().check().await.is_ok() {
         return HttpResponse::new(StatusCode::OK);

server/src/handlers/http/health_check.rs

@@ -174,6 +174,27 @@ async fn flatten_and_push_logs(
 // Handler for POST /api/v1/logstream/{logstream}
 // only ingests events into the specified logstream
 // fails if the logstream does not exist
+#[utoipa::path(
+    post,
+    tag = "logstream",
+    context_path = "/api/v1",
+    path = "/logstream/{logstream}",
+    params(
+        ("logstream" = String, Path, description = "Name of stream")
+    ),
+    request_body(
+        content = Vec<Object>, description = "Log events"
+    ),
+    responses(
+        (status = 200, description = "Ingested event", body = Vec<String>),
+        (status = 400, description = "Error", body = HttpResponse),
+        (status = 500, description = "Failure", body = HttpResponse),
+        (status = 404, description = "Stream not found", body = HttpResponse),
+    ),
+    security(
+        ("basic_auth" = [])
+    )
+)]
 pub async fn post_event(req: HttpRequest, body: Bytes) -> Result<HttpResponse, PostError> {
     let stream_name: String = req.match_info().get("logstream").unwrap().parse().unwrap();
     if stream_name.eq(INTERNAL_STREAM_NAME) {