Skip to content

Commit 049107d

Browse files
authored
add breaking change and oad rule mapping (#20021)
* breaking change and oad rule mapping * small fix * use single category
1 parent eec1068 commit 049107d

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Azure REST API Breaking Change And Oad Rules Mapping
2+
3+
## Overview
4+
This specification describes the relationship between [oad rules](https://github.com/Azure/openapi-diff/tree/main/docs) and [breaking change policy](https://aka.ms/AzBreakingChangesPolicy).
5+
6+
## Mapping
7+
8+
| oad rule | breaking change category
9+
|---|---|
10+
|[1002 - ProtocolNoLongerSupported](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1002.md) | breaking change |
11+
|[1003 - RequestBodyFormatNoLongerSupported](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1003.md) | breaking change |
12+
|[1004 - ResponseBodyFormatNowSupported](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1004.md) | breaking change |
13+
|[1005 - RemovedPath](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1005.md) | breaking change |
14+
|[1006 - RemovedDefinition](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1006.md) | breaking change |
15+
|[1007 - RemovedClientParameter](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1007.md) | breaking change |
16+
|[1008 - ModifiedOperationId](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1008.md) | breaking change |
17+
|[1009 - RemovedRequiredParameter](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1009.md) | breaking change |
18+
|[1010 - AddingRequiredParameter](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1010.md) | breaking change |
19+
|[1011 - AddingResponseCode](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1011.md) | breaking change |
20+
|[1012 - RemovedResponseCode](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1012.md) | breaking change |
21+
|[1013 - AddingHeader](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1013.md) | breaking change |
22+
|[1014 - RemovingHeader](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1014.md) | breaking change |
23+
|[1015 - ParameterInHasChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1015.md) | breaking change |
24+
|[1016 - ConstantStatusHasChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1016.md) | breaking change |
25+
|[1017 - ReferenceRedirection](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1017.md) | breaking change |
26+
|[1019 - RemovedEnumValue](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1019.md) | breaking change |
27+
|[1020 - AddedEnumValue](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1020.md) |change allowed in a new api-version|
28+
|[1021 - AddedAdditionalProperties](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1021.md) | breaking change |
29+
|[1022 - RemovedAdditionalProperties](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1022.md) | breaking change |
30+
|[1023 - TypeFormatChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1023.md) | breaking change |
31+
|[1024 - ConstraintIsStronger](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1024.md) | breaking change |
32+
|[1025 - RequiredStatusChange](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1025.md) | breaking change |
33+
|[1026 - TypeChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1026.md) | breaking change |
34+
|[1027 - DefaultValueChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1027.md) | breaking change |
35+
|[1028 - ArrayCollectionFormatChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1028.md) | breaking change |
36+
|[1029 - ReadonlyPropertyChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1029.md) | breaking change (exception: non if from 'true' to 'false')|
37+
|[1030 - DifferentDiscriminator](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1030.md) | breaking change |
38+
|[1031 - DifferentExtends](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1031.md) | breaking change |
39+
|[1032 - DifferentAllOf](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1032.md) | breaking change |
40+
|[1033 - RemovedProperty](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1033.md) | breaking change |
41+
|[1034 - AddedRequiredProperty](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1034.md) | breaking change |
42+
|[1035 - RemovedOperation](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1035.md) | breaking change |
43+
|[1036 - ConstraintChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1036.md) | breaking change |
44+
|[1037 - ConstraintIsWeaker](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1037.md) | breaking change (exception:non if applies to request parameter) |
45+
|[1038 - AddedPath](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1038.md) |change allowed in a new api-version|
46+
|[1039 - AddedOperation](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1039.md) |change allowed in a new api-version|
47+
|[1040 - AddedReadOnlyPropertyInResponse](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1040.md) |change allowed in a new api-version |
48+
|[1041 - AddedPropertyInResponse](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1041.md) | change allowed in a new api-version |
49+
|[1042 - ChangedParameterOrder](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1042.md) | breaking change |
50+
|[1043 - AddingOptionalParameter](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1043.md) | breaking change |
51+
|[1044 - XmsLongRunningOperationChanged](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1044.md) | breaking change |
52+
|[1045 - AddedOptionalProperty](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1045.md) | breaking change |
53+
|[1046 - RemovedOptionalParameter](https://github.com/Azure/openapi-diff/blob/main/docs/rules/1046.md) | breaking change |
54+

0 commit comments

Comments
 (0)