Skip to content

fix(ipa): Account for abbreviations in op ID names #868

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 2 commits into from
Aug 5, 2025
Merged

fix(ipa): Account for abbreviations in op ID names #868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37146f7
CLOUDP-335986: Account for abbreviations in op ID names
lovisaberggren Aug 5, 2025
46908b1
CLOUDP-335986: Fix
lovisaberggren Aug 5, 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
4 changes: 4 additions & 0 deletions tools/spectral/ipa/__tests__/utils/operationIdGeneration.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ describe('tools/spectral/ipa/utils/operationIdGeneration.js', () => {
expect(numberOfWords('createGroup')).toEqual(2);
expect(numberOfWords('createGroupCluster')).toEqual(3);
expect(numberOfWords('createGroupClusterIndex')).toEqual(4);
expect(numberOfWords('getOpenAPIInfo')).toEqual(4);
expect(numberOfWords('getCustomDNS')).toEqual(3);
expect(numberOfWords('')).toEqual(0);
});
});
Expand All @@ -68,6 +70,8 @@ describe('tools/spectral/ipa/utils/operationIdGeneration.js', () => {
'createAutoScalingConfiguration'
);
expect(shortenOperationId('getFederationSettingConnectedOrgConfigRoleMapping')).toEqual('getConfigRoleMapping');
expect(shortenOperationId('getGroupAwsCustomDNS')).toEqual('getAwsCustomDNS');
expect(shortenOperationId('getExampleOpenAPIInfo')).toEqual('getOpenAPIInfo');
});

it('should make no change if the operation ID is <= 4 words long or undefined', () => {
Expand Down
7 changes: 4 additions & 3 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 @@ -2,6 +2,7 @@ const inflection = require('inflection');
import { isPathParam, removePrefix, isSingleResourceIdentifier } from './resourceEvaluation.js';

const CAMEL_CASE = /[A-Z]?[a-z]+/g;
const CAMEL_CASE_WITH_ABBREVIATIONS = /[A-Z]+(?![a-z])|[A-Z]*[a-z]+/g;

/**
* Returns IPA Compliant Operation ID.
Expand Down Expand Up @@ -57,12 +58,12 @@ export function generateOperationID(method, path) {
}

/**
* Counts the number of words in a camelCase string.
* Counts the number of words in a camelCase string. Allows for abbreviations (e.g. 'getOpenAPI').
* @param operationId
* @returns {number}
*/
export function numberOfWords(operationId) {
return operationId.match(CAMEL_CASE)?.length || 0;
return operationId.match(CAMEL_CASE_WITH_ABBREVIATIONS)?.length || 0;
}

/**
Expand All @@ -71,7 +72,7 @@ export function numberOfWords(operationId) {
* @returns {string}
*/
export function shortenOperationId(operationId) {
const words = operationId.match(CAMEL_CASE);
const words = operationId.match(CAMEL_CASE_WITH_ABBREVIATIONS);
if (!words || words.length < 4) {
return operationId; // Return as is if there are not enough words to shorten
}
Expand Down
Loading