api-docs

Enforce OpenAPI documentation on FastAPI endpoints with response models and examples.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/trezero/archon-trinity --skill api-docs-trezero
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/trezero/archon-trinity/tree/main/integrations/claude-code/extensions/api-docs
Command: npx skills add https://github.com/trezero/archon-trinity --skill api-docs-trezero

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures FastAPI endpoints are fully and consistently documented so API consumers, generated docs, and tooling have accurate response schemas, status codes, error responses, and examples.

Core Features & Use Cases

  • Automated discovery of FastAPI route files, app entry points, model locations, and Pydantic version to adapt edits to project conventions.
  • Documentation enforcement and retrofit that adds response_model, status_code, tags, responses, docstrings, type hints, Field descriptions, and examples without overwriting existing documentation.
  • Postman handoff that generates collection entries when a postman-integration skill is available, enabling API testing and export workflows.

Quick Start

Document all FastAPI endpoints in this repository, fix missing OpenAPI fields, and generate Postman collection entries where available.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I add complete OpenAPI documentation to existing FastAPI endpoints?

FastAPI OpenAPI documentation requires adding response_model, status_code, tags, descriptions, and Pydantic examples to routes. This Skill audits your codebase, detects project conventions, and retrofits missing OpenAPI fields without overwriting existing documentation.

What's the best way to generate Postman collection entries from FastAPI routes?

Generating Postman collection entries from FastAPI routes requires documenting endpoints with response schemas and examples. This Skill automatically scaffolds Postman collection entries for API testing and export workflows when a postman-integration skill is available.

How does Pydantic version detection affect FastAPI model documentation?

Pydantic version detection ensures FastAPI model documentation adapts edits to your project conventions. By identifying the Pydantic version, the process correctly updates or scaffolds Field descriptions and examples according to the specific version syntax.

Does this documentation approach preserve existing FastAPI docstrings and field descriptions?

Yes, this documentation approach preserves existing FastAPI docstrings and field descriptions. When retrofitting endpoints to add missing OpenAPI fields, it specifically avoids overwriting any documentation already present in your codebase.

Can I audit FastAPI codebases for missing response_model and error responses?

Yes, you can audit FastAPI codebases for missing response_model and error responses. The auditing process scans route files to detect missing OpenAPI fields, status codes, and Pydantic examples, then updates routers as needed to ensure API consistency.