pydantic-models-py
Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response schemas, database models, or data validation in Python applications using Pydantic v2.
Install
npx skills add https://github.com/microsoft/skills/tree/main/.github/plugins/azure-sdk-python/skills/pydantic-models-py
claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install microsoft-skills@llmmart
git clone https://github.com/microsoft/skills.git
The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole microsoft/skills collection as a plugin from our marketplace. Git is the plain clone.
Skill manifest
Pydantic Models
Create Pydantic models following the multi-model pattern for clean API contracts.
Quick Start
Copy the template from assets/template.py and replace placeholders:
{{ResourceName}}→ PascalCase name (e.g.,Project){{resource_name}}→ snake_case name (e.g.,project)
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
from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field
class MyModel(BaseModel):
model_config = ConfigDict(populate_by_name=True)
workspace_id: str = Field(..., alias="workspaceId")
created_at: datetime = Field(..., alias="createdAt")
Optional Update Fields
class MyUpdate(BaseModel):
model_config = ConfigDict(populate_by_name=True)
name: Optional[str] = Field(None, min_length=1)
description: Optional[str] = None
Database Document
class MyInDB(MyResponse):
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
Reference Files
| File | Contents |
|---|---|
| references/capabilities.md | Additional non-hero capabilities, operation-group coverage, and production checklists. |
Files (skills)
-
assets
-
template.py 1.5 KB
Loading…
-
-
references
-
capabilities.md 1.1 KB
Loading…
-
-
SKILL.md 1.9 KB
--- name: pydantic-models-py description: Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response schemas, database models, or data validation in Python applications using Pydantic v2. license: MIT metadata: author: Microsoft version: "1.0.0" --- # Pydantic Models Create Pydantic models following the multi-model pattern for clean API contracts. ## Quick Start Copy the template from [assets/template.py](assets/template.py) and replace placeholders: - `{{ResourceName}}` → PascalCase name (e.g., `Project`) - `{{resource_name}}` → snake_case name (e.g., `project`) ## 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 ```python from datetime import datetime from pydantic import BaseModel, ConfigDict, Field class MyModel(BaseModel): model_config = ConfigDict(populate_by_name=True) workspace_id: str = Field(..., alias="workspaceId") created_at: datetime = Field(..., alias="createdAt") ``` ## Optional Update Fields ```python class MyUpdate(BaseModel): model_config = ConfigDict(populate_by_name=True) name: Optional[str] = Field(None, min_length=1) description: Optional[str] = None ``` ## Database Document ```python class MyInDB(MyResponse): doc_type: str = "my_resource" ``` ## Integration Steps 1. Create models in `src/backend/app/models/` 2. Export from `src/backend/app/models/__init__.py` 3. Add corresponding TypeScript types ## Reference Files | File | Contents | |------|----------| | [references/capabilities.md](references/capabilities.md) | Additional non-hero capabilities, operation-group coverage, and production checklists. |
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.