# ashutosh-narkar/openapi-to-rego architecture

> Architecture diagram of the GitHub repository ashutosh-narkar/openapi-to-rego, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ashutosh-narkar/openapi-to-rego
- Repository: https://github.com/ashutosh-narkar/openapi-to-rego

## Overview

##### 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]**

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        OpenAPI[OpenAPI 3.0 Spec Files]:::input
        OpenAPIYAML["YAML Specs"]:::input
        OpenAPIJSON["JSON Specs"]:::input
        OpenAPI --> OpenAPIYAML
        OpenAPI --> OpenAPIJSON
    end

    subgraph Processing
        CLI["CLI Interface"]:::core
        Loader["Loader Component"]:::core
        PolicyGen["Policy Generation Engine"]:::core
        
        CLI --> Loader
        Loader --> PolicyGen
    end

    subgraph "Extension Processors"
        BooleanFilter["Boolean Filter Processor"]:::extension
        FieldFilter["Field Filter Processor"]:::extension
        ListFilter["List Filter Processor"]:::extension
        OverwriteFilter["Overwrite Filter Processor"]:::extension
    end

    subgraph "Output Layer"
        RegoOutput["Rego Policy Output"]:::output
        FileWriter["File Writer Component"]:::output
    end

    OpenAPIYAML --> Loader
    OpenAPIJSON --> Loader

    PolicyGen --> BooleanFilter
    PolicyGen --> FieldFilter
    PolicyGen --> ListFilter
    PolicyGen --> OverwriteFilter

    BooleanFilter --> RegoOutput
    FieldFilter --> RegoOutput
    ListFilter --> RegoOutput
    OverwriteFilter --> RegoOutput

    RegoOutput --> FileWriter

    subgraph "Technical Notes"
        OperationsNote["Supported Operations:<br/>eq, lt, gte, membership"]:::note
        ConfigNote["Configuration Options:<br/>Package Name<br/>Output Filename<br/>Security Scheme"]:::note
    end

    %% Click Events
    click CLI "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/cmd/openapi-to-rego/main.go"
    click Loader "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/pkg/util/loader.go"
    click PolicyGen "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/pkg/opa/generate.go"
    click BooleanFilter "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/examples/petstore-rego-boolean-filter.yaml"
    click FieldFilter "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/examples/petstore-rego-field-filter.yaml"
    click ListFilter "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/examples/petstore-rego-list-filter.yaml"
    click OverwriteFilter "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/examples/petstore-rego-overwrite-filter.yaml"
    click OpenAPIYAML "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/examples/petstore.yaml"
    click OpenAPIJSON "https://github.com/ashutosh-narkar/openapi-to-rego/blob/master/examples/petstore.json"

    %% Styling
    classDef input fill:#2374ab,stroke:#000,stroke-width:2px,color:#fff
    classDef core fill:#57a773,stroke:#000,stroke-width:2px,color:#fff
    classDef extension fill:#ff8c42,stroke:#000,stroke-width:2px,color:#fff
    classDef output fill:#7d4e57,stroke:#000,stroke-width:2px,color:#fff
    classDef note fill:#f7d794,stroke:#000,stroke-width:1px,color:#000

    %% Legend
    subgraph Legend
        L1["Input Components"]:::input
        L2["Core Components"]:::core
        L3["Extension Processors"]:::extension
        L4["Output Components"]:::output
        L5["Technical Notes"]:::note
    end
```
