Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: adding documentation on rules #262

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: adding documentation on rules #262

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a3eb0c
Adding documentation on rules
elnyry-sam-k Apr 7, 2021
b8a8939
Update README.md
elnyry-sam-k Apr 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,31 @@ For more information on anchore and anchore-cli, refer to:
- [Anchore CLI](https://github.com/anchore/anchore-cli)
- [Circle Orb Registry](https://circleci.com/orbs/registry/orb/anchore/anchore-engine)

## About rules.json

The rules.json file acts as a rules engine and enables defining rules that can accept or reject quotes. A rule is defined as an object with a title, a conditions object, and an event object. A rule specifies that if certain conditions are met, then the specified event will be generated.

The rules engine used by the quoting-service is an off-the-shelf rules engine, called json-rules-engine. For detailed information on how to write rules, see the [json-rules-engine](https://github.com/CacheControl/json-rules-engine/blob/master/docs/rules.md) documentation. This page only focuses on those details that are relevant for adding support for new currencies.

### Conditions
elnyry-sam-k marked this conversation as resolved.
Show resolved Hide resolved

Conditions are a combination of facts, paths, operators, and values.

Each rule's conditions must have either an all or an any operator at its root, containing an array of conditions. The all operator specifies that all conditions must be met for the rule to be applied. The any operator only requires one condition to be met for the rule to be applied.

Operators within the individual conditions can take the following values:

equal: fact must equal value (string or numeric value)
notEqual: fact must not equal value (string or numeric value)
in: fact must be included in value (an array)
notIn: fact must not be included in value (an array)
contains: fact (an array) must include value
doesNotContain: fact (an array) must not include value

### Events

Event objects must have a type property, and an optional params property. There are two types of events:

INTERCEPT_QUOTE: Used for redirecting quote requests.
- `INTERCEPT_QUOTE`: Used for redirecting quote requests.
- `INVALID_QUOTE_REQUEST`: Used for validation rules. You do not have to use this type of event when adding support for new currencies.