Rename parameter 'path' to 'jsonPath'

wtrocki · web-flow · commit a3c1bb9eae56 · 2025-03-06T11:14:51.000+01:00
diff --git a/tools/spectral/ipa/rulesets/functions/utils/collectionUtils.js b/tools/spectral/ipa/rulesets/functions/utils/collectionUtils.js
@@ -26,7 +26,7 @@ export function collectAndReturnViolation(jsonPath, ruleName, errorData) {
 /**
  * Collects an adoption entry.
  *
- * @param {Array<string>} path - The JSON path for the object where the rule adoption 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 was adopted.
  */
 export function collectAdoption(jsonPath, ruleName) {

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ export function collectAndReturnViolation(jsonPath, ruleName, errorData) {`
`26`	`26`	`/**`
`27`	`27`	`* Collects an adoption entry.`
`28`	`28`	`*`
`29`		`- * @param {Array<string>} path - The JSON path for the object where the rule adoption occurred.`
	`29`	`+ * @param {Array<string>} jsonPath - The JSON path array for the object where the rule violation occurred. Example: ["paths","./pets","get"]`
`30`	`30`	`* @param {string} ruleName - The name of the rule that was adopted.`
`31`	`31`	`*/`
`32`	`32`	`export function collectAdoption(jsonPath, ruleName) {`