Skip to content

fix(ipa): Add ignore list for nouns in OperationID Validation #901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 19, 2025
Merged

fix(ipa): Add ignore list for nouns in OperationID Validation #901

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
65b20d2
Add ignore list and refactor logic into singularize method
Aug 18, 2025
f1ec293
Update comment
sphterry Aug 18, 2025
97d448f
PATCH version bump
Aug 18, 2025
1d6e1e4
Move ignore list to functionOptions
Aug 19, 2025
692d974
Add tests for ignoreList
Aug 19, 2025
dd8b404
Revert "PATCH version bump"
Aug 19, 2025
506eec0
Alter name to 'ignorePluralizationList' and add documentation
Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions tools/spectral/ipa/rulesets/functions/utils/operationIdGeneration.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import { isPathParam, removePrefix, isSingleResourceIdentifier } from './resourc
const CAMEL_CASE = /[A-Z]?[a-z]+/g;
const CAMEL_CASE_WITH_ABBREVIATIONS = /[A-Z]+(?![a-z])|[A-Z]*[a-z]+/g;

// List of capitalized nouns that should not be pluralized in any case.
const IGNORE_LIST = ['Fts'];

/**
* Returns IPA Compliant Operation ID.
*
Expand Down Expand Up @@ -40,7 +43,7 @@ export function generateOperationID(method, path) {

let opID = verb;
for (let i = 0; i < nouns.length - 1; i++) {
opID += inflection.singularize(nouns[i]);
opID += singularize(nouns[i]);
}

// singularize final noun, dependent on resource identifier - leave custom nouns alone
Expand All @@ -49,7 +52,7 @@ export function generateOperationID(method, path) {
!camelCaseCustomMethod) ||
verb === 'create'
) {
nouns[nouns.length - 1] = inflection.singularize(nouns[nouns.length - 1]);
nouns[nouns.length - 1] = singularize(nouns[nouns.length - 1]);
}

opID += nouns.pop();
Expand Down Expand Up @@ -92,3 +95,10 @@ function deriveActionVerb(method) {
function capitalize(val) {
return String(val).charAt(0).toUpperCase() + String(val).slice(1);
}

function singularize(noun) {
if (!IGNORE_LIST.includes(noun)) {
return inflection.singularize(noun);
}
return noun;
}
Loading