Skip to content

Commit b9d5607

Browse files
address the comments
1 parent c632cd6 commit b9d5607

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ rules:
1616
argument to the rule
1717
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
1818
- Double slashes (//) are not allowed in paths
19+
- If any parent path has an exception for this rule, the exception will be inherited.
1920
2021
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-102-collection-identifier-camelCase'
2122
severity: error
@@ -38,6 +39,8 @@ rules:
3839
- Even-indexed path segments should be resource names (not path parameters)
3940
- Odd-indexed path segments should be path parameters
4041
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
42+
- If any parent path has an exception for this rule, the exception will be inherited.
43+
4144
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-102-path-alternate-resource-name-path-param'
4245
severity: error
4346
given: '$.paths'
@@ -57,6 +60,7 @@ rules:
5760
- Custom methods (segments containing colons) are excluded from validation
5861
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
5962
- Each non-parameter path segment must start with a lowercase letter followed by any combination of ASCII letters and numbers
63+
- If any parent path has an exception for this rule, the exception will be inherited.
6064
6165
message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-102-collection-identifier-pattern'
6266
severity: error

tools/spectral/ipa/rulesets/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Collection identifiers must be in camelCase.
4444
argument to the rule
4545
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
4646
- Double slashes (//) are not allowed in paths
47+
- If any parent path has an exception for this rule, the exception will be inherited.
4748

4849
#### xgen-IPA-102-path-alternate-resource-name-path-param
4950

@@ -57,6 +58,7 @@ Rule checks for the following conditions:
5758
- Even-indexed path segments should be resource names (not path parameters)
5859
- Odd-indexed path segments should be path parameters
5960
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
61+
- If any parent path has an exception for this rule, the exception will be inherited.
6062

6163
#### xgen-IPA-102-collection-identifier-pattern
6264

@@ -71,6 +73,7 @@ Rule checks for the following conditions:
7173
- Custom methods (segments containing colons) are excluded from validation
7274
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
7375
- Each non-parameter path segment must start with a lowercase letter followed by any combination of ASCII letters and numbers
76+
- If any parent path has an exception for this rule, the exception will be inherited.
7477

7578

7679

0 commit comments

Comments
 (0)