Skip to content

Commit 0f70b58

Browse files
authored
docs: update definition of requires attention changes (#94)
1 parent d3ab7db commit 0f70b58

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

docs/Portal User Guide.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -697,9 +697,7 @@ If during package version publication, you specified a previous release version,
697697

698698
- Breaking – Breaking change is a change that breaks backward compatibility with the previous version of API.
699699
For example, deleting an operation, adding a required parameter or changing the type of a parameter are breaking changes.
700-
- Requires Attention – A change requiring attention is a change that breaks backward compatibility according to the rules:
701-
- operation or entity in the operation was annotated as deprecated in at least two previous consecutive releases and then it was deleted
702-
- operation is marked as no-BWC
700+
- Requires Attention – 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.
703701
- 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.
704702
- Non-breaking – Non-breaking change is a change that does not break backward compatibility with the previous version of API.
705703
For example, adding a new operation or an optional parameter is a non-breaking change.

0 commit comments

Comments
 (0)