openapi-spec-conventions
CommunityOpenAPI specs, SDKs, and sandbox routing guidelines.
Software Engineering#architecture#documentation#openapi#conventions#sandbox#api-design#sdk-generation
Authorearayu
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Clarifies how to structure and evolve OpenAPI specs, SDK generation, and sandbox proxy path conventions to prevent drift.
Core Features & Use Cases
- Defines and maintains the three-tier OpenAPI artifacts (full, public/SDK-focused, and runtime/docs) and their roles.
- Standardizes sandbox proxy path conventions and operationId tagging to ensure consistent codegen and docs.
- Provides guidance for updating tooling and docs when API routes or OpenAPI tags change.
Quick Start
Follow these conventions whenever adding or modifying API routes, regenerating the Python SDK, or updating sandbox proxy paths in docs.
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 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-spec-conventions Download link: https://github.com/earayu/treadstone/archive/main.zip#openapi-spec-conventions Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.