tsk-57: Adding utoipia crate for documentation

Reviewed-on: #50

.gitea/workflows/tag_release.yaml

@@ -1,9 +1,9 @@
 name: Release Tagging
 
 on:
-  push:
+  pull_request:
     branches:
-      - devel
+      - main
 
 jobs:
   release:

.gitea/workflows/workflow.yaml

@@ -4,11 +4,9 @@ on:
   push:
     branches:
       - main 
-      - devel
   pull_request:
     branches:
       - main 
-      - devel
 
 jobs:
   check:

Cargo.lock

@@ -142,7 +142,7 @@ checksum = "5971ac85611da7067dbfcabef3c70ebb5606018acd9e2a3903a0da507521e0d5"
 
 [[package]]
 name = "icarus_models"
-version = "0.5.4"
+version = "0.5.5"
 dependencies = [
  "josekit",
  "rand",
@@ -150,6 +150,7 @@ dependencies = [
  "serde_json",
  "tempfile",
  "time",
+ "utoipa",
  "uuid",
 ]
 
@@ -161,6 +162,7 @@ checksum = "fe4cd85333e22411419a0bcae1297d25e58c9443848b11dc6a86fefe8c78a661"
 dependencies = [
  "equivalent",
  "hashbrown",
+ "serde",
 ]
 
 [[package]]
@@ -527,6 +529,29 @@ version = "1.0.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
 
+[[package]]
+name = "utoipa"
+version = "5.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2fcc29c80c21c31608227e0912b2d7fddba57ad76b606890627ba8ee7964e993"
+dependencies = [
+ "indexmap",
+ "serde",
+ "serde_json",
+ "utoipa-gen",
+]
+
+[[package]]
+name = "utoipa-gen"
+version = "5.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6d79d08d92ab8af4c5e8a6da20c47ae3f61a0f1dabc1997cdf2d082b757ca08b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "uuid"
 version = "1.17.0"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_models"
-version = "0.5.4"
+version = "0.5.5"
 edition = "2024"
 rust-version = "1.88"
 description = "models used for the icarus project"
@@ -13,6 +13,7 @@ rand = { version = "0.9.1" }
 time = { version = "0.3.41", features = ["formatting", "macros", "parsing", "serde"] }
 uuid = { version = "1.17.0", features = ["v4", "serde"] }
 josekit = { version = "0.10.3" }
+utoipa = { version = "5.4.0" }
 
 [dev-dependencies]
 tempfile = { version = "3.20.0" }

src/token.rs

@@ -80,6 +80,7 @@ pub struct TokenResource {
     pub message: String,
     pub issuer: String,
     pub audiences: Vec<String>,
+    pub id: uuid::Uuid,
 }
 
 pub const TOKEN_TYPE: &str = "JWT";
@@ -99,6 +100,14 @@ pub fn create_token(
     payload.set_subject(message);
     payload.set_issuer(issuer);
     payload.set_audience(audiences.clone());
+    if !token_resource.id.is_nil() {
+        match payload.set_claim("id", Some(serde_json::json!(token_resource.id))) {
+            Ok(_) => {}
+            Err(err) => {
+                return Err(err);
+            }
+        }
+    }
     match get_issued() {
         Ok(issued) => {
             let expire = issued + duration;
@@ -121,6 +130,19 @@ pub fn create_token(
 mod tests {
     use super::*;
 
+    fn test_key() -> String {
+        String::from("c3092urmc2219ix320i40m293ic29IM09IN0u879Y8B98YB8yb86TN7B55R4yv4RCVU6Bi8YO8U")
+    }
+
+    fn test_resource() -> TokenResource {
+        TokenResource {
+            issuer: String::from("icarus_auth_test"),
+            message: String::from("Authorization"),
+            audiences: vec![String::from("icarus_test")],
+            id: uuid::Uuid::nil(),
+        }
+    }
+
     #[test]
     fn test_token_scope_check() {
         let mut token = Token::default();
@@ -138,14 +160,29 @@ mod tests {
 
     #[test]
     fn test_token_creation() {
-        let key = String::from(
+        let key = test_key();
-            "c3092urmc2219ix320i40m293ic29IM09IN0u879Y8B98YB8yb86TN7B55R4yv4RCVU6Bi8YO8U",
+        let test_token_resource = test_resource();
-        );
+        let token_expiration_duration = time::Duration::hours(2);
-        let test_token_resource = TokenResource {
+
-            issuer: String::from("icarus_auth_test"),
+        match create_token(&key, &test_token_resource, token_expiration_duration) {
-            message: String::from("Authorization"),
+            Ok((token, expire_duration)) => {
-            audiences: vec![String::from("icarus_test")],
+                assert_eq!(false, token.is_empty(), "Error: Token is empty");
-        };
+                assert!(
+                    expire_duration > 0,
+                    "Token expire duration is invalid {expire_duration:?}"
+                );
+            }
+            Err(err) => {
+                assert!(false, "Error: {err:?}");
+            }
+        }
+    }
+
+    #[test]
+    fn test_token_creation_with_id() {
+        let key = test_key();
+        let mut test_token_resource = test_resource();
+        test_token_resource.id = uuid::Uuid::new_v4();
         let token_expiration_duration = time::Duration::hours(2);
 
         match create_token(&key, &test_token_resource, token_expiration_duration) {