skills.rest
zerobias-org
zerobias-orgOFFICIAL
Explore all skills by this author →
WebsiteGitHub

openapi-foundations

Enforce ten core OpenAPI rules for servers, naming, and parameters.

6|Updated Feb 20, 2025
Search Tags:#openapi#validation#camelcase#naming-conventions#api-design#path-structure#parameter-scope
One-click install
npx skills add https://github.com/zerobias-org/module --skill openapi-foundations
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openapi-foundations
Source: https://github.com/zerobias-org/module/tree/main/.claude/skills/openapi-foundations
Command: npx skills add https://github.com/zerobias-org/module --skill openapi-foundations

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

OpenAPI design discipline is often violated, leading to inconsistent servers, naming, and parameter usage. This skill codifies core OpenAPI rules 1-10 to ensure uniform, high-quality API specifications.

Core Features & Use Cases

  • Enforces the 10 core rules across OpenAPI specs, including server placement, resource naming, and parameter structure.
  • Guides authoring and review workflows to maintain camelCase property names, consistent path parameters, and complete operation coverage.
  • Use Case: A product team audits new API specs to ensure compliance before PR merge.

Quick Start

Validate your OpenAPI document against the 10 core rules and surface violations.

Frequently Asked Questions about openapi-foundations

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent naming conventions and path structure in OpenAPI specifications?▼

Validate your OpenAPI document against the 10 core rules to surface violations in server placement, parameter reuse via components, path parameter descriptiveness, and tag conventions. This maps to ten rules governing root-level configuration, delivering a production-ready validation standard.

What are the best practices for parameter scoping and reuse in OpenAPI documents?▼

Parameter scoping and reuse in OpenAPI documents are best practices enforced by codifying core rules for parameters. Ensure proper parameter reuse via components, consistent path parameters, and descriptive path parameter definitions to maintain uniform, high-quality API specifications.

Can I audit my API specs for camelCase properties and tag conventions before a PR merge?▼

Validating OpenAPI documents requires no external dependencies. The validation standard operates independently to check root-level configuration, parameter reuse via components, and tag conventions, allowing teams to integrate it directly into their existing API review workflows.

Why does my OpenAPI validation fail on root-level server configuration and resource naming?▼

OpenAPI validation fails on root-level server configuration and resource naming when specifications violate core design rules. The validation standard governs server placement, resource naming, and parameter structure, surfacing these violations to ensure uniform, high-quality API specifications.

Related Skills

Explore More Software Engineering Skills→
docktermjdocktermj

module-05-data-quality-mapping

Evaluates source data quality and maps fields to Senzing Generic Specification.

Community
Advanced
lloydchanglloydchang
2

babysit-pr

Automate GitHub PR monitoring, retries, conflict resolution, and auto-merge management.

Community
Advanced
oimiragieooimiragieo
36

scaffolder

Generate boilerplate code for React, Vue, and Angular projects from rule sets.

Community
Basic
amiable-devamiable-dev
38

council-gate

Evaluate pull requests with LLM Council and produce pass/fail/unclear verdicts.

Community
Advanced