tsk-56: Added API docs

tsk-56: Added utoipa Swagger crates
tsk-56: Dependency version brump
2025-08-24 19:02:20 -04:00 · 2025-08-24 15:50:40 -04:00 · 2025-08-24 15:48:39 -04:00
3 changed files with 7 additions and 13 deletions
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -749,7 +749,7 @@ dependencies = [

 [[package]]
 name = "icarus_auth"
-version = "0.5.0"
+version = "0.4.3"
 dependencies = [
 "argon2",
 "axum",
@@ -785,7 +785,7 @@ dependencies = [
 [[package]]
 name = "icarus_models"
 version = "0.5.6"
-source = "git+ssh://git@git.kundeng.us/phoenix/icarus_models.git?tag=v0.5.6#2d6b550ae6721b41ecc3039799f6a5e873869077"
+source = "git+ssh://git@git.kundeng.us/phoenix/icarus_models.git?tag=v0.5.6-58-13b030bbca-111#13b030bbcabeff9c7a7593929db508dee5db6914"
 dependencies = [
 "josekit",
 "rand 0.9.1",
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "icarus_auth"
-version = "0.5.0"
+version = "0.4.3"
 edition = "2024"
 rust-version = "1.88"

@@ -20,7 +20,7 @@ time = { version = "0.3.41", features = ["macros", "serde"] }
 josekit = { version = "0.10.3" }
 utoipa = { version = "5.4.0", features = ["axum_extras"] }
 utoipa-swagger-ui = { version = "9.0.2", features = ["axum"] }
-icarus_models = { git = "ssh://git@git.kundeng.us/phoenix/icarus_models.git", tag = "v0.5.6" }
+icarus_models = { git = "ssh://git@git.kundeng.us/phoenix/icarus_models.git", tag = "v0.5.6-58-13b030bbca-111" }
 icarus_envy = { git = "ssh://git@git.kundeng.us/phoenix/icarus_envy.git", tag = "v0.3.2" }

 [dev-dependencies]
--- a/README.md
+++ b/README.md
@@ -1,12 +1,9 @@
-A auth web API services for the Icarus project.


 # Getting Started
-The easiest way to get started is through docker. This assumes that docker is already installed
-on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't 
-need to be modified. The `SECRET_KEY` variable should be changed since it will be used for token
-generation. The `SECRET_PASSPHASE` should also be changed when in production mode, but make sure
-the respective `passphrase` database table record exists.
+Copy the `.env.sample` file to `.env` and ensure that the variables are populated. This project
+can be used with regular hosting or with docker. For the sake of getting up to speed quickly,
+Docker will be covered. Make sure docker is running and your ssh identity has been loaded.

 Build image
 ```
@@ -27,6 +24,3 @@ Pruning
 ```
 docker system prune -a
 ```
-
-To view the OpenAPI spec, run the project and access `/swagger-ui`. If running through docker,
-the url would be something like `http://localhost:8000/swagger-ui`.
Author	SHA1	Message	Date
phoenix	be053ac0dc	tsk-56: Added API docs All checks were successful Rust Build / Check (pull_request) Successful in 2m3s Details Rust Build / Test Suite (pull_request) Successful in 2m54s Details Rust Build / Rustfmt (pull_request) Successful in 29s Details Rust Build / Clippy (pull_request) Successful in 2m2s Details Rust Build / build (pull_request) Successful in 3m36s Details	2025-08-24 19:02:20 -04:00
phoenix	d4ec3c5d1c	tsk-56: Added utoipa Swagger crates	2025-08-24 15:50:40 -04:00
phoenix	50f517140e	tsk-56: Dependency version brump icarus_models and icarus_envy version bump	2025-08-24 15:48:39 -04:00