diff --git a/tools/spectral/ipa/rulesets/README.md b/tools/spectral/ipa/rulesets/README.md index f1e80fea76..cb05ad2565 100644 --- a/tools/spectral/ipa/rulesets/README.md +++ b/tools/spectral/ipa/rulesets/README.md @@ -10,7 +10,7 @@ Below is a list of all available rules, their descriptions and severity levels. ### IPA-005 -Rule is based on [http://go/ipa/IPA-5](http://go/ipa/IPA-5). +Rules are based on [http://go/ipa/IPA-5](http://go/ipa/IPA-5). #### xgen-IPA-005-exception-extension-format @@ -27,7 +27,7 @@ Rule checks for the following conditions: ### IPA-102 -Rule is based on [http://go/ipa/IPA-102](http://go/ipa/IPA-102). +Rules are based on [http://go/ipa/IPA-102](http://go/ipa/IPA-102). #### xgen-IPA-102-path-alternate-resource-name-path-param @@ -76,7 +76,7 @@ Rule checks for the following conditions: ### IPA-104 -Rule is based on [http://go/ipa/IPA-104](http://go/ipa/IPA-104). +Rules are based on [http://go/ipa/IPA-104](http://go/ipa/IPA-104). #### xgen-IPA-104-resource-has-GET @@ -147,7 +147,7 @@ Rule checks for the following conditions: ### IPA-105 -Rule is based on [http://go/ipa/IPA-105](http://go/ipa/IPA-105). +Rules are based on [http://go/ipa/IPA-105](http://go/ipa/IPA-105). #### xgen-IPA-105-list-method-response-code-is-200 @@ -178,7 +178,7 @@ Validation checks that the List method 200 OK response contains items property w ### IPA-106 -Rule is based on [http://go/ipa/IPA-106](http://go/ipa/IPA-106). +Rules are based on [http://go/ipa/IPA-106](http://go/ipa/IPA-106). #### xgen-IPA-106-create-method-request-body-is-request-suffixed-object @@ -228,7 +228,7 @@ Validation checks that the Create method 201 Created response contains reference ### IPA-107 -Rule is based on [http://go/ipa/IPA-107](http://go/ipa/IPA-107). +Rules are based on [http://go/ipa/IPA-107](http://go/ipa/IPA-107). #### xgen-IPA-107-put-must-not-have-query-params @@ -268,7 +268,7 @@ Validation checks the PATCH method for single resource paths and [singleton reso ### IPA-108 -Rule is based on [http://go/ipa/IPA-108](http://go/ipa/IPA-108). +Rules are based on [http://go/ipa/IPA-108](http://go/ipa/IPA-108). #### xgen-IPA-108-delete-response-should-be-empty @@ -290,7 +290,7 @@ DELETE method must not have request body. ### IPA-109 -Rule is based on [http://go/ipa/IPA-109](http://go/ipa/IPA-109). +Rules are based on [http://go/ipa/IPA-109](http://go/ipa/IPA-109). #### xgen-IPA-109-custom-method-must-be-GET-or-POST @@ -304,7 +304,7 @@ The custom method must use camelCase format. ### IPA-113 -Rule is based on [http://go/ipa/IPA-113](http://go/ipa/IPA-113). +Rules are based on [http://go/ipa/IPA-113](http://go/ipa/IPA-113). #### xgen-IPA-113-singleton-must-not-have-id @@ -314,7 +314,7 @@ Singleton resources must not have a user-provided or system-generated ID. ### IPA-123 -Rule is based on [http://go/ipa/IPA-123](http://go/ipa/IPA-123). +Rules are based on [http://go/ipa/IPA-123](http://go/ipa/IPA-123). #### xgen-IPA-123-enum-values-must-be-upper-snake-case diff --git a/tools/spectral/ipa/scripts/generateRulesetReadme.js b/tools/spectral/ipa/scripts/generateRulesetReadme.js index 5565d53690..c74d6c0574 100644 --- a/tools/spectral/ipa/scripts/generateRulesetReadme.js +++ b/tools/spectral/ipa/scripts/generateRulesetReadme.js @@ -34,7 +34,7 @@ async function getRulesetsSection() { ipaNumbers.forEach((ipaNumber) => { const ipaRules = filterRulesByIpaNumber(ipaNumber, rules); const sections = generateRulesetSections(ipaRules); - content += `### ${ipaNumber}\n\n` + `Rule is based on ${getIpaRulesetUrl(ipaNumber)}.\n\n` + `${sections}\n\n`; + content += `### ${ipaNumber}\n\n` + `Rules are based on ${getIpaRulesetUrl(ipaNumber)}.\n\n` + `${sections}\n\n`; }); return content;