Skip to main content
NEW · APP STORE Now on iOS · macOS · iPad Android & Windows soon GET IT
Prompts Pydantic Multi-Model API Generator

developer coding skill risk: low

Pydantic Multi-Model API Generator

Instructs creation of Pydantic models using the multi-model pattern with Base, Create, Update, Response, and InDB variants, including camelCase aliases, optional fields, and doc_ty…

SKILL 1 file

SKILL.md
Download 
---
name: pydantic-models-py
description: "Create Pydantic models following the multi-model pattern for clean API contracts."
---
# 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

```python
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

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

## Database Document

```python
class MyInDB(MyResponse):
    """Adds doc_type for Cosmos DB queries."""
    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

## When to Use
This skill is applicable to execute the workflow or actions described in the overview.

## Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

INPUTS

ResourceName REQUIRED

PascalCase resource name

e.g. Project

resource_name REQUIRED

snake_case resource name

e.g. project

REQUIRED CONTEXT

  • template from assets/template.py
  • ResourceName (PascalCase)
  • resource_name (snake_case)

OPTIONAL CONTEXT

  • specific model fields
  • doc_type value

ROLES & RULES

  1. Use this skill only when the task clearly matches the scope described above.
  2. Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  3. Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

EXPECTED OUTPUT

Format
code
Constraints
  • follow multi-model pattern (Base, Create, Update, Response, InDB)
  • use camelCase aliases with populate_by_name
  • make all Update fields optional
  • add doc_type for InDB

SUCCESS CRITERIA

  • Follow the multi-model pattern (Base, Create, Update, Response, InDB)
  • Use provided placeholder replacement rules for resource names
  • Apply camelCase aliases and Config.populate_by_name when needed

FAILURE MODES

  • May produce models that still require environment-specific validation or testing

EXAMPLES

Includes code snippets demonstrating camelCase aliases, optional update fields, database document inheritance, plus a table defining the five-model pattern.

CAVEATS

Dependencies
  • Requires template from assets/template.py
Missing context
  • Full content of assets/template.py
  • Concrete field examples or validation rules for a specific resource
  • Target Python/Pydantic version
Ambiguities
  • When to Use section references a non-existent 'overview'.
  • assets/template.py is mentioned but neither linked nor included.

QUALITY

OVERALL
0.68
CLARITY
0.72
SPECIFICITY
0.65
REUSABILITY
0.82
COMPLETENESS
0.58

IMPROVEMENT SUGGESTIONS

  • Inline the template.py content instead of referencing an external asset.
  • Replace the vague 'When to Use' paragraph with explicit trigger conditions.
  • Add a complete worked example showing all five models for one resource.

USAGE

Copy the prompt above and paste it into your AI of choice — Claude, ChatGPT, Gemini, or anywhere else you're working. Replace any placeholder sections with your own context, then ask for the output.

MORE FOR DEVELOPER