Skip to content

Commit 4252058

Browse files
iurii-golovinskiiIurii Golovinskii
andauthored
feat: more general definition of changes requiring attention in tooltip (#96)
Co-authored-by: Iurii Golovinskii <[email protected]>
1 parent 0f70b58 commit 4252058

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,7 @@ export const CHANGE_SEVERITY_TOOLTIP_TITLE_MAP: Record<ChangeSeverity, string> =
8080

8181
export const CHANGE_SEVERITY_DESCRIPTION_MAP: Record<ChangeSeverity, { text: string; options?: string[] }> = {
8282
[breaking]: { 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.' },
83-
[risky]: {
84-
text: 'A change requiring attention is a change that breaks backward compatibility according to the rules:',
85-
options: ['operation was annotated as deprecated in at least two previous consecutive releases and then it was deleted', 'operation is marked as no-BWC'],
86-
},
83+
[risky]: { text: 'A change requiring attention is a change that potentially may break backward compatibility with the previous version of API, depending on the particular implementation of a client code. This category also includes breaking changes in operations annotated as no-BWC.'},
8784
[deprecated]: { 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.' },
8885
[nonBreaking]: { text: 'Non-breaking change is change that does not break backward compatibility with the previous version of API. For example, adding new operation or optional parameter is non-breaking change.' },
8986
[unclassified]: { text: 'An unclassified change is a change that cannot be classified as any of the other types.' },

0 commit comments

Comments
 (0)