Skills openapi-spec-generation

📦

openapi-spec-generation

Name: openapi-spec-generation
Author: sickn33

Content revision r2 Safe 🌐 Network access⚙️ External commands

Generate Reliable OpenAPI 3.1 Specifications

Incomplete API contracts cause integration errors and weak documentation. This skill creates OpenAPI 3.1 specifications using design-first, code-first, validation, and SDK generation patterns.

Supports: Claude Codex Code(CC)

🥉 78 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request

Review the Skillstore skill "openapi-spec-generation" from https://skillstore.io/skills/sickn33-openapi-spec-generation.md and its manifest at https://skillstore.io/api/skills/sickn33-openapi-spec-generation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Your Agent should still show its plan and request any confirmation required by the security policy.

Agent-readable resources

Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.

Markdown detail GET /skills/sickn33-openapi-spec-generation.md Signed manifest GET /api/skills/sickn33-openapi-spec-generation/manifest Signed lockfile GET /api/skills/sickn33-openapi-spec-generation/lockfile

Test it

Using "openapi-spec-generation". Create a contract for listing and creating users with bearer authentication.

Expected outcome:

An OpenAPI 3.1 contract covering user list and creation operations.
Reusable user, pagination, and error models with request and response examples.
Bearer authentication requirements and documented success and failure responses.

Using "openapi-spec-generation". Review a FastAPI service for missing OpenAPI details.

Expected outcome:

A prioritized gap report for operation identifiers, errors, schema constraints, and security metadata.
Recommended component reuse and consistent naming changes.
A verification checklist for generated documentation and contract behavior.

Using "openapi-spec-generation". Prepare SDK delivery for TypeScript, Python, and Go.

Expected outcome:

A staged workflow for linting, bundling, and generating three client libraries.
Language-specific package settings and output locations.
Release checks for contract validity and generated client consistency.

Security Audit

Safe

v5 • 8/4/2026 Open versioned report

All 21 static findings are false positives. The URLs are documentation examples, the reconnaissance matches are ordinary schema terms, and the backticks mark Markdown file paths rather than executable commands.

Files scanned

1,070

Lines analyzed

Review items

False positives ignored

Risk Factors

🌐 Network access (8)

resources/implementation-playbook.md:28 resources/implementation-playbook.md:66 resources/implementation-playbook.md:69 resources/implementation-playbook.md:72 resources/implementation-playbook.md:74 resources/implementation-playbook.md:76 resources/implementation-playbook.md:532 resources/implementation-playbook.md:533

⚙️ External commands (2)

SKILL.md:32 SKILL.md:36

No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.

Audited by: codex View Audit History →

Share & cite this report

Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.

Open versioned report

Copy report link

https://skillstore.io/skills/sickn33-openapi-spec-generation/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-openapi-spec-generation/security.svg)](https://skillstore.io/skills/sickn33-openapi-spec-generation?utm_source=security_passport_badge)

HTML badge

<a href="https://skillstore.io/skills/sickn33-openapi-spec-generation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-openapi-spec-generation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Embed card

<iframe src="https://skillstore.io/embed/skills/sickn33-openapi-spec-generation.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Academic citations (APA · BibTeX · CFF)

APA citation

sickn33. (2026). openapi-spec-generation security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-openapi-spec-generation/audits/5

BibTeX citation

@techreport{sickn33-sickn33-openapi-spec-generation-2026,
  author = {sickn33},
  title = {openapi-spec-generation security audit report (audit version 5)},
  institution = {Skillstore},
  year = {2026},
  number = {5},
  url = {https://skillstore.io/skills/sickn33-openapi-spec-generation/audits/5},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "openapi-spec-generation security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
  - name: "sickn33"
date-released: "2026-08-04"
url: "https://skillstore.io/skills/sickn33-openapi-spec-generation/audits/5"
identifiers:
  - type: other
    value: "skillstore:sickn33-openapi-spec-generation:audit:5"
    description: "Skillstore immutable audit report identifier"

Compare variants

2 installable variants

Each author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.

Why this variant is first

Highest Skillstore Score

Author / source Skillstore Score Evidence Confidence Skillstore usage Updated

sickn33 Recommended Current

sickn33-openapi-spec-generation

Skillstore Score 78

Evidence Confidence High

Skillstore usage 17

Updated

2026-08-21

wshobson

wshobson-openapi-spec-generation

Skillstore Score 76

Evidence Confidence High

Skillstore usage 14

Updated

2026-08-21

Skillstore Score

Why this score Evidence Confidence: High

Architecture

Maintainability

Content

Community

Spec Compliance

What You Can Build

Design a New API Contract

Create a complete OpenAPI 3.1 contract before implementation, including resources, errors, authentication, examples, and pagination.

Document an Existing Service

Translate FastAPI or TypeScript endpoint definitions into a consistent specification with reusable components.

Standardize Delivery Checks

Define linting, bundling, documentation, and SDK generation steps for an API release pipeline.

Try These Prompts

Draft a Basic Contract

Create an OpenAPI 3.1 specification for [API purpose]. Include these endpoints: [list]. Ask for any missing models, errors, or authentication requirements.

Convert Existing Endpoints

Review the supplied [FastAPI or tsoa] code and derive an OpenAPI 3.1 contract. Identify undocumented responses, inconsistent models, and missing security definitions.

Harden an API Contract

Audit this OpenAPI 3.1 contract for reusable components, complete errors, examples, pagination, operation IDs, authentication, and schema constraints. Propose prioritized corrections.

Plan Validation and SDK Delivery

Design a validation and SDK generation workflow for this specification. Include Spectral, Redocly, release checks, and clients for [target languages].

Best Practices

Provide real endpoint behavior, models, error cases, authentication rules, and examples before generating the contract.
Reuse schemas, parameters, and responses through components to prevent inconsistent definitions.
Run linting, bundling, and contract tests before publishing documentation or generated SDKs.

Avoid

Do not keep placeholder URLs, identities, or sample values in a production specification.
Do not omit error responses, security requirements, or schema constraints to shorten the contract.
Do not generate SDKs from an unvalidated or outdated specification.

Frequently Asked Questions

Which OpenAPI version does this skill target?

It targets OpenAPI 3.1 and uses features and structures appropriate for that version.

Can it generate a specification from existing code?

Yes. It provides code-first patterns for FastAPI and TypeScript services using tsoa.

Can it create a design-first API contract?

Yes. Provide the resources, operations, models, errors, authentication, and business constraints.

Does it validate specifications automatically?

It can prepare Spectral and Redocly workflows. Execution requires available tools and user authorization.

Can it generate client SDKs?

It provides OpenAPI Generator workflows for TypeScript, Python, and Go clients.

Does a generated contract guarantee API compliance?

No. Validate the specification and run contract tests against the actual implementation.

Developer Details

Author

sickn33

License

MIT

Skillstore revision

Version notice

The author did not declare a version.

Repository

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/openapi-spec-generation

Ref

81e05e636292629114b76cbb3922fbe57672fc02

Maintenance freshness

8/5/2026

Usage

15 downloads · 114 views

File structure

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md