Skip to content
TrustedSkillsbeta
Back to all skills

Writing Openapi Specs

Checked
speakeasy-api·vlatest·backend·Apache-2.0

Generates OpenAPI specifications from code comments and API endpoints using Speakeasy's conventions.

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 speakeasy-api/sdk-generation-skills --skill writing-openapi-specs -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

speakeasy-api

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 speakeasy-api/skills at d2eab5991e.

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

Commit
d2eab5991e
Manifest
skills/writing-openapi-specs/SKILL.md
Scanned
9 files, 6,164 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

The writing-openapi-specs skill enables AI agents to generate OpenAPI specifications based on natural language descriptions or existing codebases. It automates the creation of API documentation, ensuring consistent schema definitions and endpoint structures without manual YAML or JSON editing.

When to use it

  • Rapidly prototype new API endpoints by describing desired functionality in plain English.
  • Convert legacy monolithic code into well-documented, modular OpenAPI schemas for microservices migration.
  • Generate client SDKs or server stubs directly from high-level business requirement documents.
  • Standardize API documentation across a team to ensure uniform naming conventions and data types.

Key capabilities

  • Generates valid OpenAPI 3.x specifications from text prompts.
  • Infers data models and request/response schemas based on context.
  • Supports generation for various programming language ecosystems.
  • Outputs ready-to-use YAML or JSON configuration files.

Example prompts

  • "Create an OpenAPI spec for a user authentication service with login, logout, and profile update endpoints."
  • "Generate an OpenAPI specification for a REST API that manages inventory levels across multiple warehouses."
  • "Write an OpenAPI 3.0 spec for a payment processing gateway supporting credit cards and PayPal."

Tips & gotchas

Ensure your prompts include specific details about data types, authentication methods, and error handling to reduce the need for iterative refinement. While the skill generates valid syntax, manually reviewing complex logic flows is recommended before deploying to production environments.