schema-review

Analyze JSON Schema files in iglu-central for quality and compatibility issues.

123|112|Updated Jun 17, 2014
One-click install
npx skills add https://github.com/snowplow/iglu-central --skill schema-review-snowplow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: schema-review
Source: https://github.com/snowplow/iglu-central/tree/main/.claude/skills/schema-review
Command: npx skills add https://github.com/snowplow/iglu-central --skill schema-review-snowplow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviews JSON Schema files in iglu-central for common issues found in PR reviews. Checks field constraints, type definitions, warehouse compatibility, and consistency patterns. Use when reviewing schema files before PR submission or when validating changes to schemas in the schemas/ directory.

Core Features & Use Cases

  • Checks field constraints, type definitions, warehouse compatibility, and consistency patterns.
  • Validates required fields, schema evolution rules, and documentation completeness.
  • Use Case: When reviewing a PR that adds or updates a schema in schemas/, run this skill to surface actionable issues for reviewers.

Quick Start

Run the schema-review on changed schemas to surface issues and suggested fixes.

Frequently Asked Questions about schema-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review JSON Schema files in a PR for quality and consistency?

To review JSON Schema files in a PR, analyze field constraints, type definitions, and warehouse compatibility to surface actionable issues. This process identifies consistency patterns and required field validation problems before merging schema changes.

What does schema evolution validation check in iglu-central?

Schema evolution validation in iglu-central checks compatibility across schema versions to prevent breaking changes. It targets required field validation and type definitions, outputting structured findings with suggested fixes to guide maintainers during PR reviews.

How do I check warehouse compatibility for JSON Schema changes?

Checking warehouse compatibility for JSON Schema changes involves analyzing type definitions and field constraints against storage requirements. This identifies potential loading or querying issues, providing structured escalation notes to guide maintainers before merging.

When should I run a JSON Schema review on my repository?

Run a JSON Schema review before submitting a PR that adds or updates schemas in the schemas/ directory. This surfaces actionable issues regarding documentation completeness and consistency patterns to address during the reviewer feedback phase.

Can I automate finding missing required fields in JSON Schemas?

Automating the search for missing required fields in JSON Schemas involves validating field constraints and evolution rules. The analysis outputs structured findings with suggested fixes, targeting required field validation to support maintainers reviewing schema updates.