skills.rest
saschadudkin-sketch
saschadudkin-sketchCOMMUNITY
Explore all skills by this author β†’
GitHub

domhub-api-contracts

Coordinate OpenAPI schema, documentation, and frontend type updates for /api/v1/* routes.

Updated Mar 28, 2026
Search Tags:#version control#openapi#api management#api contract#domhub
One-click install
npx skills add https://github.com/saschadudkin-sketch/rezidence4 --skill domhub-api-contracts
Or copy as Structured Prompt for Agentβ–Ό
Please help me install this Agent Skill.
Skill: domhub-api-contracts
Source: https://github.com/saschadudkin-sketch/rezidence4/tree/main/.agents/skills/domhub-api-contracts
Command: npx skills add https://github.com/saschadudkin-sketch/rezidence4 --skill domhub-api-contracts

SYSTEM DOCUMENTATION & REQUIREMENTS

πŸ’‘ This Skill requires openapi-generator, openapi-schema, frontend-api-types, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill helps maintain consistency and prevent drift in API contracts for the DomHub platform, ensuring seamless integration and reliable functionality across all systems.

Core Features & Use Cases

  • API Contract Management: Centralize and manage API contract definitions and changes.
  • Documentation and Schema Maintenance: Maintain up-to-date OpenAPI documentation and schema files.
  • Version Control: Track changes to API contracts and manage different versions.
  • Use Case: When updating a /api/v1/* route, use this Skill to ensure all related documentation, frontend types, tests, and policy checks are updated in harmony to maintain compatibility and reliability.

Quick Start

Update the /api/v1/auth route using this Skill and regenerate API types with npm run openapi:types.

Frequently Asked Questions about domhub-api-contracts

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

FAQPage Schema
How do I prevent API drift when updating OpenAPI schemas for /api/v1/* routes?β–Ό

Preventing API drift requires coordinating updates to OpenAPI schemas, documentation, and frontend API types simultaneously whenever a /api/v1/* route changes. This synchronization maintains system compatibility and prevents integration failures.

What is API contract management and why is it needed for version control?β–Ό

API contract management centralizes and tracks changes to OpenAPI definitions across different versions. It prevents schema drift and maintains compatibility between backend /api/v1/* routes and frontend API types.

How do I regenerate frontend API types after updating an OpenAPI schema?β–Ό

Regenerate frontend API types after updating an OpenAPI schema by running `npm run openapi:types`. This synchronization updates type definitions to match the new contract and prevents integration failures.

Do I need openapi-generator and openapi-schema to maintain API documentation?β–Ό

Yes, openapi-generator and openapi-schema are required dependencies. They provide the foundational tools to regenerate frontend API types and maintain up-to-date schema files and documentation for /api/v1/* routes.

Can I use this approach to track changes across different API versions?β–Ό

Yes, version control tracks changes to OpenAPI contracts and manages different versions. It ensures updates to /api/v1/* routes maintain backward compatibility and documentation accuracy across all DomHub systems.

Why does my frontend break when I update a /api/v1/* route without regenerating types?β–Ό

Your frontend breaks because the API contract drifted. Without regenerating frontend API types using `npm run openapi:types`, frontend definitions do not match the updated OpenAPI schema, causing integration failures.

Related Skills

Explore More Software Engineering Skills→
Ankurjain1121Ankurjain1121

openapi-spec-generation

Convert API contracts into OpenAPI 3.1 specifications and SDK templates.

Community
Advanced
zerobias-orgzerobias-org

gate-2-type-generation

Generate TypeScript types from OpenAPI specifications and validate compilation.

Official
Advanced
semicolon-devteamsemicolon-devteam

sync-interface

Generate TypeScript typings from the core-interface OpenAPI specification.

Official
Advanced
mosheshammoshesham

api-design-reviewer

Lint OpenAPI specs for REST conventions and detect breaking changes.

Community
Advanced