skills.rest
hmcts
hmctsOFFICIAL
Explore all skills by this author →
Website𝕏@HMCTSgovukGitHub

api-contract-check

Validate RAML, JSON Schema, and OpenAPI contracts against service implementations.

3|4|Updated Apr 4, 2026
Search Tags:#drift detection#schema validation#API validation#contract verification#cross-context verification
One-click install
npx skills add https://github.com/hmcts/agentic-plugins-marketplace --skill api-contract-check-hmcts
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-check
Source: https://github.com/hmcts/agentic-plugins-marketplace/tree/main/plugins/agents/hmcts-sdlc-orchestrator/skills/api-contract-check
Command: npx skills add https://github.com/hmcts/agentic-plugins-marketplace --skill api-contract-check-hmcts

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Ensures API definitions are consistently implemented across various services, identifying drift or changes that may cause issues.

Core Features & Use Cases

  • API Contract Validation: Compares RAML/JSON Schema/OpenAPI definitions against implementations to ensure consistency.
  • API Drift Detection: Identifies discrepancies between API definitions and actual implementations.
  • Schema Consistency Check: Validates the schema consistency for JSON Schemas and RAML definitions.
  • Cross-Context Contract Verification: Checks API contracts across different contexts for proper alignment.
  • Reporting: Generates a detailed report of the API contract validation process.

Quick Start

Run the 'api-contract-check' skill to validate the API contracts for a service.

Frequently Asked Questions about api-contract-check

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

FAQPage Schema
How do I validate API contracts for drift and consistency?▼

API contract validation is the process of comparing RAML, JSON Schema, or OpenAPI definitions against actual service implementations to identify schema inconsistencies, inter-service contract issues, and API drift.

How do I detect API drift between OpenAPI definitions and implementations?▼

You can detect API drift by running a validation check that compares your OpenAPI and RAML definitions against the implemented command and query handlers, event schemas, and inter-service contracts to flag discrepancies.

Can I verify cross-context API contracts across different microservices?▼

Yes, you can verify cross-context API contracts by checking the alignment of event schemas and inter-service contracts across different service contexts to ensure proper integration and consistency.

Does API contract validation work with both RAML and JSON Schema formats?▼

Yes, API contract validation supports checking schema consistency for both RAML and JSON Schema definitions, ensuring that the specified schemas align with the service implementations.

What is API drift and how does it affect schema consistency?▼

API drift occurs when discrepancies emerge between API definitions and their actual implementations, causing schema inconsistencies that can break inter-service communication and cross-context integrations.

Related Skills

Explore More Software Engineering Skills→
Serg28Serg28

api-designer

Create OpenAPI 3.1 YAML specifications with endpoints, schemas, and security.

Community
Intermediate
datamonsterrdatamonsterr

speckit-sync-propose

Generate drift-resolution proposals for spec and code divergences.

Community
Advanced
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
rnavarychrnavarych
14

contract-testing

Verify microservice API contracts with Pact consumer-driven testing.

Community
Advanced