Skills
.Work. You
Rest

document-api-integration

Official

Auto-generate API integration docs.

Software Engineering#template#documentation#api#integration#docs#code-analysis#qontract-api
Authorapp-sre
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Analyze an existing qontract-api integration and generate documentation following the standard template at docs/integrations/template.md.

Core Features & Use Cases

  • Analyze integration codebases to extract models, endpoints, and business logic for documentation.
  • Generate a complete docs file that adheres to the project's documentation template.
  • Update or create docs/integrations/<name>.md and reference the template for consistency.

Quick Start

Ask the AI to generate documentation for a given qontract-api integration by providing the integration name (e.g., "slack-usergroups") or by confirming the integration to document.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: document-api-integration
Download link: https://github.com/app-sre/qontract-reconcile/archive/main.zip#document-api-integration

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.