update-api-docs
Sync and regenerate API docs from OpenAPI specs. Use for keeping Docusaurus references current.
Install
mkdir -p .claude/skills/update-api-docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/7252" && unzip -o skill.zip -d .claude/skills/update-api-docs && rm skill.zipInstalls to .claude/skills/update-api-docs
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Update the API reference documentation by downloading the latest OpenAPI spec from production and regenerating the Docusaurus API docsKey capabilities
- →Download OpenAPI spec
- →Regenerate API documentation
- →Update sidebar configuration
- →Sync docs with production API
How it works
It runs a script to fetch the latest OpenAPI JSON and triggers Docusaurus plugins to regenerate API reference pages.
Inputs & outputs
When to use update-api-docs
- →Update API documentation
- →Sync OpenAPI spec with docs
- →Regenerate Docusaurus references
- →Automate API docs deployment
About update-api-docs
Downloads the latest OpenAPI JSON from a specified source and triggers the generation of Docusaurus API documentation. Manages sidebars and configuration to ensure docs match production APIs.
Update the API reference documentation by downloading the latest OpenAPI spec from production and regenerating the Docusaurus API docs
When not to use it
- →When the API spec is not in OpenAPI format
Prerequisites
Limitations
- →Requires Docusaurus plugin-openapi-docs
- →Known deprecation warning about onBrokenMarkdownLinks
How it compares
It automates the synchronization process instead of manually updating documentation files after API changes.
Compared to similar skills
update-api-docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| update-api-docs (this skill) | 1 | 3mo | Review | Beginner |
| custom-workers | 1 | 7mo | Review | Intermediate |
| writing-docs | 1 | 1mo | Review | Beginner |
| Outline Open Source Team Knowledge Base and Wiki Platform | 0 | 2mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by Agenta-AI
View all by Agenta-AI →You might also like
custom-workers
ruvnet
Create and run custom background analysis workers with composable phases. Use when you need automated code analysis, security scanning, pattern learning, or API documentation generation.
writing-docs
remotion-dev
Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
Outline Open Source Team Knowledge Base and Wiki Platform
agentskillexchange
Outline is a fast, collaborative knowledge base for teams built with React and Node.js. It provides real-time editing, Markdown support, and a rich API for integration with Slack, authentication providers, and custom workflows.
api-documenter
ovachiever
Auto-generate API documentation from code and comments. Use when API endpoints change, or user mentions API docs. Creates OpenAPI/Swagger specs from code. Triggers on API file changes, documentation requests, endpoint additions.
writeDocumentation
duplojs
Write or update duplojs-utils documentation pages (FR/EN) including API function pages, namespace index pages, and guides, following the repo's structure, MonacoTSEditor examples, required sections, and prev/next metadata.
API Documentation
daithang-organization
Swagger/OpenAPI setup and documentation patterns for SE104_VLEAGUE