From 6f2f3062cec9199fff013f3ba7f5d3b96f216438 Mon Sep 17 00:00:00 2001 From: Pierre Troger Date: Wed, 9 Oct 2024 17:41:31 +0200 Subject: [PATCH] format readme --- .../resource/open-policy-agent/rego/README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/apps/policy-engine/src/resource/open-policy-agent/rego/README.md b/apps/policy-engine/src/resource/open-policy-agent/rego/README.md index a6efac0d6..3b9cd4e54 100644 --- a/apps/policy-engine/src/resource/open-policy-agent/rego/README.md +++ b/apps/policy-engine/src/resource/open-policy-agent/rego/README.md @@ -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** \ No newline at end of file +**this shouldn't be imported in production code**