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.
In this repository9 other files it gives its agents.
- openspec/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- code-reviewSkill
- continuous-improvementSkill
- dev-workflowSkill
- git-workflowSkill
- ralph-invokeSkill
- security-scanSkill
- systematic-debuggingSkill
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
- Distinctive: line 64
Run validation to catch syntax/semantic errors
≈ “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.
Files
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/*.yamlare 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 --validate2. Generate Code (All Platforms)
python3 scripts/openapi_workflow.py --codegenThis 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 --build4. Full Workflow (All Steps)
python3 scripts/openapi_workflow.py --fullCritical 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
- Detect OpenAPI spec was modified
- Run validation to catch syntax/semantic errors
- Regenerate code for all platforms
- Run build verification
- 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
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
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.

