openapi-schema-patterns

Official

Master advanced OpenAPI schema patterns.

Authorzerobias-org
Version1.0.0
Installs0

System Documentation

What problem does it solve?

OpenAPI schema design often struggles with preserving descriptive text when schemas are referenced, applying consistent pattern rules at scale, and aligning field naming with vendor APIs. This skill provides a structured approach to using allOf for description overrides, a clear naming hierarchy, and vendor-aware naming conventions to improve clarity, consistency, and maintainability.

Core Features & Use Cases

  • Enforces the single-ref allOf pattern to preserve descriptions while avoiding unintended composition.
  • Defines a Schema Naming Hierarchy (Resource, Info, Ref, Summary, ContextResource) for scalable and readable APIs.
  • Guides adherence to vendor naming conventions, including camelCase field names and preservation of prefixes like is/has/can, as well as proper timestamp and count field naming.

Quick Start

Apply the allOf single-ref pattern for description overrides, implement the Naming Hierarchy for schemas, and preserve vendor naming conventions in your OpenAPI designs.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: openapi-schema-patterns
Download link: https://github.com/zerobias-org/module/archive/main.zip#openapi-schema-patterns

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.