diff --git a/utoipa-config/README.md b/utoipa-config/README.md index a40a22f9..ace4f2ab 100644 --- a/utoipa-config/README.md +++ b/utoipa-config/README.md @@ -14,6 +14,12 @@ This crate provides global configuration capabilities for `utoipa`. * `SchemaCollect:All` will collect all schemas from usages including inlined with `inline(T)` * `SchemaCollect::NonInlined` will only collect non inlined schemas from usages. +> [!WARNING] +> The build config will be stored to projects `OUTPUT` directory. It is then read from there via `OUTPUT` environment +> variable which will return **any instance** rust compiler might find at that time (Whatever the `OUTPUT` environment variable points to). +> **Be aware** that sometimes you might face a situation where the config is not aligned with your Rust aliases. +> This might need you to change something on your code before changed config might apply. + ## Install Add dependency declaration to `Cargo.toml`. diff --git a/utoipa-config/src/lib.rs b/utoipa-config/src/lib.rs index d51db30d..f282d91f 100644 --- a/utoipa-config/src/lib.rs +++ b/utoipa-config/src/lib.rs @@ -10,6 +10,16 @@ //! * [`SchemaCollect::All`] will collect all schemas from usages including inlined with `inline(T)` //! * [`SchemaCollect::NonInlined`] will only collect non inlined schemas from usages. //! +//!
+//! +//! Warning!
+//! The build config will be stored to projects `OUTPUT` directory. It is then read from there via `OUTPUT` environment +//! variable which will return **any instance** rust compiler might find at that time (Whatever the `OUTPUT` environment variable points to). +//! **Be aware** that sometimes you might face a situation where the config is not aligned with your Rust aliases. +//! This might need you to change something on your code before changed config might apply. +//! +//!
+//! //! ## Install //! //! Add dependency declaration to `Cargo.toml`.