jettask 0.2.23__py3-none-any.whl → 0.2.24__py3-none-any.whl

jettask/schemas/backlog.py

@@ -3,22 +3,59 @@
 """
 from typing import Optional, List, Dict, Any
 from datetime import datetime
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, ConfigDict
+
+
+class BacklogLatestRequest(BaseModel):
+    """获取最新积压数据请求模型"""
+    queues: Optional[List[str]] = Field(None, description="队列名称列表，为空时返回所有队列")
+
+    model_config = ConfigDict(json_schema_extra={
+        "examples": [
+            {
+                "queues": ["email_queue", "sms_queue"]
+            },
+            {
+                "queues": []
+            }
+        ]
+    })
 
 
 class BacklogTrendRequest(BaseModel):
     """积压趋势请求模型"""
-    namespace: str = Field(..., description="命名空间")
     queue_name: Optional[str] = Field(None, description="队列名称，为空时查询所有队列")
-    start_time: Optional[str] = Field(None, description="开始时间")
-    end_time: Optional[str] = Field(None, description="结束时间")
-    time_range: Optional[str] = Field(None, description="时间范围，如 '1h', '6h', '1d', '7d'")
-    interval: str = Field(default="5m", description="数据聚合间隔")
+    time_range: Optional[str] = Field("1h", description="时间范围，如 '1h', '6h', '1d', '7d'")
+    start_time: Optional[str] = Field(None, description="开始时间（ISO格式）")
+    end_time: Optional[str] = Field(None, description="结束时间（ISO格式）")
+    interval: str = Field(default="5m", description="数据聚合间隔，如 '1m', '5m', '1h'")
     metrics: List[str] = Field(
         default=["pending", "processing", "completed", "failed"],
         description="要查询的指标类型"
     )
 
+    model_config = ConfigDict(json_schema_extra={
+        "examples": [
+            {
+                "queue_name": "email_queue",
+                "time_range": "1h",
+                "interval": "5m",
+                "metrics": ["pending", "processing"]
+            },
+            {
+                "queue_name": "sms_queue",
+                "start_time": "2025-10-18T09:00:00Z",
+                "end_time": "2025-10-18T10:00:00Z",
+                "interval": "1m",
+                "metrics": ["pending", "processing", "completed", "failed"]
+            },
+            {
+                "time_range": "24h",
+                "interval": "1h"
+            }
+        ]
+    })
+
 
 class BacklogSnapshot(BaseModel):
     """积压快照模型"""

jettask/schemas/namespace.py

@@ -3,7 +3,7 @@
 """
 from typing import Optional, Dict, Any, List
 from datetime import datetime
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, ConfigDict
 from enum import Enum
 
 
@@ -17,64 +17,115 @@ class NamespaceCreate(BaseModel):
     """创建命名空间请求模型"""
     name: str = Field(..., description="命名空间名称")
     description: Optional[str] = Field(None, description="命名空间描述")
-    
+
     # 配置模式
     config_mode: ConfigMode = Field(ConfigMode.DIRECT, description="配置模式: direct(直接配置) 或 nacos(Nacos配置)")
-    
+
     # Redis配置 - 支持两种方式
     # 方式1: 直接配置字符串 (格式: redis://[password@]host:port/db)
     redis_url: Optional[str] = Field(None, description="Redis连接字符串，格式: redis://[password@]host:port/db")
     # 方式2: Nacos配置键
     redis_nacos_key: Optional[str] = Field(None, description="Redis连接字符串的Nacos配置键")
-    
+
     # PostgreSQL配置 - 支持两种方式
     # 方式1: 直接配置字符串 (格式: postgresql://user:password@host:port/database)
     pg_url: Optional[str] = Field(None, description="PostgreSQL连接字符串，格式: postgresql://user:password@host:port/database")
     # 方式2: Nacos配置键
     pg_nacos_key: Optional[str] = Field(None, description="PostgreSQL连接字符串的Nacos配置键")
 
+    model_config = ConfigDict(json_schema_extra={
+        "examples": [
+            {
+                "name": "production",
+                "description": "生产环境命名空间",
+                "config_mode": "direct",
+                "redis_url": "redis://:password@localhost:6379/0",
+                "pg_url": "postgresql://user:password@localhost:5432/jettask"
+            },
+            {
+                "name": "staging",
+                "description": "预发布环境命名空间",
+                "config_mode": "nacos",
+                "redis_nacos_key": "staging.redis.url",
+                "pg_nacos_key": "staging.pg.url"
+            }
+        ]
+    })
+
 
 class NamespaceUpdate(BaseModel):
     """更新命名空间请求模型"""
     description: Optional[str] = Field(None, description="命名空间描述")
-    
+
     # 配置模式
     config_mode: Optional[ConfigMode] = Field(None, description="配置模式: direct(直接配置) 或 nacos(Nacos配置)")
