beautysale-api-contract-guard

Validate BeautySale API contract changes across routes, authentication, DTOs, tests, and documentation.

Updated Feb 6, 2026
One-click install
npx skills add https://github.com/spandios/vibe-utils --skill beautysale-api-contract-guard
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: beautysale-api-contract-guard
Source: https://github.com/spandios/vibe-utils/tree/main/skills/beautysale-api-contract-guard
Command: npx skills add https://github.com/spandios/vibe-utils --skill beautysale-api-contract-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures the integrity and consistency of API contracts within the BeautySale repository, preventing unintended regressions and maintaining documentation accuracy.

Core Features & Use Cases

  • API Contract Enforcement: Validates changes against defined API specifications, ensuring route groups, authentication, and data transfer objects (DTOs) remain consistent.
  • Test and Documentation Sync: Facilitates updating controller tests and API documentation (API_SPEC.md) to reflect code changes.
  • Use Case: When modifying an existing endpoint or adding a new one in the BeautySale API, this Skill helps ensure that the corresponding tests are updated and the API documentation accurately reflects the new contract, including authentication requirements.

Quick Start

Use the beautysale-api-contract-guard skill to review a BeautySale API contract change before implementation.

Frequently Asked Questions about beautysale-api-contract-guard

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

FAQPage Schema
How do I validate API contract changes for route groups and authentication?

Validating API contract changes requires checking route groups, authentication rules, and DTOs against specifications. This Skill enforces API contract integrity by validating controller endpoints, security configurations, and DTO consistency within the BeautySale repository.

What is API contract enforcement for controller endpoints and DTOs?

API contract enforcement is the process of validating route groups, authentication, and data transfer objects against defined specifications. It ensures that modifications to controller endpoints and security configurations remain consistent and prevent unintended regressions.

How do I keep API documentation and controller tests synchronized with code changes?

To keep API documentation and tests synchronized, update controller tests and the API_SPEC.md file to reflect code changes. This Skill facilitates syncing documentation and tests whenever you modify or add new API endpoints.

Can I use this API contract guard for security configurations outside the BeautySale codebase?

This API contract guard applies specifically to the BeautySale codebase and repository. It validates changes within controller endpoints, DTOs, and security configurations native to that environment rather than external projects.

What's the best way to prevent API regressions when adding new endpoints?

The best way to prevent API regressions is enforcing contract integrity by mapping contract surfaces, updating tests, and syncing documentation. This Skill applies specific workflow steps to validate new endpoints and maintain documentation accuracy.