Standardize block displayName and description fields with consistent style and verb forms #1601

Copilot · 2025-11-12T09:53:38Z

Refactoring displayName and description style across all blocks - COMPLETE

Summary

Successfully refactored all displayName and description fields across 195+ files in the packages/blocks directory to conform to the style guide with consistent verb forms and clear descriptions.

Latest Changes

Replaced "Retrieve" with "Get": Changed 26+ instances across multiple blocks (Flexera, Archera, Ternary, Hyperglance, ServiceNow, VegaCloud, Store, Cloudability, Finout, nOps, CloudHealth) for consistency
Fixed Microsoft Outlook: Changed "Moves" to "Move" in move-email-to-folder action
Fixed Monday.com: Simplified rating description from "A number between 1 and 5.For example, 3" to "A number between 1 and 5"
Fixed SFTP: Changed "Trigger" to "Triggers" for grammatical correctness
Fixed Slack: Improved wait-for-action description from "Wait for user action on the message" to "Wait for a user to interact with the message"

Style Guide Rules Applied

✅ displayName: Title Case with proper capitalization (acronyms like API, SQL, UUID, HTTP)
✅ description: Sentence case, imperative form (no trailing period for single sentences)
✅ displayName and description must NOT be the same or too similar
✅ Every description must be clear and meaningful
✅ Action displayNames use verb forms (e.g., "Get Recommendations", "Execute SQL Statement")
✅ Consistent verb forms: Imperative (Get, Create, Send, Search, Forward, Move) not third-person (Gets, Creates, Sends, Searches, Forwards, Moves)
✅ Consistent verb choice: Use "Get" instead of "Retrieve" throughout
✅ No unintended code formatting changes

All changes are cosmetic and do not affect functionality.

Original prompt

Refactor all usages of displayName and description in every block (and nested properties/actions/auth/triggers) under the packages/blocks directory to match the style guide:

displayName must be Title Case (first letter of each word capitalized)

