api-documentation SKILL.md skillA
api-documentation from sickn33/agentic-awesome-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add sickn33/agentic-awesome-skills/api-documentation@git:20261014.4259ebcPins git:20261014.4259ebc in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- sickn33/agentic-awesome-skills
- Path
plugins/agentic-awesome-skills-claude/skills/api-documentation/SKILL.md- Versions recorded
- 2
- Latest version
- git:20261014.4259ebc, committed Oct 14, 2026
- First version recorded
- Jul 8, 2026
- Size
- 4,279 bytes
- Repository stars
- 49,308
- License
- MIT
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# API Documentation Workflow ## Overview Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation. ## When to Use This Workflow Use this workflow when: - Creating API documentation - Generating OpenAPI specs - Writing developer guides - Adding code examples - Setting up API portals ## Scope and execution Choose the phases that match the user’s task; this document is an index, not an instruction to run every listed skill. Read a selected skill before using it. Respect repository and user constraints. Cloud calls, host configuration, publishing, destructive operations and spending require the applicable authorization; a workflow checklist does not grant it. Base the contract on the actual implementation/specification and keep secrets out of examples. “Try it” can send real requests: use explicit sandbox endpoints and test credentials. Preview documentation locally before publishing; deployment is a separate authorized action. ## Workflow Phases ### Phase 1: API Discovery #### Skills to Invoke - `api-documenter` - API documentation - `api-design-principles` - API design …
Read the whole file at its exact version.
How to install
mdr add sickn33/agentic-awesome-skills/api-documentation@sha256:6b111ef252cce0dfThe line at the top of this page pins the label git:20261014.4259ebc, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_dsg5hedspytedkyc)
6 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jul 8, 2026 and Oct 14, 2026, about one every 98 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261014.4259ebc latest | 2026-10-14 | 4259ebc | 4,279 B | A | view · diff |
| git:20260708.a07936c | 2026-07-08 | a07936c | 3,605 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (4279 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
sickn33/agentic-awesome-skills · 49,308 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_dsg5hedspytedkyc GET https://markdownregistry.com/api/v1/resolve?ref=sickn33/agentic-awesome-skills/api-documentation GET https://markdownregistry.com/api/v1/blob/6b111ef252cce0df1bb640a4c7448aed16e15bf0da54ec14db74e7d045b61f83
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from sickn33/agentic-awesome-skills
Every file in sickn33/agentic-awesome-skills