Skip to content

CLOUDP-305862: change plural form in docs #547

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

Merged
merged 1 commit into from
Mar 18, 2025
Merged

CLOUDP-305862: change plural form in docs #547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions tools/spectral/ipa/rulesets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion tools/spectral/ipa/scripts/generateRulesetReadme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading