Rename parameter 'path' to 'jsonPath'

wtrocki · web-flow · commit 8766e6a38630 · 2025-03-06T11:21:02.000+01:00
diff --git a/tools/spectral/ipa/rulesets/functions/utils/collectionUtils.js b/tools/spectral/ipa/rulesets/functions/utils/collectionUtils.js
@@ -37,7 +37,7 @@ export function collectAdoption(jsonPath, ruleName) {
  * Collects an exception entry.
  *
  * @param object the object to evaluate
- * @param {Array<string>} path - The JSON path for the object where the rule exception occurred.
+ * @param {Array<string>} jsonPath - The JSON path array for the object where the rule violation occurred. Example: ["paths","./pets","get"]
  * @param {string} ruleName - The name of the rule that the exception is defined for.
  */
 export function collectException(object, ruleName, jsonPath) {

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ export function collectAdoption(jsonPath, ruleName) {`
`37`	`37`	`* Collects an exception entry.`
`38`	`38`	`*`
`39`	`39`	`* @param object the object to evaluate`
`40`		`- * @param {Array<string>} path - The JSON path for the object where the rule exception occurred.`
	`40`	`+ * @param {Array<string>} jsonPath - The JSON path array for the object where the rule violation occurred. Example: ["paths","./pets","get"]`
`41`	`41`	`* @param {string} ruleName - The name of the rule that the exception is defined for.`
`42`	`42`	`*/`
`43`	`43`	`export function collectException(object, ruleName, jsonPath) {`