skills.rest
mrgeoffrich
mrgeoffrichCOMMUNITY
Explore all skills by this author →
GitHub

api-change-check

Validate API documentation and permission configurations against git diffs.

3|Updated Aug 28, 2025
Search Tags:#code review#documentation#api#permissions#git diff
One-click install
npx skills add https://github.com/mrgeoffrich/mini-infra --skill api-change-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-change-check
Source: https://github.com/mrgeoffrich/mini-infra/tree/main/.claude/skills/api-change-check
Command: npx skills add https://github.com/mrgeoffrich/mini-infra --skill api-change-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers verify that project artifacts like API docs, permissions, and route registrations are in sync with the actual code changes before opening a Pull Request.

Core Features & Use Cases

  • Artifact Consistency Check: Compares git diffs against documentation files such as API-ROUTES.md, permissions.ts, and app.ts to identify discrepancies.
  • Impact Analysis: Detects unreflected changes in API endpoints, permission definitions, and route registrations.
  • Use Case: Before merging significant feature branches, run this Skill to confirm all documentation and configuration accurately reflect the codebase, avoiding deployment issues.

Quick Start

Analyze the recent branch changes to identify missing or outdated API documentation and permission configurations.

Frequently Asked Questions about api-change-check

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

FAQPage Schema
How do I check API documentation consistency against code changes before merging?▼

API documentation consistency is verified by comparing git diffs against project artifacts like API-ROUTES.md, permissions.ts, and app.ts to detect discrepancies before opening a pull request.

Why are my API route registrations out of sync with my codebase after a feature update?▼

API route registrations fall out of sync when code changes are not reflected in configuration files. Running an automated impact analysis detects unreflected changes in route registrations and permissions before deployment.

What is the best way to automate permission configuration validation for a pull request?▼

The best way to automate permission configuration validation is to use a tool that compares git diffs against permissions.ts to ensure permission definitions accurately reflect the updated codebase.

Can I analyze git diffs to find missing API endpoints in my documentation?▼

Yes, you can analyze git diffs to find missing API endpoints by comparing code changes against documentation files to detect unreflected endpoints and prevent deployment issues.

Do I need to manually update API-ROUTES.md when modifying route files?▼

You do not need to manually update API-ROUTES.md if you use an automated artifact consistency check, which identifies outdated documentation by comparing it directly against your route file modifications.

Related Skills

Explore More Software Engineering Skills→
ather-techieather-techie
6

check-feature-docs

Audits git repository changes to ensure documentation files are updated.

Community
Intermediate
oogDZoogDZ

merge

Merge GitHub pull requests with pre- and post-merge validations.

Community
Intermediate
MatthieuszMatthieusz

coding-standards

Validate TypeScript code against predefined coding standards using static analysis tools.

Community
Advanced
kurokeitakurokeita
1

find-bugs

Analyze code changes to identify bugs, security vulnerabilities, and quality issues.

Community
Intermediate