Skip to content

Commit 176b204

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

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

src/test-data/shared/messages.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
export const TOOLTIP_SEVERITY_MSG = {
22
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 type of a parameter are breaking changes.',
33
nonBreaking: '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.',
4-
risky: [
5-
'A change requiring attention is a change that breaks backward compatibility according to the rules:',
6-
'operation was annotated as deprecated in at least two previous consecutive releases and then it was deleted',
7-
'operation is marked as no-BWC',
8-
],
4+
risky: '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.',
95
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.',
106
annotation: 'An annotation change is a change to enrich the API documentation with information that does not affect the functionality of the API. For example, adding/changing/deleting descriptions or examples is annotation change.',
117
unclassified: 'An unclassified change is a change that cannot be classified as any of the other types.',

0 commit comments

Comments
 (0)