schema-drift-detector

Official

Monitor API schemas, auto-update Payload collections.

AuthorComparePower
Version1.0.0
Installs0

System Documentation

What problem does it solve?

External API schemas can change without warning, leading to broken integrations and outdated data models in your CMS. This skill automatically monitors API endpoints for schema drift, identifies changes, and generates the necessary Payload field definitions to keep your collections synchronized.

Core Features & Use Cases

  • Automated Schema Monitoring: Fetches current API responses and compares them against a defined expected schema to detect additions, removals, or changes in fields and types.
  • Payload Field Generation: Automatically generates TypeScript Payload field definitions for new or changed fields, streamlining the process of updating your CMS schema.
  • Use Case: Your Providers collection in Payload CMS relies on data from the ComparePower API. Use this skill to regularly check the API for schema changes, and if a new field like email is added, it will generate the corresponding Payload email field definition and a migration script for you.

Quick Start

Check for schema drift on the ComparePower API endpoint 'https://api.comparepower.com/v1/providers/4change-energy' against the 'providers' collection.

Dependency Matrix

Required Modules

node-fetchpnpm

Components

scripts

💻 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: schema-drift-detector
Download link: https://github.com/ComparePower/payload-cms-cloudflare-baseline/archive/main.zip#schema-drift-detector

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