How ashutosh-narkar/openapi-to-rego works
Main Components
a) Input Processing Layer:
• An input node for OpenAPI 3.0 specifications (YAML/JSON files)
• Loader component (from pkg/util/loader.go)
b) Core Processing Layer:
• Policy Generation Engine (pkg/opa/generate.go)
• Extension Processors for different filter types:
• Boolean Filter Processor
• Field Filter Processor
• Filter Processor
• Overwrite Filter Processor
c) Output Layer:
• Rego Policy Output Generator
• File Writer Component
Flow and Relationships
[OpenAPI Spec Files] → [Loader Component] → [Policy Generation Engine]
• ↓
• [Extension Processors (4 types)] ←→ [Policy Generation Engine]
• ↓
• [Rego Policy Output] ← [Policy Writer Component]
Important Details
• Annotations showing supported operations:
• eq (Equality)
• lt (Less than)
• gte (Greater than or equal)
• membership (Membership)
• Configuration options:
• Package name specification
• Output filename configuration
• Security scheme integration
Technical Specifications
A technical notes section showing:
• Supported OpenAPI version (3.0)
• Input formats (YAML/JSON)
• Extension points:
• x-security-rego-boolean-filter
• x-security-rego-field-filter
• x-security-rego-list-filter
• x-security-rego-overwrite-filter
Implementation Details
Main processing pipeline:
[Input] → [Parse OpenAPI] → [Process Extensions] → [Generate Rego] → [Output]