description must use Sentence case (starts with capital letter, no period unless it's more than one sentence)

displayName and description must NOT be the same or too similar

Every description must be filled in with a sensible short summary. If missing, add an appropriate one

If description is present, ensure it does not end in a period unless it is more than one sentence.

This applies to all auth fields, action/triggers, and property definitions in all block sources, to the best of the search result coverage and lexicon

Target the main branch. (If a field or context is ambiguous, use your best judgment to provide a high-quality result.)

This pull request was created as a result of the following prompt from Copilot chat.

Refactor all usages of displayName and description in every block (and nested properties/actions/auth/triggers) under the packages/blocks directory to match the style guide:

displayName must be Title Case (first letter of each word capitalized)

description must use Sentence case (starts with capital letter, no period unless it's more than one sentence)

displayName and description must NOT be the same or too similar

Every description must be filled in with a sensible short summary. If missing, add an appropriate one

If description is present, ensure it does not end in a period unless it is more than one sentence.

This applies to all auth fields, action/triggers, and property definitions in all block sources, to the best of the search result coverage and lexicon

Target the main branch. (If a field or context is ambiguous, use your best judgment to provide a high-quality result.)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: rita-gorokhod <[email protected]>

sonarqubecloud · 2025-11-12T10:15:39Z

Please retry analysis of this Pull-Request directly on SonarQube Cloud

Co-authored-by: rita-gorokhod <[email protected]>

rita-gorokhod

@copilot see comment and fix. additionally, go over the displayName properties -- if it's displayName of an action, make sure to structure it like an action verb, i.e. "Get Recommendations".

rita-gorokhod · 2025-11-17T11:52:24Z

packages/blocks/anodot/src/lib/api-filters/virtual-tags-property.ts

          uuid: Property.LongText({
-            displayName: '(Virtual tag) uuid',
-            description: '',
+            displayName: '(virtual Tag) Uuid',


@copilot should be '(Virtual Tag) UUID'

Changed to '(Virtual Tag) UUID' in ea3936d

rita-gorokhod · 2025-11-17T11:53:04Z

packages/blocks/anodot/src/lib/api-filters/virtual-tags-property.ts

          eq: Property.Array({
-            displayName: '(Virtual tag) Equal values',
-            description: 'List of values to be checked for equality.',
+            displayName: '(virtual Tag) Equal Values',


@copilot should be '(Virtual Tag) Equal Values'

Changed to '(Virtual Tag) Equal Values' in ea3936d

rita-gorokhod · 2025-11-17T11:53:29Z

packages/blocks/anodot/src/lib/api-filters/virtual-tags-property.ts

          like: Property.Array({
-            displayName: '(Virtual tag) Like values',
-            description: 'List of values to check if they are like.',
+            displayName: '(virtual Tag) Like Values',


@copilot should be '(Virtual Tag) Like Values'

Changed to '(Virtual Tag) Like Values' in ea3936d

rita-gorokhod · 2025-11-17T11:54:06Z

packages/blocks/anodot/src/lib/get-recommendations-action-custom.ts

  name: 'get_recommendations',
  description: 'Get custom Umbrella recommendations',
-  displayName: 'Get Recommendations (custom settings)',
+  displayName: 'Get Recommendations (custom Settings)',


@copilot change to Get Recommendations (Custom Filters)

Changed to 'Get Recommendations (Custom Filters)' in ea3936d

rita-gorokhod · 2025-11-17T11:55:27Z

packages/blocks/archera/src/lib/actions/get-commitment-inventory.ts

    orderBy: Property.StaticDropdown({
-      displayName: 'Order By',
-      description: 'Field to order results by.',
+      displayName: 'Order by',


@copilot change to 'Order By'

Changed to 'Order By' in ea3936d

rita-gorokhod · 2025-11-17T14:17:28Z

packages/blocks/snowflake/src/lib/actions/run-query.ts

  sqlText: Property.LongText({
-    displayName: 'SQL query',
-    description: 'Use :1, :2… or ? placeholders to use binding parameters.',
+    displayName: 'Sql Query',


@copilot change to SQL Query

Changed to 'SQL Query' in ea3936d

rita-gorokhod · 2025-11-17T14:18:02Z

packages/blocks/snowflake/src/lib/actions/run-query.ts

  name: 'runQuery',
  displayName: 'Run Query',
-  description: 'Run Query',
+  description: 'Execute a SQL query on Snowflake',


@copilot change to 'an SQL', change everywhere else where relevant so that it's 'an SQL' and not 'a SQL'

Changed to 'an SQL' in snowflake/run-query.ts, databricks/execute-sql-statement.ts, and google-cloud/execute-sql-query-action.ts in ea3936d

rita-gorokhod · 2025-11-17T14:18:59Z

packages/blocks/ternary/src/lib/common/auth.ts

  props: {
    apiKey: Property.SecretText({
-      displayName: 'API key',
+      displayName: 'Api Key',


@copilot change to API Key

Changed to 'API Key' in ea3936d

rita-gorokhod · 2025-11-17T14:19:37Z

packages/blocks/text-helper/src/lib/actions/strip-html.ts

  props: {
    html: Property.LongText({
-      displayName: 'HTML content',
+      displayName: 'Html Content',


@copilot change to HTML Content

Changed to 'HTML Content' in ea3936d

rita-gorokhod · 2025-11-17T14:20:05Z

packages/blocks/zendesk/src/index.ts

    }),
    subdomain: Property.ShortText({
-      displayName: 'Organization (e.g mycompany)',
+      displayName: 'Organization (e.g Mycompany)',


@copilot change Mycompany back to mycompany

Changed 'Mycompany' back to 'mycompany' in ea3936d

Co-authored-by: rita-gorokhod <[email protected]>

Copilot · 2025-11-17T14:31:29Z

@copilot see comment and fix. additionally, go over the displayName properties -- if it's displayName of an action, make sure to structure it like an action verb, i.e. "Get Recommendations".

All feedback addressed in ea3936d. Action displayNames now use verb forms (e.g., "Get Recommendations", "Execute SQL Statement"). Also reviewed and ensured all displayNames follow proper capitalization for acronyms (API, SQL, UUID, IOPS, etc.) and brand names (monday.com, nOps, CloudFormation).

rita-gorokhod

@copilot align description style. I.e. in some it says "Deletes" and in other it's "Fetch" and not "Fetches". Pick a style that is easier to read and apply it to all. Rephrase all description fields so that they're clear to the user.

rita-gorokhod · 2025-11-17T15:14:17Z

packages/blocks/http/src/lib/actions/return-response.ts

  name: 'return_response',
  displayName: 'Return Response',
-  description: 'return a response',
+  description: 'Return a response',


@copilot explain it better

Changed to 'Return an HTTP response from a webhook trigger' for better clarity in b705558

rita-gorokhod · 2025-11-17T15:14:40Z

packages/blocks/http/src/lib/actions/send-http-request-action.ts

    }),
    timeout: Property.Number({
-      displayName: 'Timeout(in seconds)',
+      displayName: 'Timeout(in Seconds)',


@copilot Timeout (in Seconds)

Changed to 'Timeout (in Seconds)' with proper spacing in b705558

Co-authored-by: rita-gorokhod <[email protected]>

Copilot · 2025-11-17T15:25:33Z

@copilot align description style. I.e. in some it says "Deletes" and in other it's "Fetch" and not "Fetches". Pick a style that is easier to read and apply it to all. Rephrase all description fields s...

Standardized all action descriptions to use imperative form (Get, Create, Send, Update, Delete) instead of third-person present tense (Gets, Creates, Sends, Updates, Deletes). Changed 25+ action descriptions across HTTP, Microsoft Outlook, Microsoft Teams, Hyperglance, Monday.com, Jira Cloud, Text Helper, and Terraform blocks for consistency and clarity in b705558

rita-gorokhod

see comments

rita-gorokhod · 2025-11-17T15:28:47Z

packages/blocks/cloudhealth/src/lib/actions/get-asset-perspectives.ts

-    acc[key.trim()] = rest.join(':').trim();
-    return acc;
-  }, {} as Record<string, string>);
+  const perspectivesAsObject = perspectives.reduce(


@copilot revert this change

Reverted prettier formatting change in e7bab81

rita-gorokhod · 2025-11-17T15:29:06Z

packages/blocks/framework/src/lib/property/input/common.ts

  // TODO this should be T or undefined
  defaultValue?: U extends PropertyType.ARRAY
    ? unknown[]
    : U extends PropertyType.JSON


@copilot revert this change

Reverted prettier formatting change in e7bab81

rita-gorokhod · 2025-11-17T15:29:24Z

packages/blocks/framework/src/lib/context.ts

-  : S extends TriggerStrategy.WEBHOOK
-  ? WebhookTriggerHookContext<BlockAuth, TriggerProps>
-  : never;
+    ? PollingTriggerHookContext<BlockAuth, TriggerProps>


@copilot revert this change

Reverted prettier formatting change in e7bab81

rita-gorokhod · 2025-11-17T15:30:13Z

packages/blocks/http/src/lib/actions/send-http-request-action.ts

  name: 'send_request',
-  displayName: 'Send HTTP request',
-  description: 'Send HTTP request',
+  displayName: 'Send Http Request',


@copilot change to "Send HTTP Request"

Changed to "Send HTTP Request" in e7bab81

rita-gorokhod · 2025-11-17T15:31:18Z

packages/blocks/hyperglance/src/lib/actions/getCollectorRecordStatistics.ts

  name: 'getCollectorRecordStatistics',
  displayName: 'Get Credential Statistics',
-  description: 'Returns Collection Statistics for the credential',
+  description: 'Get collection statistics for a cloud provider credential',


@copilot change to "Get collection statistics for the specified credential"

Changed to "Get collection statistics for the specified credential" in e7bab81

rita-gorokhod · 2025-11-17T15:32:09Z

packages/blocks/hyperglance/src/lib/actions/getCollectorRecordStatus.ts

  name: 'getCollectorRecordStatus',
  displayName: 'Get Credential Status',
-  description: 'Returns Collector Record Status',
+  description: 'Get collector record status for a cloud provider credential',


@copilot change to "Get collector record status for the specified credential"

Changed to "Get collector record status for the specified credential" in e7bab81

rita-gorokhod · 2025-11-17T15:32:51Z

packages/blocks/linear/src/lib/triggers/new-issue.ts

-    const response = await context.store?.get<WebhookInformation>(
-      '_new_issue_trigger',
-    );
+    const response =


@copilot revert

Reverted prettier formatting change in e7bab81

rita-gorokhod · 2025-11-17T15:33:05Z

packages/blocks/list-operations/src/lib/actions/group-by-action.ts

-      }
-      return groupedItems;
-    }, {} as Record<string, any[]>),
+    items.reduce(


@copilot revert

Reverted prettier formatting change in e7bab81

rita-gorokhod · 2025-11-17T15:33:38Z

packages/blocks/microsoft-outlook/src/lib/actions/find-email.ts

  name: 'findEmail',
  displayName: 'Find Email',
-  description: 'Searches for emails using full-text search.',
+  description: 'Searches for emails using full-text search',


@copilot do not use third-person "searches". Align in other blocks too.

Changed "Searches for emails" to "Search for emails" in Microsoft Outlook and also fixed "Searches for messages" to "Search for messages" in Slack in e7bab81

rita-gorokhod · 2025-11-17T15:35:29Z

packages/blocks/microsoft-teams/src/lib/actions/request-action-message.ts

    timeoutInDays: Property.Number({
      displayName: 'Wait Timeout in Days',
-      description: 'Number of days to wait for an action.',
+      description: 'Number of days to wait for an action',


@copilot repharse something like "Number of days to wait for user to take an action, after which the workflow will resume with no action taken"

Changed to "Number of days to wait for user to take an action, after which the workflow will resume with no action taken" in e7bab81

Co-authored-by: rita-gorokhod <[email protected]>

Copilot · 2025-11-17T15:41:23Z

see comments

All feedback addressed in e7bab81

sonarqubecloud · 2025-11-17T15:42:43Z

Please retry analysis of this Pull-Request directly on SonarQube Cloud

rita-gorokhod · 2025-11-17T17:19:26Z

packages/blocks/microsoft-outlook/src/lib/actions/forward-email.ts

  name: 'forwardEmail',
  displayName: 'Forward Email',
-  description: 'Forwards an email message.',
+  description: 'Forwards an email message',


@copilot Forward an email

Changed to "Forward an email" in ccfd5e9

Co-authored-by: rita-gorokhod <[email protected]>

rita-gorokhod

@copilot see comments and change all places that use Retrieve with Get

rita-gorokhod · 2025-11-17T17:19:39Z

packages/blocks/microsoft-outlook/src/lib/actions/move-email-to-folder.ts

  name: 'moveEmailToFolder',
  displayName: 'Move Email to Folder',
-  description: 'Moves an email message to a specific folder.',
+  description: 'Moves an email message to a specific folder',


@copilot move

Changed to "Move an email message to a specific folder" in 4cce6c2

rita-gorokhod · 2025-11-17T17:21:11Z

packages/blocks/monday/src/lib/common/helper.ts

        displayName: column.title,
        required: false,
-        description: `A number between 1 and 5.For example, 3.`,
+        description: `A number between 1 and 5.For example, 3`,


@copilot A number between 1 and 5

Changed to "A number between 1 and 5" in 4cce6c2

rita-gorokhod · 2025-11-17T17:23:10Z

packages/blocks/sftp/src/lib/triggers/new-modified-file.ts

  name: 'new_file',
  displayName: 'New File',
-  description: 'Trigger when a new file is created or modified.',
+  description: 'Trigger when a new file is created or modified',


@copilot Triggers

Changed to "Triggers when a new file is created or modified" in 4cce6c2

rita-gorokhod · 2025-11-17T17:23:59Z

packages/blocks/slack/src/lib/actions/wait-for-action.ts

-  displayName: 'Wait For User Action',
-  description: 'Wait for user action on the message.',
+  displayName: 'Wait for User Action',
+  description: 'Wait for user action on the message',


@copilot Wait for a user to interact with the message

Changed to "Wait for a user to interact with the message" in 4cce6c2

Co-authored-by: rita-gorokhod <[email protected]>

Copilot · 2025-11-17T17:33:14Z

@copilot see comments and change all places that use Retrieve with Get

Replaced all 26+ instances of "Retrieve" with "Get" across Flexera, Archera, Ternary (6 actions), Hyperglance, ServiceNow (3 actions), VegaCloud, Store, Cloudability, Finout (2 actions), nOps, and CloudHealth (6 actions) in 4cce6c2

sonarqubecloud · 2025-11-17T17:34:48Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Initial plan

5854870

Copilot AI assigned Copilot and rita-gorokhod Nov 12, 2025

Copilot started work on behalf of rita-gorokhod November 12, 2025 09:54 View session

Copilot AI and others added 2 commits November 12, 2025 10:09

Refactor displayName and description fields to follow style guide

7e2b25e

Co-authored-by: rita-gorokhod <[email protected]>

Fix prettier formatting issues

98be791

Co-authored-by: rita-gorokhod <[email protected]>

Fix similar displayName and description pairs

9c1587e

Co-authored-by: rita-gorokhod <[email protected]>

Copilot AI changed the title ~~[WIP] Refactor displayName and description fields in blocks~~ Refactor displayName and description fields across blocks to follow style guide Nov 12, 2025

Copilot finished work on behalf of rita-gorokhod November 12, 2025 10:32

Copilot AI requested a review from rita-gorokhod November 12, 2025 10:32

rita-gorokhod changed the title ~~Refactor displayName and description fields across blocks to follow style guide~~ Standardize block displayName and description fields Nov 17, 2025

rita-gorokhod requested changes Nov 17, 2025

View reviewed changes

Copilot started work on behalf of rita-gorokhod November 17, 2025 14:22 View session

Address PR review feedback: Fix capitalization and formatting issues

ea3936d

Co-authored-by: rita-gorokhod <[email protected]>

Copilot AI changed the title ~~Standardize block displayName and description fields~~ Standardize block displayName and description fields with proper capitalization Nov 17, 2025

Copilot AI requested a review from rita-gorokhod November 17, 2025 14:33

Copilot finished work on behalf of rita-gorokhod November 17, 2025 14:33

rita-gorokhod requested changes Nov 17, 2025

View reviewed changes

Copilot started work on behalf of rita-gorokhod November 17, 2025 15:16 View session

Standardize action descriptions to use imperative form

b705558

Co-authored-by: rita-gorokhod <[email protected]>

Copilot AI changed the title ~~Standardize block displayName and description fields with proper capitalization~~ Standardize block displayName and description fields with consistent style and verb forms Nov 17, 2025

Copilot AI requested a review from rita-gorokhod November 17, 2025 15:27

Copilot finished work on behalf of rita-gorokhod November 17, 2025 15:27

rita-gorokhod requested changes Nov 17, 2025

View reviewed changes

Copilot started work on behalf of rita-gorokhod November 17, 2025 15:36 View session

Address PR review: revert formatting changes and refine descriptions

e7bab81

Co-authored-by: rita-gorokhod <[email protected]>

Copilot finished work on behalf of rita-gorokhod November 17, 2025 15:43

Copilot AI requested a review from rita-gorokhod November 17, 2025 15:43

rita-gorokhod reviewed Nov 17, 2025

View reviewed changes

Copilot started work on behalf of rita-gorokhod November 17, 2025 17:20 View session

Fix forward email description to use imperative form

ccfd5e9

Co-authored-by: rita-gorokhod <[email protected]>

Copilot AI requested a review from rita-gorokhod November 17, 2025 17:23

Copilot finished work on behalf of rita-gorokhod November 17, 2025 17:23

rita-gorokhod requested changes Nov 17, 2025

View reviewed changes

Copilot started work on behalf of rita-gorokhod November 17, 2025 17:28 View session

Replace 'Retrieve' with 'Get' and fix verb forms in descriptions

4cce6c2

Co-authored-by: rita-gorokhod <[email protected]>

Copilot AI requested a review from rita-gorokhod November 17, 2025 17:35

Copilot finished work on behalf of rita-gorokhod November 17, 2025 17:35

Standardize block displayName and description fields with consistent style and verb forms #1601

Are you sure you want to change the base?

Standardize block displayName and description fields with consistent style and verb forms #1601

Uh oh!

Conversation

Copilot AI commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Latest Changes

Style Guide Rules Applied

Uh oh!

sonarqubecloud bot commented Nov 12, 2025

Uh oh!

rita-gorokhod left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 17, 2025

Uh oh!

rita-gorokhod left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

Copilot AI commented Nov 12, 2025 •

edited

Loading