forked from Azure/azure-sdk-for-java
/
revapi.json
299 lines (299 loc) · 13.5 KB
/
revapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
[
{
"extension": "revapi.java",
"configuration": {
"missing-classes": {
"behavior": "report",
"ignoreMissingAnnotations": false
},
"matchOverloads": true
}
},
{
"extension": "revapi.versions",
"configuration": {
"enabled": true,
"semantic0": false,
"versionIncreaseAllows": {
"major": {
"severity": "BREAKING"
},
"minor": {
"severity": "NON_BREAKING"
},
"patch": {
"severity": "EQUIVALENT"
}
},
"onAllowed": {
"remove": true,
"attachments": {
"breaksVersioningRules": "false"
}
},
"onDisallowed": {
"criticality": "error",
"attachments": {
"breaksVersioningRules": "true"
}
},
"passThroughDifference": [
"java.class.nonPublicPartOfAPI"
]
}
},
{
"extension": "revapi.filter",
"configuration": {
"elements": {
"exclude": [
"class com\\.azure\\.core\\.util\\.Configuration",
{
"matcher": "java-package",
"match": "/com\\.azure(\\..+?)?\\.(implementation|samples)(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/com\\.fasterxml\\.jackson(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/reactor\\.(core|netty|util)(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/io\\.(micrometer|netty)(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/(kotlin|okhttp3|okio|io\\.vertx)(\\..+)?/"
},
{
"matcher": "java-package",
"match": "/com\\.nimbusds(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/com\\.microsoft\\.azure(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/javax\\.(jms|servlet)(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/com\\.azure\\.data\\.cosmos(\\..*)?/"
},
"class com\\.azure\\.spring\\.cloud\\.config\\.State",
"class com\\.azure\\.spring\\.cloud\\.config\\.AppConfigurationRefresh",
"class com\\.azure\\.spring\\.cloud\\.config\\.properties\\.AppConfigurationProviderProperties",
"class com\\.azure\\.spring\\.cloud\\.config\\.State",
"class com\\.azure\\.spring\\.cloud\\.config\\.web\\.pushrefresh\\.AppConfigurationRefreshEvent",
"class com\\.azure\\.spring\\.cloud\\.config\\.web\\.AppConfigurationEndpoint",
{
"matcher": "java-package",
"match": "/org\\.apache\\.(avro|commons|qpid)(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/com\\.azure\\.resourcemanager(\\..+?)?\\.fluent(\\..*)?/"
},
{
"matcher": "java-package",
"match": "/org\\.(junit|slf4j|springframework)(\\..*)?/"
}
]
}
}
},
{
"extension": "revapi.differences",
"configuration": {
"ignore": true,
"differences": [
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
"new": "class com.azure.spring.messaging.container.DefaultMessageListenerContainer",
"justification": "We allow this in azure.spring.messaging."
},
{
"regex": true,
"code": "java.class.externalClassExposedInAPI",
"new": "(class|interface|enum) com.azure.spring.(messaging|integration|cloud.(core|service|autoconfigure|stream.binder.(servicebus|eventhubs)|actuator|resourcemanager))..*",
"justification": "azure.spring classes are allowed to be exposed."
},
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
"new": "(class|interface) org\\.apache\\.http\\.impl\\.conn\\.CPoolEntry",
"exampleUseChainInNewApi": ".*org\\.apache\\.http\\.HttpClientConnection.*",
"justification": "We allow this in org.apache.http.HttpClientConnection>"
},
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
"new": "(class|interface) com\\.azure\\.keyvault\\.jca\\.(com|org)\\..*",
"justification": "skip check for third party files."
},
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
"new": "(class|enum|interface) org\\.conscrypt\\..*",
"justification": "skip check for third party files."
},
{
"regex": true,
"code": "java\\.class\\.externalClassExposedInAPI",
"new": "(interface|class|enum) com\\.azure\\.(communication\\.common|core|cosmos|data\\.schemaregistry|messaging\\.eventgrid|messaging.servicebus|resourcemanager|security\\.keyvault|storage).*",
"justification": "SDK classes are allowed to be exposed by dependencies using them."
},
{
"regex": true,
"code": "java\\.class\\.externalClassExposedInAPI",
"new": "interface org\\.reactivestreams\\.(Publisher|Subscriber|Subscription).*",
"justification": "These classes exposed are publisher, subscriber, and Subscription."
},
{
"regex": true,
"code": "java\\.method\\.addedToInterface",
"new": "method .* com\\.azure\\.resourcemanager\\..*",
"justification": "resourcemanager interfaces are allowed to add methods."
},
{
"regex": true,
"code": "java\\.class\\.externalClassExposedInAPI",
"new": "(class|interface|enum) com\\.azure\\.perf\\.test\\.core\\..*",
"justification": "perf-test classes are allowed to be exposed."
},
{
"regex": true,
"code": "java\\.class\\.externalClassExposedInAPI",
"new": "(interface|class|enum) io\\.opentelemetry.*",
"justification": "Azure Monitor Exporter is allowed to use OpenTelemetry types in public APIs as it implements interfaces defined by OpenTelemetry"
},
{
"regex": true,
"code": "java\\.class\\.externalClassExposedInAPI",
"new": "(interface|enum) io\\.cloudevents.*",
"justification": "Azure Event Grid cloud native cloud event is allowed to use CloudEvents types in public APIs as it implements interfaces defined by CloudEvents"
},
{
"regex": true,
"code": "java\\.class\\.externalClassExposedInAPI",
"new": "(interface|class) org\\.springframework.util\\.ErrorHandler",
"justification": "Azure Spring Cloud Messaging need the Spring's public interface for error handler registration, it is a common class for users to handle runtime errors."
},
{
"regex": true,
"code": "java\\.annotation\\.(added|attributeValueChanged)",
"old": ".*",
"annotationType": "com\\.azure\\.core\\.annotation\\.Service(Method|Client)",
"justification": "These are SDK metadata annotations and don't affect runtime behavior."
},
{
"regex": true,
"code": "java\\.annotation\\.attributeValueChanged",
"new": "method byte\\[\\] com\\.azure\\.security\\.keyvault\\.keys\\.models\\.JsonWebKey::(g|s)et(D|Dp|Dq|E|K|N|P|Q|Qi|T|X|Y)\\(\\)",
"justification": "The class used by the serialization/deserialization annotations is package private and moving it is not a breaking change."
},
{
"regex": true,
"code": "java\\.annotation\\.(added|attributeValueChanged|attributeAdded)",
"new": "(class|method void|parameter void) com\\.azure\\.search\\.documents\\.indexes\\.models\\..*",
"justification": "Generated classes were moved into public API, these annotations were already being used in implementation used during serialization and deserialization."
},
{
"regex": true,
"code": "java\\.annotation\\.added",
"new": "(class|interface|method|parameter) org\\.springframework\\.data\\.repository\\.query\\..*",
"justification": "Spring Data Commons framework 2.6.1 added Nullable annotations to its interfaces."
},
{
"regex": true,
"code": "java\\.annotation\\.added",
"new": "(class|interface|method|parameter) com\\.azure\\.spring\\.data\\.cosmos\\.repository\\.query\\..*",
"justification": "Spring Data Commons framework 2.6.1 added Nullable annotations to its interfaces which are implemented by Cosmos Spring Data SDK for internal usage."
},
{
"code": "java.method.added",
"new": "method boolean com.google.gson.JsonArray::isEmpty()",
"justification": "com.google.code.gson:gson:jar:2.8.7 added this new method."
},
{
"regex": true,
"code": "java.field.enumConstantOrderChanged",
"new": "field com.google.gson.FieldNamingPolicy.(LOWER_CASE_WITH_DASHES|LOWER_CASE_WITH_DOTS|LOWER_CASE_WITH_UNDERSCORES)",
"justification": "Fix core-ci pipeline"
},
{
"code": "java.method.added",
"new": "method java.lang.String com.azure.storage.common.StorageSharedKeyCredential::generateAuthorizationHeader(java.net.URL, java.lang.String, com.azure.core.http.HttpHeaders, boolean)",
"justification": "New method added to SharedKeyCredential in common not intended for use by customers. Only public for access by other packages."
},
{
"code": "java.field.removedWithConstant",
"old": "field com.azure.messaging.eventhubs.EventProcessorClientBuilder.DEFAULT_OWNERSHIP_EXPIRATION_FACTOR",
"justification": "The default ownership expiration factor is an implementation detail that users can override via configuration."
},
{
"code": "java.class.nonFinalClassInheritsFromNewClass",
"old": "class com.azure.messaging.eventhubs.EventData",
"new": "class com.azure.messaging.eventhubs.EventData",
"superClass": "com.azure.core.models.MessageContent",
"justification": "To support Schema Registry Avro Serializer's signature, EventData extends from MessageContent."
},
{
"regex": true,
"code": "java.class.noLongerInheritsFromClass",
"new": "class com\\.azure\\.spring\\.cloud\\.autoconfigure\\.(storage|keyvault)\\..*",
"justification": "To support for storage services and keyvault services to share values of common properties."
},
{
"regex": true,
"code": "java\\.annotation\\.(added|removed|attributeValueChanged|attributeAdded|attributeRemoved)",
"new": "class com\\.azure\\.spring\\.cloud\\.autoconfigure\\.(storage|keyvault)\\..*",
"justification": "To support for storage services and keyvault services to share values of common properties."
},
{
"code": "java.method.removed",
"old": "method org.springframework.boot.autoconfigure.kafka.KafkaProperties com.azure.spring.cloud.autoconfigure.eventhubs.kafka.AzureEventHubsKafkaAutoConfiguration::azureKafkaProperties(com.azure.spring.cloud.core.provider.connectionstring.ServiceConnectionStringProvider<com.azure.spring.cloud.core.service.AzureServiceType.EventHubs>)",
"justification": "To move kafka properties customization to bean post processor."
},
{
"code": "java.method.visibilityReduced",
"new": "method com.azure.spring.cloud.autoconfigure.context.AzureTokenCredentialAutoConfiguration.AzureServiceClientBuilderFactoryPostProcessor com.azure.spring.cloud.autoconfigure.context.AzureTokenCredentialAutoConfiguration::builderFactoryBeanPostProcessor()",
"justification": "Shouldn't have been a public API and was recently released."
},
{
"code": "java.method.visibilityReduced",
"new": "method com.azure.spring.cloud.autoconfigure.jms.AzureServiceBusJmsPropertiesBeanPostProcessor com.azure.spring.cloud.autoconfigure.jms.ServiceBusJmsAutoConfiguration::azureServiceBusJmsPropertiesBeanPostProcessor(org.springframework.beans.factory.ObjectProvider<com.azure.spring.cloud.core.provider.connectionstring.ServiceConnectionStringProvider<com.azure.spring.cloud.core.service.AzureServiceType.ServiceBus>>)",
"justification": "Shouldn't have been a public API and was recently released."
},
{
"code": "java.annotation.added",
"new": "class com.azure.spring.cloud.autoconfigure.context.AzureTokenCredentialAutoConfiguration",
"justification": "Fixes a bug."
},
{
"code": "java.annotation.added",
"new": "class com.azure.spring.cloud.autoconfigure.jms.ServiceBusJmsAutoConfiguration",
"justification": "Fixes a bug."
},
{
"code": "java.missing.newSuperType",
"old": "class com.azure.messaging.eventhubs.EventData",
"new": "class com.azure.messaging.eventhubs.EventData",
"superClass": "com.azure.core.models.MessageContent",
"justification": "To support Schema Registry Avro Serializer's signature, EventData extends from MessageContent."
},
{
"regex": true,
"code": "java.class.externalClassExposedInAPI",
"new": "class com\\.azure\\.messaging\\.eventhubs\\..*",
"justification": "SDK classes are allowed to be exposed by dependencies using them."
}
]
}
}
]