Implement omit_default

Author: owjs3901

.changepacks/changepack_log_sBCzXuxu_PPwqRXNIWHS6.json

@@ -0,0 +1 @@
+{"changes":{"Cargo.toml":"Patch"},"note":"Add omit_default to schema_type!","date":"2026-02-18T16:50:22.753492900Z"}

README.md

@@ -363,6 +363,52 @@ schema_type!(UserDTO from User, rename_all = "camelCase");
 // Available: "camelCase", "snake_case", "PascalCase", "SCREAMING_SNAKE_CASE", etc.
 ```
 
+### Omit Fields with Database Defaults (`omit_default`)
+
+Automatically omit fields that have database-level defaults — perfect for create DTOs where the database handles `id`, `created_at`, etc.:
+
+```rust
+#[derive(DeriveEntityModel)]
+#[sea_orm(table_name = "posts")]
+pub struct Model {
+    #[sea_orm(primary_key)]             // ← has default (auto-increment)
+    pub id: i32,
+    pub title: String,
+    pub content: String,
+    #[sea_orm(default_value = "NOW()")]  // ← has default (SQL function)
+    pub created_at: DateTimeWithTimeZone,
+}
+
+// Omits `id` (primary_key) and `created_at` (default_value) automatically
+schema_type!(CreatePostRequest from crate::models::post::Model, omit_default);
+// Generated struct only has: title, content
+```
+
+`omit_default` detects fields with:
+- `#[sea_orm(primary_key)]` — auto-increment / generated IDs
+- `#[sea_orm(default_value = "...")]` — SQL defaults like `NOW()`, `gen_random_uuid()`, literals
+
+Can be combined with other parameters:
+
+```rust
+// omit_default + add extra fields
+schema_type!(CreateItemRequest from Model, omit_default, add = [("tags": Vec<String>)]);
+```
+
+### Database Defaults in OpenAPI
+
+Fields with database defaults automatically get `default` values in the generated OpenAPI schema:
+
+| SeaORM Attribute | OpenAPI Default |
+|-----------------|-----------------|
+| `primary_key` (Uuid) | `"00000000-0000-0000-0000-000000000000"` |
+| `primary_key` (i32/i64) | `0` |
+| `default_value = "NOW()"` | `"1970-01-01T00:00:00+00:00"` |
+| `default_value = "gen_random_uuid()"` | `"00000000-0000-0000-0000-000000000000"` |
+| `default_value = "true"` | `true` (literal passthrough) |
+
+> **Note:** `required` is determined solely by nullability (`Option<T>`). Fields with defaults are still `required` unless they are `Option<T>`.
+
 ### SeaORM Integration
 
 `schema_type!` has first-class support for SeaORM models with relations:
@@ -434,6 +480,7 @@ When `multipart` is enabled:
 | `rename_all` | Serde rename strategy: `rename_all = "camelCase"` |
 | `ignore` | Skip Schema derive (bare keyword, no value) |
 | `multipart` | Derive `TryFromMultipart` instead of serde (bare keyword) |
+| `omit_default` | Auto-omit fields with DB defaults: `primary_key`, `default_value` (bare keyword) |
 
 ---
 
@@ -547,6 +594,12 @@ This automatically:
 | `Vec<T>` | `array` with items |
 | `Option<T>` | nullable T |
 | `HashMap<K, V>` | `object` with additionalProperties |
+| `BTreeSet<T>`, `HashSet<T>` | `array` with `uniqueItems: true` |
+| `Uuid` | `string` with `format: uuid` |
+| `Decimal` | `string` with `format: decimal` |
+| `NaiveDate` | `string` with `format: date` |
+| `NaiveTime` | `string` with `format: time` |
+| `DateTime`, `DateTimeWithTimeZone` | `string` with `format: date-time` |
 | `FieldData<NamedTempFile>` | `string` with `format: binary` |
 | Custom struct | `$ref` to components/schemas |
 

SKILL.md

