fix: editorial fixes

Signed-off-by: Dan Hudlow <[email protected]>

docs/openapi-ruleset-utilities.md

@@ -360,7 +360,7 @@ references.
 
 - **`schema`** `<object>`: simple or composite OpenAPI 3.x schema object
 - **`path`** `<Array>`: path array for the provided schema
-- **`validate`** `<function>`: a `(schema, path, logicalPath) => errors` function to validate a simple schema
+- **`validate`** `<function>`: a `(schema, path) => errors` function to validate a simple schema
 - **`includeSelf`** `<boolean>`: validate the provided schema in addition to its composed schemas (defaults to `true`)
 - **`includeNot`** `<boolean>`: validate schemas composed with `not` (defaults to `true`)
 
@@ -387,9 +387,9 @@ Nested schemas included via `allOf`, `oneOf`, and `anyOf` are validated, but com
 are not themselves validated. By default, nested schemas included via `not` are not validated.
 
 The provided validate function is called with three arguments:
-- `composedSchema`: the composed schema
-- `path`: the array of path segments to locate the composed schema within the resolved document
-- `logicalPath`: the array of path segments to locate an instance of `composedSchema` within an
+- `nestedSchema`: the nested schema
+- `path`: the array of path segments to locate the nested schema within the resolved document
+- `logicalPath`: the array of path segments to locate an instance of `nestedSchema` within an
    instance of `schema` (the schema for which `validateNestedSchemas()` was originally called.)
    Within the logical path, an arbitrary array item is represented by `[]` and an arbitrary
    dictionary property is represented by `*`.

packages/utilities/src/utils/validate-composed-schemas.js

@@ -36,7 +36,7 @@ const SchemaPath = require('./schema-path');
  * references.
  * @param {object} schema simple or composite OpenAPI 3.x schema object
  * @param {Array} path path array for the provided schema
- * @param {Function} validate a `(schema, path, logicalPath) => errors` function to validate a simple schema
+ * @param {Function} validate a `(schema, path) => errors` function to validate a simple schema
  * @param {boolean} includeSelf validate the provided schema in addition to its composed schemas (defaults to `true`)
  * @param {boolean} includeNot validate schemas composed with `not` (defaults to `true`)
  * @returns {Array} validation errors
@@ -59,7 +59,7 @@ function validateComposedSchemas(
 
   if (includeSelf) {
     // We intentionally do not use `path.logical` here because the documented external contract
-    // for validateComposedSchemas() is that the validate function is called with two arguments.
+    // for `validateComposedSchemas()` is that the validate function is called with two arguments.
     // Tracking the logical path is only useful when `validateComposedSchemas()` is embedded in
     // another utility that can pass it an instance of `SchemaPath` (which is not exported).
     errors.push(...validate(schema, [...path], p?.logical));

packages/utilities/src/utils/validate-nested-schemas.js

@@ -32,9 +32,9 @@ const SchemaPath = require('./schema-path');
  * are not themselves validated. By default, nested schemas included via `not` are not validated.
  *
  * The provided validate function is called with three arguments:
- * - `composedSchema`: the composed schema
- * - `path`: the array of path segments to locate the composed schema within the resolved document
- * - `logicalPath`: the array of path segments to locate an instance of `composedSchema` within an
+ * - `nestedSchema`: the nested schema
+ * - `path`: the array of path segments to locate the nested schema within the resolved document
+ * - `logicalPath`: the array of path segments to locate an instance of `nestedSchema` within an
  *    instance of `schema` (the schema for which `validateNestedSchemas()` was originally called.)
  *    Within the logical path, an arbitrary array item is represented by `[]` and an arbitrary
  *    dictionary property is represented by `*`.