rule-openapi

Enforce OpenAPI documentation and schema generation rules for Flask API projects.

1|1|Updated Mar 31, 2026

Search Tags:#versioning #documentation #api #openapi #flask #schemas #marshmallow

Ready to run

npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill rule-openapi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: rule-openapi
Source: https://github.com/btabaska/simpler-grants-documentation-automation/tree/main/.claude/skills/rule-openapi
Command: npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill rule-openapi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

OpenAPI rules govern how API documentation, schema metadata, and versioning are maintained, preventing manual edits to OpenAPI specs and ensuring a single source of truth.

Core Features & Use Cases

Center-source of truth for OpenAPI documentation generated from Flask/APIFlask blueprints and Marshmallow schemas.
Always attach @blueprint.doc with summary, description, responses, security, and tags to every route.
Enforce versioning discipline (e.g., /v1, /v2) and deprecations with clear notes and non-breaking changes.

Quick Start

Run a single step to integrate OpenAPI rules into your Flask project and regenerate the spec after schema or route updates.

Frequently Asked Questions about rule-openapi

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

FAQPage Schema

How do I automate OpenAPI spec generation from Flask and Marshmallow schemas?▼

You automate OpenAPI spec generation by using centralized rules that derive documentation directly from Flask APIFlask blueprints and Marshmallow schemas, preventing manual edits to the spec.

How do I enforce API versioning rules for Flask blueprints?▼

API versioning rules for Flask blueprints enforce strict versioned endpoints like /v1 and /v2, requiring clear deprecation notes and non-breaking changes to maintain backward compatibility across API versions.

Does the OpenAPI enforcement work with existing Marshmallow schemas?▼

OpenAPI enforcement applies directly to existing Marshmallow schema files, requiring consistent metadata on fields to ensure accurate documentation generation within your Flask API project.

Why does manual editing of OpenAPI specs cause documentation drift?▼

Manual editing of OpenAPI specs causes documentation drift because it breaks the single source of truth, leading to discrepancies between the spec and the actual Flask route implementations.

What is the best way to document Flask API routes with @blueprint.doc?▼

Documenting Flask API routes with @blueprint.doc requires attaching summary, description, responses, security, and tags to every route, ensuring complete and standardized OpenAPI documentation across the project.

How do I add security schemes to OpenAPI documentation in a Flask API?▼

Security schemes in Flask API OpenAPI documentation are defined using proper @blueprint.doc usage, attaching security metadata to routes to enforce consistent authentication and authorization rules across endpoints.