complex

Complex example

• This example contains rules accross several markdown files: rules1.md and rules2.md and even subdirectories subdirectory/subrules.md
  • ✅ All the test declared in those files are expected to pass
• Some of the rules use custom functions defined in the functions directory
• spectral.base.yaml contains the base rule files that will be used to merge the rules into. For example, it contains the extends, aliases and functions declarations
• spectral.yaml is the output of the merge operation: spectral.base.yaml + all the rules found in rules1.md and rules2.md

Test ouput

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
PS C:\Users\jb.muscat\sources\GitHub\api-guidelines> npx poltergust .\examples\complex
🔎 Testing the spectral rules from the .md files in the directory: .\examples\complex
👻 base-path-must-start-with-slash (examples\complex\rules1.md:39)
  ✅ Test OK (examples\complex\rules1.md:16)
  ✅ Test OK (examples\complex\rules1.md:26)
👻 operation-parameters-must-have-description (examples\complex\rules1.md:90)
  ✅ Test OK (examples\complex\rules1.md:57)
  ✅ Test OK (examples\complex\rules1.md:72)
👻 operation-must-have-description (examples\complex\rules1.md:106)
👻 operation-must-have-no-summary (examples\complex\rules1.md:121)
👻 operation-must-have-at-least-one-response (examples\complex\rules1.md:134)
👻 path-parameters-must-be-kebab-case (examples\complex\rules2.md:49)
  ✅ Test OK (examples\complex\rules2.md:11)
👻 required-property-must-exist (examples\complex\rules2.md:96)
  ✅ Test OK (examples\complex\rules2.md:66)
👻 request-bodies-must-have-a-content (examples\complex\subdirectory\subrules.md:41)
  ✅ Test OK (examples\complex\subdirectory\subrules.md:8)
  ✅ Test OK (examples\complex\subdirectory\subrules.md:25)
✅ Spectral rules merged in the file: examples\complex\spectral.yaml