openapi-specification-v2

SKILL.md

Complete reference for writing, validating, and interpreting OpenAPI Specification 2.0 (Swagger) documents.

Covers all core schema elements: Swagger Object root, Info/Contact/License metadata, Paths, Operations, Parameters (path, query, header, body, formData), Responses, and Schemas with composition and polymorphism support

Includes security definitions for Basic auth, API Key, and OAuth2 flows (implicit, password, application, accessCode) with scope and requirement objects

Provides reference guidance for $ref usage, JSON Pointers, external file references, and root-level parameter/response/schema reuse

Addresses data types, formats, MIME types, HTTP status codes, path templating, headers, and vendor extensions (x- prefix)

Includes best practices for operationId, tags, responses, and spec authoring patterns

OpenAPI Specification 2.0 (formerly Swagger 2.0) defines a JSON/YAML format for describing RESTful APIs: paths, operations, parameters, responses, schemas, and security. Use this skill when creating or editing Swagger 2.0 specs, validating structure, or generating code/documentation from them.

The skill is based on OpenAPI Specification 2.0, generated at 2026-01-30.

Core References