fix: rename 'risky' changes to 'requires attention'

Author: b41ex

docs/Agent User Guide.md

@@ -42,7 +42,7 @@ To see the results go to Validation Results step. For each service for which a s
 ">
   <div>
      <li>Breaking change is a change that breaks backward compatibility with the previous version of API. For example, deleting an operation, adding a required parameter or changing the type of a parameter are breaking changes.</li>
-     <li>Risky change is a change that breaks backward compatibility according to the rules:</li>
+     <li>A change requiring attention is a change that breaks backward compatibility according to the rules:</li>
          <ul>
             <li>operation or entity in the operation was annotated as deprecated in at least two previous consecutive releases and then it was deleted
             <li>operation is marked as no-BWC.</li>

docs/Portal User Guide.md

@@ -697,7 +697,7 @@ If during package version publication, you specified a previous release version,
 
 - Breaking – Breaking change is a change that breaks backward compatibility with the previous version of API.  
   For example, deleting an operation, adding a required parameter or changing the type of a parameter are breaking changes.
-- Risky – Risky change is a change that breaks backward compatibility according to the rules:
+- Requires Attention – A change requiring attention is a change that breaks backward compatibility according to the rules:
   - operation or entity in the operation was annotated as deprecated in at least two previous consecutive releases and then it was deleted
   - operation is marked as no-BWC
 - Deprecated – Deprecating change is a change that annotates an operation, parameter or schema as deprecated. Removing a "deprecated" annotation is also considered a deprecating change.

packages/shared/src/components/ChangesTooltip.tsx

@@ -20,7 +20,7 @@ import type { ChangeSeverity } from '../entities/change-severities'
 import {
   CHANGE_SEVERITY_COLOR_MAP,
   CHANGE_SEVERITY_DESCRIPTION_MAP,
-  CHANGE_SEVERITY_NAME_MAP,
+  CHANGE_SEVERITY_TOOLTIP_TITLE_MAP,
 } from '../entities/change-severities'
 import { Box, Divider, Tooltip } from '@mui/material'
 import ListItem from '@mui/material/ListItem'
@@ -67,7 +67,7 @@ const ChangesTooltipContent: FC<ChangesTooltipContentProps> = memo<ChangesToolti
   category,
 }) => {
   const tooltipContent = CHANGE_SEVERITY_DESCRIPTION_MAP[changeType]
-  const categoryTitle = `${category ? `${TOOLTIP_TITLE_BY_CATEGORY[category]} with ` : ''}${CHANGE_SEVERITY_NAME_MAP[changeType]} Changes`
+  const categoryTitle = `${category ? `${TOOLTIP_TITLE_BY_CATEGORY[category]} with ` : ''}${CHANGE_SEVERITY_TOOLTIP_TITLE_MAP[changeType]}`
 
   return (
     <Box sx={{ p: '4px 4px' }}>

packages/shared/src/entities/change-severities.ts

@@ -54,17 +54,26 @@ export const CHANGE_SEVERITY_COLOR_MAP: Record<ChangeSeverity, string> = {
 
 export const CHANGE_SEVERITY_NAME_MAP: Record<ChangeSeverity, string> = {
   [BREAKING_CHANGE_SEVERITY]: 'Breaking',
-  [SEMI_BREAKING_CHANGE_SEVERITY]: 'Risky',
+  [SEMI_BREAKING_CHANGE_SEVERITY]: 'Requires Attention',
   [DEPRECATED_CHANGE_SEVERITY]: 'Deprecated',
   [NON_BREAKING_CHANGE_SEVERITY]: 'Non-breaking',
   [UNCLASSIFIED_CHANGE_SEVERITY]: 'Unclassified',
   [ANNOTATION_CHANGE_SEVERITY]: 'Annotation',
 }
 
+export const CHANGE_SEVERITY_TOOLTIP_TITLE_MAP: Record<ChangeSeverity, string> = {
+  [BREAKING_CHANGE_SEVERITY]: 'Breaking Changes',
+  [SEMI_BREAKING_CHANGE_SEVERITY]: 'Changes Requiring Attention',
+  [DEPRECATED_CHANGE_SEVERITY]: 'Deprecated Changes',
+  [NON_BREAKING_CHANGE_SEVERITY]: 'Non-breaking Changes',
+  [UNCLASSIFIED_CHANGE_SEVERITY]: 'Unclassified Changes',
+  [ANNOTATION_CHANGE_SEVERITY]: 'Annotation Changes',
+}
+
 export const CHANGE_SEVERITY_DESCRIPTION_MAP: Record<ChangeSeverity, { text: string; options?: string[] }> = {
   [BREAKING_CHANGE_SEVERITY]: { text: 'Breaking change is a change that breaks backward compatibility with the previous version of API. For example, deleting an operation, adding a required parameter or changing type of a parameter are breaking changes.' },
   [SEMI_BREAKING_CHANGE_SEVERITY]: {
-    text: 'Risky change is a change that breaks backward compatibility according to the rules:',
+    text: 'A change requiring attention is a change that breaks backward compatibility according to the rules:',
     options: ['operation was annotated as deprecated in at least two previous consecutive releases and then it was deleted', 'operation is marked as no-BWC'],
   },
   [DEPRECATED_CHANGE_SEVERITY]: { text: 'Deprecating change is a change that annotates an operation, parameter or schema as deprecated. Removing a "deprecated" annotation is also considered a deprecating change.' },