@@ -39,8 +39,14 @@ pub struct User { id: u32, name: String }
 | `f32`, `f64` | `number` | |
 | `bool` | `boolean` | |
 | `Vec<T>` | `array` + items | |
+| `BTreeSet<T>`, `HashSet<T>` | `array` + items + `uniqueItems: true` | Set types |
 | `Option<T>` | T (nullable context) | Parent marks as optional |
 | `HashMap<K,V>` | `object` + additionalProperties | |
+| `Uuid` | `string` + `format: uuid` | |
+| `Decimal` | `string` + `format: decimal` | |
+| `NaiveDate` | `string` + `format: date` | |
+| `NaiveTime` | `string` + `format: time` | |
+| `DateTime`, `DateTimeWithTimeZone` | `string` + `format: date-time` | |
 | `FieldData<NamedTempFile>` | `string` + `format: binary` | File upload field |
 | `()` | empty response | 204 No Content |
 | Custom struct | `$ref` | Must derive Schema |
@@ -112,7 +118,7 @@ pub struct UserResponse {
     #[serde(rename = "fullName")]  // ✅ Respected
     name: String,        // → "fullName" in JSON Schema
 
-    #[serde(default)]    // ✅ Marks as optional in schema
+    #[serde(default)]    // ✅ Recognized (does NOT affect `required` — only Option<T> does)
     bio: Option<String>,
 
     #[serde(skip)]       // ✅ Excluded from schema
@@ -188,6 +194,7 @@ npx @apidevtools/swagger-cli validate openapi.json
 **Primary Parameters (USE THESE):**
 - `pick = [...]` - Allowlist: include ONLY these fields
 - `omit = [...]` - Denylist: exclude these fields
+- `omit_default` - Auto-omit fields with DB defaults (primary_key, default_value)
 
 **Advanced Parameters (USE SPARINGLY):**
 - `partial` - For PATCH endpoints only
@@ -232,6 +239,12 @@ schema_type!(UserPatch from crate::models::user::Model, partial);
 // Partial updates (specific fields only)
 schema_type!(UserPatch from crate::models::user::Model, partial = ["name", "email"]);
 
+// Auto-omit fields with DB defaults (primary_key, default_value = "...")
+schema_type!(CreatePostRequest from crate::models::post::Model, omit_default);
+
+// Combine omit_default with add
+schema_type!(CreateItemRequest from crate::models::item::Model, omit_default, add = [("tags": Vec<String>)]);
+
 // Custom serde rename strategy
 schema_type!(UserSnakeCase from crate::models::user::Model, rename_all = "snake_case");
 
@@ -322,6 +335,7 @@ Json(model.into())  // Easy conversion!
 |-----------|-------------|---------|
 | `pick` | Include only these fields | `pick = ["name", "email"]` |
 | `omit` | Exclude these fields | `omit = ["password"]` |
+| `omit_default` | Auto-omit fields with DB defaults | `omit_default` (bare keyword) |
 
 **Situational (Use When Needed):**
 
@@ -379,6 +393,10 @@ vespera::schema_type!(Schema from Model, name = "MemoSchema");
 
 **Circular Reference Handling:** Automatically detected and handled by inlining fields.
 
+**Database Defaults in OpenAPI:** Fields with `#[sea_orm(default_value = "...")]` or `#[sea_orm(primary_key)]` automatically get `default` values in the generated OpenAPI schema. SQL functions like `NOW()` and `gen_random_uuid()` are mapped to type-appropriate defaults.
+
+**Required Logic:** `required` is determined **solely by nullability** (`Option<T>`). Fields with `#[serde(default)]` or `#[serde(skip_serializing_if)]` are still `required` unless they are `Option<T>`.
+
 ### Complete Example
 
 ```rust
@@ -477,6 +495,7 @@ tempfile = "3"                 # For NamedTempFile file uploads
 ```rust
 // ✅ RECOMMENDED PATTERNS
 schema_type!(CreateUserRequest from crate::models::user::Model, pick = ["name", "email"]);
+schema_type!(CreatePostRequest from crate::models::post::Model, omit_default);
 schema_type!(UserResponse from crate::models::user::Model, omit = ["password_hash"]);
 schema_type!(UserListItem from crate::models::user::Model, pick = ["id", "name"]);
 

crates/vespera_macro/src/schema_macro/input.rs

@@ -3,9 +3,10 @@
 //! Defines input structures for `schema!` and `schema_type!` macros.
 
 use syn::{
-    Ident, LitStr, Token, Type, bracketed, parenthesized,
+    bracketed, parenthesized,
     parse::{Parse, ParseStream},
     punctuated::Punctuated,
+    Ident, LitStr, Token, Type,
 };
 
 /// Input for the schema! macro
@@ -90,6 +91,7 @@ impl Parse for SchemaInput {
 /// Or:     `schema_type!(NewTypeName from SourceType, ignore)` - skip Schema derive
 /// Or:     `schema_type!(NewTypeName from SourceType, name = "CustomName")` - custom `OpenAPI` name
 /// Or:     `schema_type!(NewTypeName from SourceType, rename_all = "camelCase")` - serde `rename_all`
+#[allow(clippy::struct_excessive_bools)]
 pub struct SchemaTypeInput {
     /// The new type name to generate
     pub new_type: Ident,
@@ -123,6 +125,9 @@ pub struct SchemaTypeInput {
     /// Whether to generate a multipart/form-data struct (derives `TryFromMultipart` instead of serde)
     /// Use `multipart` bare keyword to set this to true.
     pub multipart: bool,
+    /// Whether to omit fields that have database defaults (sea_orm `default_value` or `primary_key`).
+    /// Use `omit_default` bare keyword to set this to true.
+    pub omit_default: bool,
 }
 
 /// Mode for the `partial` keyword in `schema_type`!
@@ -204,6 +209,7 @@ impl Parse for SchemaTypeInput {
         let mut schema_name = None;
         let mut rename_all = None;
         let mut multipart = false;
+        let mut omit_default = false;
 
         // Parse optional parameters
         while input.peek(Token![,]) {
@@ -293,11 +299,15 @@ impl Parse for SchemaTypeInput {
                     // bare `multipart` - derive TryFromMultipart instead of serde
                     multipart = true;
                 }
+                "omit_default" => {
+                    // bare `omit_default` - omit fields with database defaults
+                    omit_default = true;
+                }
                 _ => {
                     return Err(syn::Error::new(
                         ident.span(),
                         format!(
-                            "unknown parameter: `{ident_str}`. Expected `omit`, `pick`, `rename`, `add`, `clone`, `partial`, `ignore`, `name`, `rename_all`, or `multipart`"
+                            "unknown parameter: `{ident_str}`. Expected `omit`, `pick`, `rename`, `add`, `clone`, `partial`, `ignore`, `name`, `rename_all`, `multipart`, or `omit_default`"
                         ),
                     ));
                 }
@@ -325,6 +335,7 @@ impl Parse for SchemaTypeInput {
             schema_name,
             rename_all,
             multipart,
+            omit_default,
         })
     }
 }
@@ -699,4 +710,34 @@ mod tests {
         assert!(input.multipart);
         assert!(matches!(input.partial, Some(PartialMode::All)));
     }
+
+    #[test]
+    fn test_parse_schema_type_input_with_omit_default() {
+        let tokens = quote::quote!(CreateUser from Model, omit_default);
+        let input: SchemaTypeInput = syn::parse2(tokens).unwrap();
+        assert!(input.omit_default);
+    }
+
+    #[test]
+    fn test_parse_schema_type_input_with_omit_default_and_omit() {
+        let tokens = quote::quote!(CreateUser from Model, omit_default, omit = ["password"]);
+        let input: SchemaTypeInput = syn::parse2(tokens).unwrap();
+        assert!(input.omit_default);
+        assert_eq!(input.omit.unwrap(), vec!["password"]);
+    }
+
+    #[test]
+    fn test_parse_schema_type_input_with_omit_default_and_pick() {
+        let tokens = quote::quote!(CreateUser from Model, omit_default, pick = ["name", "email"]);
+        let input: SchemaTypeInput = syn::parse2(tokens).unwrap();
+        assert!(input.omit_default);
+        assert_eq!(input.pick.unwrap(), vec!["name", "email"]);
+    }
+
+    #[test]
+    fn test_parse_schema_type_input_omit_default_defaults_to_false() {
+        let tokens = quote::quote!(CreateUser from User);
+        let input: SchemaTypeInput = syn::parse2(tokens).unwrap();
+        assert!(!input.omit_default);
+    }
 }

crates/vespera_macro/src/schema_macro/mod.rs

@@ -238,6 +238,14 @@ pub fn generate_schema_type_code(
                 continue;
             }
 
+            // Apply omit_default: skip fields with sea_orm(default_value) or sea_orm(primary_key)
+            if input.omit_default
+                && (extract_sea_orm_default_value(&field.attrs).is_some()
+                    || has_sea_orm_primary_key(&field.attrs))
+            {
+                continue;
+            }
+
             // Check if this is a SeaORM relation type
             let is_relation = is_seaorm_relation_type(&field.ty);
 

crates/vespera_macro/src/schema_macro/tests.rs

@@ -575,6 +575,7 @@ fn test_generate_schema_type_code_preserves_struct_doc() {
         ignore_schema: false,
         rename_all: None,
         multipart: false,
+        omit_default: false,
     };
     let struct_def = StructMetadata {
         name: "User".to_string(),

examples/axum-example/openapi.json

@@ -2494,18 +2494,20 @@
       },
       "CreateUuidItemRequest": {
         "type": "object",
+        "description": "UUID item model for testing UUID format in OpenAPI",
         "properties": {
-          "external_ref": {
+          "externalRef": {
             "type": "string",
             "format": "uuid",
+            "description": "External reference UUID",
             "nullable": true
           },
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "Item name"
           },
           "tags": {
             "type": "array",
-            "description": "Unique tags for this item",
             "items": {
               "type": "string"
             },
@@ -3986,22 +3988,26 @@
       },
       "UuidItem": {
         "type": "object",
+        "description": "UUID item model for testing UUID format in OpenAPI",
         "properties": {
-          "external_ref": {
+          "externalRef": {
             "type": "string",
             "format": "uuid",
+            "description": "External reference UUID",
             "nullable": true
           },
           "id": {
             "type": "string",
-            "format": "uuid"
+            "format": "uuid",
+            "description": "Item ID",
+            "default": "00000000-0000-0000-0000-000000000000"
           },
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "Item name"
           },
           "tags": {
             "type": "array",
-            "description": "Unique tags for this item",
             "items": {
               "type": "string"
             },

examples/axum-example/src/routes/uuid_items.rs

@@ -1,26 +1,10 @@
 use std::collections::BTreeSet;
 
-use serde::{Deserialize, Serialize};
 use uuid::Uuid;
-use vespera::Schema;
-use vespera::axum::Json;
+use vespera::{axum::Json, schema_type};
 
-#[derive(Serialize, Deserialize, Schema)]
-pub struct UuidItem {
-    pub id: Uuid,
-    pub name: String,
-    pub external_ref: Option<Uuid>,
-    /// Unique tags for this item
-    pub tags: BTreeSet<String>,
-}
-
-#[derive(Deserialize, Schema)]
-pub struct CreateUuidItemRequest {
-    pub name: String,
-    pub external_ref: Option<Uuid>,
-    /// Unique tags for this item
-    pub tags: BTreeSet<String>,
-}
+schema_type!(UuidItem from crate::models::uuid_item::Model, omit = ["created_at"], add = [("tags": BTreeSet<String>)]);
+schema_type!(CreateUuidItemRequest from crate::models::uuid_item::Model, omit_default, add = [("tags": BTreeSet<String>)]);
 
 /// List all UUID items
 #[vespera::route(get, tags = ["uuid_items"])]