feat: support for read-event-type

README.md

@@ -412,6 +412,20 @@ match result {
   Err(err) => // ...
 }
 ```
+
+### Listing a Specific Event Types
+
+To list a specific event type, call the `read_event_type` function. The function returns the detailed event type, which includes the schema:
+
+```rust
+let event_type_name = "io.eventsourcingdb.library.book-acquired";
+let result := client.read_event_type(event_type_name).await;
+match result {
+  Ok(event_type) => // ...
+  Err(err) => // ...
+}
+```
+
 ### Using Testcontainers
 
 Call the `Container::start_default()` function, get a client, and run your test code:

examples/event_types.rs

@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -14,7 +14,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut event_types) => {
             while let Some(Ok(event_type)) = event_types.next().await {
-                println!("{:?}", event_type)
+                println!("{event_type:?}")
             }
         }
     }

examples/listing_subjects.rs

@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -14,7 +14,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut subjects) => {
             while let Some(Ok(subject)) = subjects.next().await {
-                println!("{:?}", subject)
+                println!("{subject:?}")
             }
         }
     }

examples/observing_events.rs

@@ -6,7 +6,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -26,7 +26,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(event)) = stream.next().await {
-                println!("{:?}", event)
+                println!("{event:?}")
             }
         }
     }

examples/ping.rs

@@ -2,7 +2,7 @@ use eventsourcingdb::{client::Client, container::Container};
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);

examples/reading_events.rs

@@ -6,7 +6,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -28,7 +28,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(event)) = stream.next().await {
-                println!("{:?}", event)
+                println!("{event:?}")
             }
         }
     }

examples/registering_event_schema.rs

@@ -3,7 +3,7 @@ use serde_json::json;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);

examples/running_eventql.rs

@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -16,7 +16,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(row)) = stream.next().await {
-                println!("{:?}", row)
+                println!("{row:?}")
             }
         }
     }

examples/verify_api_token.rs

@@ -2,7 +2,7 @@ use eventsourcingdb::{client::Client, container::Container};
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);

examples/write_events.rs

@@ -3,7 +3,7 @@ use serde_json::json;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -21,7 +21,7 @@ async fn main() {
 
     let result = client.write_events(vec![event.clone()], vec![]).await;
     match result {
-        Ok(written_events) => println!("{:?}", written_events),
+        Ok(written_events) => println!("{written_events:?}"),
         Err(err) => panic!("{}", err),
     }
 }

src/client.rs

@@ -3,7 +3,7 @@
 //! To use the client, create it with the base URL and API token of your [EventsourcingDB](https://www.eventsourcingdb.io/) instance.
 //! ```
 //! # tokio_test::block_on(async {
-//! # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+//! # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
 //! let db_url = "http://localhost:3000/";
 //! let api_token = "secrettoken";
 //! # let db_url = container.get_base_url().await.unwrap();
@@ -22,14 +22,15 @@ mod precondition;
 pub mod request_options;
 
 use crate::{
+    client::client_request::ReadEventTypeRequest,
     error::ClientError,
     event::{Event, EventCandidate, ManagementEvent},
+    request_options::EventType,
 };
 use client_request::{
     ClientRequest, ListEventTypesRequest, ListSubjectsRequest, ObserveEventsRequest,
     OneShotRequest, PingRequest, ReadEventsRequest, RegisterEventSchemaRequest,
     RunEventqlQueryRequest, StreamingRequest, VerifyApiTokenRequest, WriteEventsRequest,
-    list_event_types::EventType,
 };
 use futures::Stream;
 pub use precondition::Precondition;
