API Documentation Sync & Enforcement FAQs

Question 1

What happens if my documentation is out of sync?

Accepted Answer

The skill detects the drift, identifies the specific endpoints missing from your documentation, pauses current work, and prompts the use of the documentation-audit skill to resolve the discrepancy.

Question 2

Can I skip the documentation check for internal changes?

Accepted Answer

Yes, the skill is designed to be skipped when changes are purely internal, involve only test files, or are modifications to the documentation itself.

Question 3

Does it validate the actual OpenAPI file structure?

Accepted Answer

Yes, it can use tools like @apidevtools/swagger-cli or yq to validate that the specification file is well-formed and contains required top-level fields like paths and info.

Question 4

Which frameworks does this skill support?

Accepted Answer

It supports a wide range of popular frameworks including Express, Fastify, NestJS, FastAPI, Flask, and Go by monitoring specific file patterns for routes and controllers.

Question 5

Where does the skill look for API documentation files?

Accepted Answer

It automatically searches common project locations for files like openapi.yaml, openapi.json, swagger.yaml, and specialized folders like /docs or /api.

API Documentation Sync & Enforcement

About

Key Features

Use Cases

API Documentation Sync & Enforcement

About

Key Features

Use Cases