rule-api-database

Community

Enforce API DB modeling standards and migrations.

Authorbtabaska
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This rule enforces API database modeling and migration conventions to prevent schema drift and ensure consistent ORM usage across the api schema.

Core Features & Use Cases

  • Enforces inheritance patterns for API models (e.g., ApiSchemaTable, TimestampMixin) to standardize base definitions.
  • Enforces UUID primary keys with default UUID generation and prevents legacy BigInteger keys for new API-model tables.
  • Enforces naming conventions for tables, lookups, and associations, and requires proper use of Mapped[T] with mapped_column() and back_populates relationships.
  • Guides safe migrations with explicit schema annotations and idempotent patterns to maintain data integrity.

Quick Start

Audit your new or updated API database models against the conventions and adjust code to match the rules.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: rule-api-database
Download link: https://github.com/btabaska/simpler-grants-documentation-automation/archive/main.zip#rule-api-database

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.