Skip to content

Conversation

lovisaberggren
Copy link
Collaborator

Proposed changes

Adds new rule xgen-IPA-117-operation-summary-single-item-wording for guideline:

API Producers must use "One" when referring to a single item instead of "a" or "specified".

The rule checks that the summary property of operations does not use the words "a", "specified" or "provided"

15 violations, will fix in follow-up.

Jira ticket: CLOUDP-319114

@lovisaberggren lovisaberggren marked this pull request as ready for review August 20, 2025 15:32
@lovisaberggren lovisaberggren requested a review from a team as a code owner August 20, 2025 15:32
},
errors: [
{
code: 'xgen-IPA-117-operation-summary-single-item-wording',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For multiple forbidden words, we would have multiple errors. Is it correct?
Such as Return a resource for the specified project

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! I added a test case as example

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@lovisaberggren lovisaberggren merged commit cb2c62e into main Aug 20, 2025
11 checks passed
@lovisaberggren lovisaberggren deleted the CLOUDP-319114 branch August 20, 2025 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants