agentleFS
muyenmuyen/vibe-to-prod/.claude/skills/openapi-workflow/SKILL.md

openapi-workflow

Skill34 starsChanged 11 months agoMITView on GitHub

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

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run validation to catch syntax/semantic errors

    line 64

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
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

TypePathPurpose
API Specbackend/api/openapi.yamlPublic 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

RuleWhy
Define response schemas properlyInline schemas don't generate reusable types
Use plural file namesREST convention: users.yaml not user.yaml
Always regenerate after spec changesGenerated code must match spec
Verify ALL platforms buildAPI 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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.