Apply suggestions from Lovisa code review

Co-authored-by: Lovisa Berggren <[email protected]>

Author: wtrocki

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

@@ -6,11 +6,11 @@ rules:
     description: >-
       Collection identifiers must be in camelCase. Logic includes:<br/>
       - All path segments that are not path parameters<br/>
-      - Only the resource identifier part before any colon in custom method paths (e.g., 'resource' in '/resource:customMethod')<br/>
+      - Only the resource identifier part before any colon in custom method paths (e.g., `resource` in `/resource:customMethod`)<br/>
       - Path parameters should also follow camelCase naming<br/>
       - Certain values can be exempted via the ignoredValues configuration (e.g., 'v1', 'v2') that can be supplied as `ignoredValues` 
       argument to the rule<br/>
-      - Paths with x-xgen-IPA-exception for this rule are excluded from validation<br/>
+      - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation<br/>
       http://go/ipa/102
     message: '{{error}} http://go/ipa/102'
     severity: warn

tools/spectral/ipa/rulesets/functions/utils/schemaUtils.js

@@ -1,6 +1,6 @@
 /**
  * Checks if the object has results property
- * @param {*} schema
+ * @param {Object} schema
  * @returns true if schema object returns results property (pagination), false otherwise
  */
 export function schemaIsPaginated(schema) {
@@ -11,7 +11,7 @@ export function schemaIsPaginated(schema) {
 /**
  * Checks if schema is an array type of schema
  *
- * @param {*} schema
+ * @param {Object} schema
  * @returns
  */
 export function schemaIsArray(schema) {