Labsco
microsoft logo

pydantic-models-py

✓ Official★ 2,700

by microsoft · part of microsoft/skills

Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response…

🔥🔥🔥🔥✓ VerifiedFreeQuick setup
#database#cloud#git
🧩 One of 7 skills in the microsoft/skills package — works on its own, and pairs well with its siblings.

This is the playbook your agent receives when the skill activates — you don't need to read it to use the skill, but it's here to audit before installing.

by microsoft

Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response… npx skills add https://github.com/microsoft/agent-skills --skill pydantic-models-py Download ZIPGitHub2.7k

Pydantic Models

Create Pydantic models following the multi-model pattern for clean API contracts.

Multi-Model Pattern

Model Purpose Base Common fields shared across models Create Request body for creation (required fields) Update Request body for updates (all optional) Response API response with all fields InDB Database document with doc_type

camelCase Aliases

class MyModel(BaseModel):
 workspace_id: str = Field(..., alias="workspaceId")
 created_at: datetime = Field(..., alias="createdAt")
 
 class Config:
 populate_by_name = True # Accept both snake_case and camelCase

Optional Update Fields

class MyUpdate(BaseModel):
 """All fields optional for PATCH requests."""
 name: Optional[str] = Field(None, min_length=1)
 description: Optional[str] = None

Database Document

class MyInDB(MyResponse):
 """Adds doc_type for Cosmos DB queries."""
 doc_type: str = "my_resource"

Integration Steps

  • Create models in src/backend/app/models/

  • Export from src/backend/app/models/__init__.py

  • Add corresponding TypeScript types