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

docs(repo): update custom ruleset with multiple thens example #2208

Merged
merged 2 commits into from Jul 19, 2022
Merged

docs(repo): update custom ruleset with multiple thens example #2208

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
544c0c9
docs(repo): add multiple thens example
heitortsergent Jul 18, 2022
0b14a6c
docs(repo): prettier
heitortsergent Jul 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/guides/4-custom-rulesets.md
View file
Open in desktop
Expand Up @@ -86,7 +86,7 @@ rules:

The `then` part of the rule explains which function to apply to the `given` JSONPath. The function you apply [may be one of the core functions](../reference/functions.md) or it may be [a custom function](./5-custom-functions.md).

`then` has two required keywords:
`then` has two main keywords:

```yaml
then:
Expand Down Expand Up @@ -115,6 +115,22 @@ responses:
foo: bar
```

You can also have multiple `then`s to target different properties in the same object, or to use different functions. For example, you can have one rule that will check if an object has multiple properties:

```yaml
contact-properties:
description: Contact object must have "name", "url", and "email".
given: $.info.contact
severity: warn
then:
- field: name
function: truthy
- field: url
function: truthy
- field: email
function: truthy
```

### Message

To help you create meaningful messages for results, Spectral comes with a couple of placeholders that are evaluated at runtime.
Expand Down