Skip to content

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ouvreboite authored Jun 15, 2024
1 parent e6184b1 commit 49be649
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,23 +52,23 @@ paths:
type: string
```
3. The spectral.base.yaml is:
3. The Spectral base file is defined in [spectral.base.yaml](examples/simple/spectral.base.yaml):
```yaml
formats: ["oas3"]
rules:
#rules will be injected by poltergust
```

4. Running poltegust:
4. Let's run poltegust:
```bash
npx poltergust .\examples\simple
🔎 Testing the spectral rules from the .md files in the directory: .\examples\simple
👻 operation-parameters-must-have-description (examples\simple\README.md:6)
✅ Test OK (examples\simple\README.md:18)
✅ Spectral rules merged in the file: examples\simple\spectral.yaml
```

4. The aggregated Spectral ruleset can be found [here](examples/simple/spectral.yaml)
It found the rule and run the corresponding test case.
Then it created [spectral.yaml](examples/simple/spectral.yaml) that contains the rule merged into the base file.

```yaml
formats: ["oas3"]
Expand Down

0 comments on commit 49be649

Please sign in to comment.