fix

Author: yelizhenden-mdb

tools/spectral/ipa/rulesets/functions/eachEnumValueMustBeUpperSnakeCase.js

@@ -1,13 +1,17 @@
 import { hasException } from './utils/exceptions.js';
-import { getSchemaPath, resolveObject } from './utils/componentUtils.js';
+import { resolveObject } from './utils/componentUtils.js';
 import { casing } from '@stoplight/spectral-functions';
 
 const RULE_NAME = 'xgen-IPA-123-enum-values-must-be-upper-snake-case';
 const ERROR_MESSAGE = 'enum value must be UPPER_SNAKE_CASE.';
 
+export function getSchemaPathFromEnumPath(path) {
+  return path.slice(0, path.length - 1);
+}
+
 export default (input, _, { path, documentInventory }) => {
   const oas = documentInventory.resolved;
-  const schemaPath = getSchemaPath(path);
+  const schemaPath = getSchemaPathFromEnumPath(path);
   const schemaObject = resolveObject(oas, schemaPath);
   if (hasException(schemaObject, RULE_NAME)) {
     return;

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

@@ -13,46 +13,6 @@ export function isPathParam(str) {
   return pathParamRegEx.test(str) || pathParamWithCustomMethodRegEx.test(str);
 }
 
-/**
- * Extracts the schema path from the given JSONPath array.
- *
- * This function handles the following types of paths in OpenAPI definitions:
- *
- * 1. **Component Schema Paths**:
- *    - Represented as: `components.schemas.schemaName.enum`
- *    - This path indicates that the enum is defined directly within a schema under `components.schemas`.
- *    - The function returns the first three elements (`["components", "schemas", "schemaName"]`).
- *
- * 2. **Component Schema Property Paths**:
- *    - Represented as: `components.schemas.schemaName.properties.propertyName.enum`
- *    - This path indicates that the enum is defined for a specific property of a schema.
- *    - The function returns up to the property level (`["components", "schemas", "schemaName", "properties", "propertyName"]`).
- *
- * 3. **Parameter Schema Paths**:
- *    - Represented as: `paths.*.method.parameters[*].schema.enum`
- *    - This path indicates that the enum is part of a parameter's schema in an operation.
- *    - The function identifies the location of `schema` in the path and returns everything up to (and including) it.
- *
- * @param {string[]} path - An array representing the JSONPath structure of the OpenAPI definition.
- * @returns {string[]} The truncated path pointing to the schema object or property.
- */
-
-export function getSchemaPath(path) {
-  if (path.includes('components')) {
-    const propertyIndex = path.findIndex((item) => item === 'properties');
-    if (propertyIndex !== -1) {
-      // Path is for a component.schema.property enum
-      return path.slice(0, propertyIndex + 2);
-    }
-    // Path is for a component.schema enum
-    return path.slice(0, 3);
-  } else if (path.includes('paths')) {
-    const schemaIndex = path.findIndex((item) => item === 'schema');
-    return path.slice(0, schemaIndex + 1);
-  }
-  return [];
-}
-
 /**
  * Resolves the value of a nested property within an OpenAPI structure using a given path.
  *