Skip to content

Commit 693f032

Browse files
author
Sophia Marie Terry
committed
Refine rule description
1 parent f89df57 commit 693f032

File tree

7 files changed

+12
-24
lines changed

7 files changed

+12
-24
lines changed

tools/spectral/ipa/rulesets/IPA-104.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,7 @@ rules:
107107
##### Implementation details
108108
Rule checks for the following conditions:
109109
- Applies only to GET methods on single resources or singleton resources
110-
- Generates the expected OperationId given the resource identifier
111-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
110+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
112111
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-104-valid-operation-id'
113112
severity: warn
114113
given: '#GetOperationObject'

tools/spectral/ipa/rulesets/IPA-105.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,7 @@ rules:
8787
Rule checks for the following conditions:
8888
- Applies only to GET methods on resource collection paths
8989
- Ignores singleton resources
90-
- Generates the expected OperationId given the resource identifier
91-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
90+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
9291
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-105-valid-operation-id'
9392
severity: warn
9493
given: '#GetOperationObject'

tools/spectral/ipa/rulesets/IPA-106.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,7 @@ rules:
121121
##### Implementation details
122122
Rule checks for the following conditions:
123123
- Applies only to POST methods on resource collection paths
124-
- Generates the expected OperationId given the resource identifier
125-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
124+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
126125
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-106-valid-operation-id'
127126
severity: warn
128127
given: '#CreateOperationObject'

tools/spectral/ipa/rulesets/IPA-107.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,7 @@ rules:
122122
##### Implementation details
123123
Rule checks for the following conditions:
124124
- Validation checks the PATCH/PUT methods for single resource paths and [singleton resources](https://go/ipa/113).
125-
- Generates the expected OperationId given the resource identifier
126-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
125+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
127126
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-107-valid-operation-id'
128127
severity: warn
129128
given: '#UpdateOperationObject'

tools/spectral/ipa/rulesets/IPA-108.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,7 @@ rules:
6363
##### Implementation details
6464
Rule checks for the following conditions:
6565
- Applies to all DELETE methods for single resource endpoints (with path parameters)
66-
- Generates the expected OperationId given the resource identifier
67-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
66+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
6867
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-108-valid-operation-id'
6968
severity: warn
7069
given: '#DeleteOperationObject'

tools/spectral/ipa/rulesets/IPA-109.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ rules:
6969
##### Implementation details
7070
Rule checks for the following conditions:
7171
- Applies only to paths containing custom method identifiers (with colon format)
72-
- Generates the expected OperationId given the resource identifier and the method name portion following the colon
73-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
72+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
7473
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-109-valid-operation-id'
7574
severity: warn
7675
given: '$.paths[*][*]'

tools/spectral/ipa/rulesets/README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,7 @@ If the resource is a singleton resource, the last noun may be the plural form of
149149
##### Implementation details
150150
Rule checks for the following conditions:
151151
- Applies only to GET methods on single resources or singleton resources
152-
- Generates the expected OperationId given the resource identifier
153-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
152+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
154153

155154

156155

@@ -216,8 +215,7 @@ The noun(s) in the Operation ID should be the collection identifiers from the re
216215
Rule checks for the following conditions:
217216
- Applies only to GET methods on resource collection paths
218217
- Ignores singleton resources
219-
- Generates the expected OperationId given the resource identifier
220-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
218+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
221219

222220

223221

@@ -308,8 +306,7 @@ The noun(s) in the Operation ID should be the collection identifiers from the re
308306
##### Implementation details
309307
Rule checks for the following conditions:
310308
- Applies only to POST methods on resource collection paths
311-
- Generates the expected OperationId given the resource identifier
312-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
309+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
313310

314311

315312

@@ -392,8 +389,7 @@ If the resource is a singleton resource, the last noun may be the plural form of
392389
##### Implementation details
393390
Rule checks for the following conditions:
394391
- Validation checks the PATCH/PUT methods for single resource paths and [singleton resources](https://go/ipa/113).
395-
- Generates the expected OperationId given the resource identifier
396-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
392+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
397393

398394

399395

@@ -448,8 +444,7 @@ The noun(s) in the Operation ID should be the collection identifiers from the re
448444
##### Implementation details
449445
Rule checks for the following conditions:
450446
- Applies to all DELETE methods for single resource endpoints (with path parameters)
451-
- Generates the expected OperationId given the resource identifier
452-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
447+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
453448

454449

455450

@@ -509,8 +504,7 @@ The noun(s) in the Operation ID should be the collection identifiers from the re
509504
##### Implementation details
510505
Rule checks for the following conditions:
511506
- Applies only to paths containing custom method identifiers (with colon format)
512-
- Generates the expected OperationId given the resource identifier and the method name portion following the colon
513-
- Confirms that the existing operationId is compliant with generated IPA Compliant OperationId
507+
- Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
514508

515509

516510

0 commit comments

Comments
 (0)