feat(repo): Added open-api documentation (#428)

* feat(repo): Added rest endpoints Postman documentation

* feat(repo): Added open-api documentation

Author: 0xterminator

Cargo.lock

@@ -30,6 +30,7 @@ serde_json.workspace = true
 thiserror.workspace = true
 tokio.workspace = true
 tracing.workspace = true
+utoipa = { version = "5.3.1", features = ["actix_extras"] }
 
 [dev-dependencies]
 pretty_assertions.workspace = true

crates/core/Cargo.toml

@@ -46,6 +46,34 @@ pub enum MessagePayload {
     Utxo(Arc<Utxo>),
 }
 
+impl utoipa::ToSchema for MessagePayload {
+    fn name() -> std::borrow::Cow<'static, str> {
+        std::borrow::Cow::Borrowed("MessagePayload")
+    }
+}
+
+impl utoipa::PartialSchema for MessagePayload {
+    fn schema() -> utoipa::openapi::RefOr<utoipa::openapi::schema::Schema> {
+        // Create a oneOf schema
+        let mut one_of = utoipa::openapi::schema::OneOf::new();
+
+        // Add references to all possible payload types
+        // We can use the schema() method directly from each type
+        one_of.items.push(Block::schema());
+        one_of.items.push(Input::schema());
+        one_of.items.push(Output::schema());
+        one_of.items.push(Transaction::schema());
+        one_of.items.push(Receipt::schema());
+        one_of.items.push(Utxo::schema());
+
+        // Build the oneOf schema with a description
+        let schema = utoipa::openapi::schema::Schema::OneOf(one_of);
+
+        // Return the schema wrapped in RefOr::T
+        utoipa::openapi::RefOr::T(schema)
+    }
+}
+
 impl MessagePayload {
     pub fn new(
         subject_id: &str,
@@ -133,7 +161,7 @@ pub enum StreamResponseError {
     RecordPacket(#[from] RecordPacketError),
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)]
 pub struct StreamResponse {
     pub version: String,
     #[serde(rename = "type")]

crates/core/src/server/responses.rs

@@ -30,6 +30,7 @@ serde_with = "3.12.0"
 sqlx.workspace = true
 thiserror.workspace = true
 tokio.workspace = true
+utoipa = { version = "5.3.1", features = ["actix_extras"] }
 
 [dev-dependencies]
 pretty_assertions.workspace = true

crates/domains/Cargo.toml

@@ -12,7 +12,16 @@ use serde::{Deserialize, Serialize};
 use super::{types::*, BlockDbItem};
 use crate::queryable::{HasPagination, QueryPagination, Queryable};
 
-#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq)]
+#[derive(
+    Debug,
+    Default,
+    Clone,
+    Serialize,
+    Deserialize,
+    PartialEq,
+    Eq,
+    utoipa::ToSchema,
+)]
 pub enum TimeRange {
     #[serde(rename = "1h")]
     OneHour,
@@ -121,7 +130,16 @@ pub enum Blocks {
     BlockPropagationMs,
 }
 
-#[derive(Debug, Clone, Default, Serialize, Deserialize, Eq, PartialEq)]
+#[derive(
+    Debug,
+    Clone,
+    Default,
+    Serialize,
+    Deserialize,
+    Eq,
+    PartialEq,
+    utoipa::ToSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct BlocksQuery {
     pub producer: Option<Address>,