-    
+
     # Redis配置 - 支持两种方式
     redis_url: Optional[str] = Field(None, description="Redis连接字符串，格式: redis://[password@]host:port/db")
     redis_nacos_key: Optional[str] = Field(None, description="Redis连接字符串的Nacos配置键")
-    
+
     # PostgreSQL配置 - 支持两种方式
     pg_url: Optional[str] = Field(None, description="PostgreSQL连接字符串，格式: postgresql://user:password@host:port/database")
     pg_nacos_key: Optional[str] = Field(None, description="PostgreSQL连接字符串的Nacos配置键")
-    
+
     enabled: Optional[bool] = Field(None, description="是否启用")
 
+    model_config = ConfigDict(json_schema_extra={
+        "examples": [
+            {
+                "description": "更新命名空间描述",
+                "enabled": True
+            },
+            {
+                "config_mode": "direct",
+                "redis_url": "redis://:newpassword@localhost:6380/1",
+                "enabled": False
+            }
+        ]
+    })
+
 
 class NamespaceResponse(BaseModel):
     """命名空间响应模型"""
     name: str = Field(..., description="命名空间名称")
     description: Optional[str] = Field(None, description="命名空间描述")
-    
-    # Redis配置信息 - 只返回最终的URL
-    redis_url: str = Field(..., description="Redis连接字符串")
-    
-    # PostgreSQL配置信息 - 只返回最终的URL
-    pg_url: Optional[str] = Field(None, description="PostgreSQL连接字符串")
-    
+
+    # Redis配置信息 - 根据配置模式返回不同内容
+    redis_url: Optional[str] = Field(None, description="Redis连接字符串（仅 direct 模式时返回完整 URL，nacos 模式为 null）")
+    redis_config_mode: str = Field(default="direct", description="Redis 配置模式：direct（直接配置）或 nacos（Nacos 配置中心）")
+    redis_nacos_key: Optional[str] = Field(None, description="Redis Nacos 配置键（仅 nacos 模式时返回）")
+
+    # PostgreSQL配置信息 - 根据配置模式返回不同内容
+    pg_url: Optional[str] = Field(None, description="PostgreSQL连接字符串（仅 direct 模式时返回完整 URL，nacos 模式为 null）")
+    pg_config_mode: str = Field(default="direct", description="PostgreSQL 配置模式：direct 或 nacos")
+    pg_nacos_key: Optional[str] = Field(None, description="PostgreSQL Nacos 配置键（仅 nacos 模式时返回）")
+
     # 连接信息
     connection_url: str = Field(..., description="用于连接此命名空间的URL路径")
     version: int = Field(default=1, description="配置版本号")
-    
+
     enabled: bool = Field(..., description="是否启用")
     created_at: datetime = Field(..., description="创建时间")
     updated_at: Optional[datetime] = Field(None, description="更新时间")
-    
-    class Config:
-        json_encoders = {
+
+    model_config = ConfigDict(
+        json_encoders={
             datetime: lambda v: v.isoformat() if v else None
+        },
+        json_schema_extra={
+            "example": {
+                "name": "production",
+                "description": "生产环境命名空间",
+                "redis_url": "redis://:***@localhost:6379/0",
+                "pg_url": "postgresql://user:***@localhost:5432/jettask",
+                "connection_url": "/api/v1/namespaces/production",
+                "version": 1,
+                "enabled": True,
+                "created_at": "2025-10-18T10:00:00Z",
+                "updated_at": "2025-10-18T12:00:00Z"
+            }
         }
+    )
 
 
 class NamespaceInfo(BaseModel):

jettask/schemas/queue.py

@@ -3,16 +3,32 @@
 """
 from typing import Optional, List, Dict, Any
 from datetime import datetime
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, ConfigDict
 
 
 class TimeRangeQuery(BaseModel):
     """时间范围查询模型"""
     queues: Optional[List[str]] = Field(None, description="队列名称列表，为空时统计所有队列")
     time_range: Optional[str] = Field(None, description="时间范围（如 '1h', '24h', '7d'），与 start_time/end_time 二选一")
-    start_time: Optional[str] = Field(None, description="开始时间，与 time_range 二选一")
-    end_time: Optional[str] = Field(None, description="结束时间，与 time_range 二选一")
+    start_time: Optional[str] = Field(None, description="开始时间（ISO格式），与 time_range 二选一")
+    end_time: Optional[str] = Field(None, description="结束时间（ISO格式），与 time_range 二选一")
     interval: Optional[str] = Field(default="1h", description="时间间隔")
+    queue_name: Optional[str] = Field(None, description="队列名称（可选）")
+
+    model_config = ConfigDict(json_schema_extra={
+        "examples": [
+            {
+                "time_range": "1h",
+                "queue_name": "email_queue"
+            },
+            {
+                "start_time": "2025-10-18T09:00:00Z",
+                "end_time": "2025-10-18T10:00:00Z",
+                "queues": ["email_queue", "sms_queue"],
+                "interval": "5m"
+            }
+        ]
+    })
 
 
 class QueueStatsResponse(BaseModel):