smithery.ai

openapi-workflow

Proactive OpenAPI workflow. Triggers when OpenAPI spec files are modified to validate, regenerate code, and verify builds.

First seen Apr 1, 2026

Installation

$ npx skills add https://smithery.ai

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,161 B
  • docs SUMMARY.md 146 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

OpenAPI Workflow Skill

Automatically runs the OpenAPI workflow when spec files are modified.

When to Activate

This skill should activate when:

  • Files in backend/api/*.yaml are modified
  • New endpoints are added to OpenAPI spec
  • Request/response schemas are changed
  • User asks to add/modify API endpoints

OpenAPI Spec Location

Type Path Purpose
API Spec backend/api/openapi.yaml Public API definition

Workflow Steps

1. Validate Spec

python3 scripts/openapi_workflow.py --validate

2. Generate Code (All Platforms)

python3 scripts/openapi_workflow.py --codegen

This generates:

  • Backend (Go): backend/internal/generated/
  • iOS (Swift): mobile/ios/App/Generated/
  • Android (Kotlin): mobile/android/app/src/main/java/.../generated/
  • Web (TypeScript): web/src/generated/

3. Build Verification

python3 scripts/openapi_workflow.py --build

4. Full Workflow (All Steps)

python3 scripts/openapi_workflow.py --full

Critical Rules

Rule Why
Define response schemas properly Inline schemas don't generate reusable types
Use plural file names REST convention: users.yaml not user.yaml
Always regenerate after spec changes Generated code must match spec
Verify ALL platforms build API changes affect backend + iOS + Android + web

Process

  1. Detect OpenAPI spec was modified
  2. Run validation to catch syntax/semantic errors
  3. Regenerate code for all platforms
  4. Run build verification
  5. Report any failures

Output Format

## OpenAPI Workflow Results

**Spec Modified**: [file path]
**Validation**: ✅ Passed / ❌ Failed
**Code Generation**: ✅ All platforms / ❌ Failed for [platform]
**Build Verification**: ✅ All platforms / ❌ Failed for [platform]

[Details of any failures]

Reference

  • Script: scripts/openapi_workflow.py
  • Spec: backend/api/openapi.yaml