Skip to content

Commit

Permalink
format readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ptroger committed Oct 9, 2024
1 parent e8bc358 commit 6f2f306
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions apps/policy-engine/src/resource/open-policy-agent/rego/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,38 @@

# Packages

## Main

The implementation of engine general logic. This package is the one were transpiled policy are written
Transpiled policies then use Armory/criteria functions to evaluate input

## Armory

### Constants

These package contains all constants that are used by production code

### Criteria

Criteria contains the function that build the logic for every transpiled policy.
**This package should have exactly the same number of files as we have supported criteria**

### Feeds

Criteria that needs to access our feeds should be depending from this package

### Entities

Functions used to query loaded data. It serves as a source of truth to know if something is in data.entities.
- Enforce invariants like lowercasing hex addresses
- Aggregate data from multiple places in entity in order to build useful relationships
- build runtime types that depends on entity data result

- Enforce invariants like lowercasing hex addresses
- Aggregate data from multiple places in entity in order to build useful relationships
- build runtime types that depends on entity data result

### Lib

Utils that are not domain specific, like case insensitive comparison or time.

### Test_Data

Values that are specifically used by tests.
**this shouldn't be imported in production code**
**this shouldn't be imported in production code**

0 comments on commit 6f2f306

Please sign in to comment.