api_contract_compliance_review

Validate API implementations against declared REST and GraphQL contracts.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/denish12/codex-ai-agent-and-skills --skill api-contract-compliance-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api_contract_compliance_review
Source: https://github.com/denish12/codex-ai-agent-and-skills/tree/main/locales/en/.agents/skills/api_contract_compliance_review
Command: npx skills add https://github.com/denish12/codex-ai-agent-and-skills --skill api-contract-compliance-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API implementations can drift from documented contracts, leading to mismatches in schemas, errors, pagination, and auth behavior.

Core Features & Use Cases

  • Contract alignment: Compare implementations against API contracts to confirm method, paths, and schemas match.
  • Quality assurance: Validate error formats, status codes, and idempotency requirements.
  • Audit readiness: Generate a comprehensive compliance report suitable for design reviews and production audits.

Quick Start

Run the review on your API project to produce a compliance report.

Frequently Asked Questions about api_contract_compliance_review

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

FAQPage Schema
How do I validate my API implementation against a declared contract?

You validate API implementations against declared contracts by comparing endpoint methods, paths, and schemas to confirm alignment. This compliance review checks REST and GraphQL services to ensure the implementation matches the documented behavior.

What is API contract compliance and when do I need it?

API contract compliance is the validation of endpoint coverage, method accuracy, schema validation, and error formatting against a declared specification. You need it during design reviews and production audits to prevent implementation drift from documented contracts.

Can I use this to check REST and GraphQL endpoint schemas?

Yes, you can validate both REST and GraphQL services. The review confirms endpoint coverage, method and path accuracy, schema validation, pagination, and idempotency compliance across your development pipeline.

How do I audit API error formatting and idempotency requirements?

You audit API error formatting and idempotency by running a compliance review against the declared contract. This validates that error formats, status codes, and idempotency requirements match the specified behavior.

What is the best way to generate an API compliance report for design reviews?

The best way to generate an API compliance report is to run a review on your API project. This produces a comprehensive audit document covering schema validation, error formatting, and endpoint coverage suitable for design reviews.

Why does my API implementation drift from the documented contract?

API implementations drift from documented contracts due to mismatches in schemas, errors, pagination, and auth behavior during development. Validating endpoint coverage and method accuracy against the contract detects this drift.