Skip to content
TrustedSkillsbeta
Back to all skills

Api Reference Documentation

Checked
secondsky·vlatest·writing·MIT

Helps with API, documentation as part of writing, documentation, and content creation workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add secondsky/claude-skills --skill api-reference-documentation -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

secondsky

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned secondsky/claude-skills at 8837836131.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
8837836131
Manifest
plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.md
Scanned
1 file, 93 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill assists with creating comprehensive API documentation for developer integration, following the OpenAPI 3.0 specification. It helps generate documentation that includes endpoint descriptions, parameter details (like limit and category), request/response examples, authentication methods, and error responses. The goal is to produce clear and usable documentation for developers integrating with an API.

When to use it

  • When you need to create documentation for a new or existing API.
  • To ensure consistent formatting and structure in your API reference materials.
  • For generating developer-friendly guides that explain how to interact with your API, including authentication and error handling.
  • When migrating an existing API and needing to document breaking changes.

Key capabilities

  • Supports OpenAPI 3.0 specification (version 3.0.3).
  • Generates documentation for endpoints, parameters, and responses.
  • Includes descriptions of authentication methods (bearerAuth using JWT).
  • Provides guidance on best practices like including request/response examples and maintaining version documentation.
  • Suggests tools such as Swagger Editor/UI, Redoc, Postman Documentation, and Stoplight.

Example prompts

  • "Generate API documentation for the /products endpoint."
  • "Document the authentication process using bearer tokens (JWT)."
  • "Create a migration guide for changes to version 1.0.0 of the E-Commerce API."

Tips & gotchas

  • The skill is designed around the OpenAPI 3.0 specification, so familiarity with this standard will be helpful.
  • Ensure you have clear endpoint definitions and schemas available as input for the documentation generation process.