From 25a65be6e4262d02fe2151f2f5257ecc961ce726 Mon Sep 17 00:00:00 2001 From: rocketstack-matt Date: Fri, 19 Apr 2024 18:50:05 +0100 Subject: [PATCH 1/2] Minor changes to the spectral project README --- spectral/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spectral/README.md b/spectral/README.md index 7fb9a434..534caf19 100644 --- a/spectral/README.md +++ b/spectral/README.md @@ -1,5 +1,5 @@ -# Spectral validation rules for AasC implementations -These rules perform simple structural checks on Architecture-as-Code implementation files to verify that they make sense semantically. +# Spectral validation rules for CALM implementations +These rules perform simple structural checks on CALM implementation files to verify that they make sense semantically. For example, if a relationship references a node, then that node should exist in the file. ## Installing spectral @@ -25,5 +25,5 @@ spectral lint --ruleset aac.yaml implementation.json For example, to run the rulesets against the sample spec, which should produce several errors: ```bash -spectral lint --ruleset aac.yaml examples/bad-rest-api.json +spectral lint --ruleset ./instantiation/validation-rules.yaml ./examples/bad-rest-api.json ``` \ No newline at end of file From b0d3aeb66b13bf717ea5b90ac3fd27f33dd4f6fc Mon Sep 17 00:00:00 2001 From: rocketstack-matt Date: Fri, 19 Apr 2024 18:54:27 +0100 Subject: [PATCH 2/2] Add link to Spectral docs --- spectral/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/spectral/README.md b/spectral/README.md index 534caf19..7744f319 100644 --- a/spectral/README.md +++ b/spectral/README.md @@ -26,4 +26,7 @@ For example, to run the rulesets against the sample spec, which should produce s ```bash spectral lint --ruleset ./instantiation/validation-rules.yaml ./examples/bad-rest-api.json -``` \ No newline at end of file +``` + +## Learn more +See the [Spectral documentation](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview) for more information on how to configure the Spectral rules.