@@ -161,7 +162,7 @@ impl Client {
     ///
     /// ```
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -185,7 +186,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -211,14 +212,57 @@ impl Client {
         Ok(response)
     }
 
+    /// Reads a specific event type from the DB instance.
+    ///
+    /// ```
+    /// use eventsourcingdb::event::EventCandidate;
+    /// use futures::StreamExt;
+    /// # use serde_json::json;
+    /// # tokio_test::block_on(async {
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
+    /// let db_url = "http://localhost:3000/";
+    /// let api_token = "secrettoken";
+    /// # let db_url = container.get_base_url().await.unwrap();
+    /// # let api_token = container.get_api_token();
+    /// let client = eventsourcingdb::client::Client::new(db_url, api_token);
+    /// let event_type = "io.eventsourcingdb.test";
+    /// let schema = json!({
+    ///     "type": "object",
+    ///     "properties": {
+    ///         "id": {
+    ///             "type": "string"
+    ///         },
+    ///         "name": {
+    ///             "type": "string"
+    ///         }
+    ///     },
+    ///     "required": ["id", "name"]
+    /// });
+    /// client.register_event_schema(event_type, &schema).await.expect("Failed to register event types");
+    /// let type_info = client.read_event_type(event_type).await.expect("Failed to read event type");
+    /// println!("Found Type {} with schema {:?}", type_info.name, type_info.schema);
+    /// # })
+    /// ```
+    ///
+    /// # Errors
+    /// This function will return an error if the request fails or if the URL is invalid.
+    pub async fn read_event_type(&self, event_type: &str) -> Result<EventType, ClientError> {
+        let response = self
+            .request_oneshot(ReadEventTypeRequest {
+                event_type: event_type.to_string(),
+            })
+            .await?;
+        Ok(response)
+    }
+
     /// Observe events from the DB instance.
     ///
     /// ```
     /// use eventsourcingdb::event::EventCandidate;
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -261,7 +305,7 @@ impl Client {
     ///
     /// ```
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -285,7 +329,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -327,7 +371,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -346,7 +390,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -380,7 +424,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -408,7 +452,7 @@ impl Client {
     /// use eventsourcingdb::event::EventCandidate;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -447,7 +491,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();

src/client/client_request.rs

@@ -4,6 +4,7 @@ pub mod list_event_types;
 mod list_subjects;
 mod observe_events;
 mod ping;
+mod read_event_type;
 mod read_events;
 mod register_event_schema;
 mod run_eventql_query;
@@ -14,6 +15,7 @@ pub use list_event_types::ListEventTypesRequest;
 pub use list_subjects::ListSubjectsRequest;
 pub use observe_events::ObserveEventsRequest;
 pub use ping::PingRequest;
+pub use read_event_type::ReadEventTypeRequest;
 pub use read_events::ReadEventsRequest;
 pub use register_event_schema::RegisterEventSchemaRequest;
 pub use run_eventql_query::RunEventqlQueryRequest;

src/client/client_request/list_event_types.rs

@@ -1,18 +1,8 @@
+use super::{ClientRequest, StreamingRequest};
 use reqwest::Method;
-use serde::{Deserialize, Serialize};
-use serde_json::Value;
-
-use crate::error::ClientError;
+use serde::Serialize;
 
-use super::{ClientRequest, StreamingRequest};
-#[derive(Deserialize, Debug)]
-#[serde(rename_all = "camelCase")]
-pub struct EventType {
-    #[serde(rename = "eventType")]
-    pub name: String,
-    pub is_phantom: bool,
-    pub schema: Option<Value>,
-}
+use crate::{client::request_options::EventType, error::ClientError};
 
 #[derive(Debug, Clone, Serialize)]
 #[serde(rename_all = "camelCase")]

src/client/client_request/read_event_type.rs

@@ -0,0 +1,28 @@
+use reqwest::Method;
+use serde::Serialize;
+
+use crate::{
+    client::client_request::{ClientRequest, OneShotRequest},
+    error::ClientError,
+    request_options::EventType,
+};
+
+#[derive(Debug, Clone, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ReadEventTypeRequest {
+    #[serde(rename = "eventType")]
+    /// The name of the event type to read
+    pub event_type: String,
+}
+
+impl ClientRequest for ReadEventTypeRequest {
+    const URL_PATH: &'static str = "/api/v1/read-event-type";
+    const METHOD: Method = Method::POST;
+
+    fn body(&self) -> Option<Result<impl Serialize, ClientError>> {
+        Some(Ok(self))
+    }
+}
+impl OneShotRequest for ReadEventTypeRequest {
+    type Response = EventType;
+}