Skip to content

Commit 18fc9ee

Browse files
blvablva
authored
CLOUDP-280564: Update breaking changes classification in changelog (#629)
1 parent 73684db commit 18fc9ee

File tree

70 files changed

+1381
-1377
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+1381
-1377
lines changed

‎tools/cli/internal/changelog/changelog.go‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,19 @@ const (
3535
)
3636

3737
var breakingChangesAdditionalCheckers = map[string]checker.Level{
38-
"response-non-success-status-removed": checker.ERR,
39-
"api-operation-id-removed": checker.ERR,
40-
"api-tag-removed": checker.ERR,
41-
"response-property-enum-value-removed": checker.ERR,
42-
"response-mediatype-enum-value-removed": checker.ERR,
43-
"request-body-enum-value-removed": checker.ERR,
44-
"api-schema-removed": checker.ERR,
45-
"response-property-one-of-added": checker.INFO,
46-
"response-body-one-of-added": checker.INFO,
38+
"response-non-success-status-removed": checker.ERR,
39+
"api-operation-id-removed": checker.ERR,
40+
"api-tag-removed": checker.ERR,
41+
"response-property-enum-value-removed": checker.ERR,
42+
"response-mediatype-enum-value-removed": checker.ERR,
43+
"request-body-enum-value-removed": checker.ERR,
44+
"api-schema-removed": checker.ERR,
45+
"response-property-one-of-added": checker.INFO,
46+
"response-body-one-of-added": checker.INFO,
47+
"request-parameter-removed": checker.ERR,
48+
"request-property-removed": checker.ERR,
49+
"response-optional-property-removed": checker.ERR,
50+
"response-optional-write-only-property-removed": checker.ERR,
4751
}
4852

4953
type Changelog struct {

‎tools/cli/test/data/changelog/changelog.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
{
1717
"change": "removed the optional properties from the response: 'results.items.mongoURIWithOptions', 'results.items.providerBackupEnabled', 'results.items.mongoURIUpdated', 'results.items.srvAddress', 'results.items.replicationSpec', 'results.items.mongoURI', 'results.items.numShards', 'results.items.autoScaling', 'results.items.providerSettings', 'results.items.replicationFactor', 'results.items.replicationSpecs.regionsConfig'",
1818
"changeCode": "response-optional-property-removed",
19-
"backwardCompatible": true
19+
"backwardCompatible": false
2020
},
2121
{
2222
"change": "added response property 'results.items.replicationSpecs.regionConfigs'",
@@ -63,7 +63,7 @@
6363
{
6464
"change": "removed the optional properties from the response: 'mongoURIWithOptions', 'providerBackupEnabled', 'mongoURIUpdated', 'srvAddress', 'replicationSpec', 'mongoURI','numShards', 'autoScaling', 'providerSettings', 'replicationFactor', 'replicationSpecs.regionsConfig'",
6565
"changeCode": "response-optional-property-removed",
66-
"backwardCompatible": true
66+
"backwardCompatible": false
6767
},
6868
{
6969
"change": "added response property 'replicationSpecs.regionConfigs'",
@@ -126,7 +126,7 @@
126126
{
127127
"change": "removed the optional properties from the response: 'mongoURIWithOptions', 'providerBackupEnabled', 'mongoURIUpdated', 'srvAddress', 'replicationSpec', 'mongoURI','numShards', 'autoScaling', 'providerSettings', 'replicationFactor', 'replicationSpecs.regionsConfig'",
128128
"changeCode": "response-optional-property-removed",
129-
"backwardCompatible": true
129+
"backwardCompatible": false
130130
},
131131
{
132132
"change": "added response property 'replicationSpecs.regionConfigs'",
@@ -173,7 +173,7 @@
173173
{
174174
"change": "removed the optional properties from the response: 'mongoURIWithOptions', 'providerBackupEnabled', 'mongoURIUpdated', 'srvAddress', 'replicationSpec', 'mongoURI','numShards', 'autoScaling', 'providerSettings', 'replicationFactor', 'replicationSpecs.regionsConfig'",
175175
"changeCode": "response-optional-property-removed",
176-
"backwardCompatible": true
176+
"backwardCompatible": false
177177
},
178178
{
179179
"change": "added response property 'replicationSpecs.regionConfigs'",

‎tools/cli/test/data/changelog/new-api-preview-version/base/changelog.json‎

Lines changed: 50 additions & 50 deletions
Large diffs are not rendered by default.

‎tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-02-01.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
{
3737
"change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response",
3838
"changeCode": "response-optional-property-removed",
39-
"backwardCompatible": true
39+
"backwardCompatible": false
4040
},
4141
{
4242
"change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only",
@@ -95,12 +95,12 @@
9595
{
9696
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
9797
"changeCode": "response-optional-property-removed",
98-
"backwardCompatible": true
98+
"backwardCompatible": false
9999
},
100100
{
101101
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
102102
"changeCode": "request-property-removed",
103-
"backwardCompatible": true
103+
"backwardCompatible": false
104104
},
105105
{
106106
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",
@@ -139,7 +139,7 @@
139139
{
140140
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
141141
"changeCode": "response-optional-property-removed",
142-
"backwardCompatible": true
142+
"backwardCompatible": false
143143
},
144144
{
145145
"change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only",
@@ -198,12 +198,12 @@
198198
{
199199
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
200200
"changeCode": "response-optional-property-removed",
201-
"backwardCompatible": true
201+
"backwardCompatible": false
202202
},
203203
{
204204
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
205205
"changeCode": "request-property-removed",
206-
"backwardCompatible": true
206+
"backwardCompatible": false
207207
},
208208
{
209209
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",

‎tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-10-01.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
{
6868
"change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response",
6969
"changeCode": "response-optional-property-removed",
70-
"backwardCompatible": true
70+
"backwardCompatible": false
7171
},
7272
{
7373
"change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only",
@@ -126,12 +126,12 @@
126126
{
127127
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
128128
"changeCode": "response-optional-property-removed",
129-
"backwardCompatible": true
129+
"backwardCompatible": false
130130
},
131131
{
132132
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
133133
"changeCode": "request-property-removed",
134-
"backwardCompatible": true
134+
"backwardCompatible": false
135135
},
136136
{
137137
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",
@@ -170,7 +170,7 @@
170170
{
171171
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
172172
"changeCode": "response-optional-property-removed",
173-
"backwardCompatible": true
173+
"backwardCompatible": false
174174
},
175175
{
176176
"change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only",
@@ -229,12 +229,12 @@
229229
{
230230
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
231231
"changeCode": "response-optional-property-removed",
232-
"backwardCompatible": true
232+
"backwardCompatible": false
233233
},
234234
{
235235
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
236236
"changeCode": "request-property-removed",
237-
"backwardCompatible": true
237+
"backwardCompatible": false
238238
},
239239
{
240240
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",

‎tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-11-15.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
{
4040
"change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response",
4141
"changeCode": "response-optional-property-removed",
42-
"backwardCompatible": true
42+
"backwardCompatible": false
4343
}
4444
]
4545
},
@@ -62,12 +62,12 @@
6262
{
6363
"change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response",
6464
"changeCode": "response-optional-property-removed",
65-
"backwardCompatible": true
65+
"backwardCompatible": false
6666
},
6767
{
6868
"change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'",
6969
"changeCode": "request-property-removed",
70-
"backwardCompatible": true
70+
"backwardCompatible": false
7171
}
7272
]
7373
},
@@ -152,7 +152,7 @@
152152
{
153153
"change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response",
154154
"changeCode": "response-optional-property-removed",
155-
"backwardCompatible": true
155+
"backwardCompatible": false
156156
},
157157
{
158158
"change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only",
@@ -211,12 +211,12 @@
211211
{
212212
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
213213
"changeCode": "response-optional-property-removed",
214-
"backwardCompatible": true
214+
"backwardCompatible": false
215215
},
216216
{
217217
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
218218
"changeCode": "request-property-removed",
219-
"backwardCompatible": true
219+
"backwardCompatible": false
220220
},
221221
{
222222
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",
@@ -255,7 +255,7 @@
255255
{
256256
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
257257
"changeCode": "response-optional-property-removed",
258-
"backwardCompatible": true
258+
"backwardCompatible": false
259259
},
260260
{
261261
"change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only",
@@ -314,12 +314,12 @@
314314
{
315315
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
316316
"changeCode": "response-optional-property-removed",
317-
"backwardCompatible": true
317+
"backwardCompatible": false
318318
},
319319
{
320320
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
321321
"changeCode": "request-property-removed",
322-
"backwardCompatible": true
322+
"backwardCompatible": false
323323
},
324324
{
325325
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",

‎tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-05-30.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
{
4040
"change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response",
4141
"changeCode": "response-optional-property-removed",
42-
"backwardCompatible": true
42+
"backwardCompatible": false
4343
}
4444
]
4545
},
@@ -62,12 +62,12 @@
6262
{
6363
"change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response",
6464
"changeCode": "response-optional-property-removed",
65-
"backwardCompatible": true
65+
"backwardCompatible": false
6666
},
6767
{
6868
"change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'",
6969
"changeCode": "request-property-removed",
70-
"backwardCompatible": true
70+
"backwardCompatible": false
7171
}
7272
]
7373
},
@@ -167,7 +167,7 @@
167167
{
168168
"change": "removed the request property 'iamRoleId'",
169169
"changeCode": "request-property-removed",
170-
"backwardCompatible": true
170+
"backwardCompatible": false
171171
}
172172
]
173173
},
@@ -249,7 +249,7 @@
249249
{
250250
"change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response",
251251
"changeCode": "response-optional-property-removed",
252-
"backwardCompatible": true
252+
"backwardCompatible": false
253253
},
254254
{
255255
"change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only",
@@ -308,12 +308,12 @@
308308
{
309309
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
310310
"changeCode": "response-optional-property-removed",
311-
"backwardCompatible": true
311+
"backwardCompatible": false
312312
},
313313
{
314314
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
315315
"changeCode": "request-property-removed",
316-
"backwardCompatible": true
316+
"backwardCompatible": false
317317
},
318318
{
319319
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",
@@ -352,7 +352,7 @@
352352
{
353353
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
354354
"changeCode": "response-optional-property-removed",
355-
"backwardCompatible": true
355+
"backwardCompatible": false
356356
},
357357
{
358358
"change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only",
@@ -411,12 +411,12 @@
411411
{
412412
"change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response",
413413
"changeCode": "response-optional-property-removed",
414-
"backwardCompatible": true
414+
"backwardCompatible": false
415415
},
416416
{
417417
"change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'",
418418
"changeCode": "request-property-removed",
419-
"backwardCompatible": true
419+
"backwardCompatible": false
420420
},
421421
{
422422
"change": "added the new optional request property 'replicationSpecs/items/regionConfigs'",
@@ -689,7 +689,7 @@
689689
{
690690
"change": "removed the request property 'dropEnabled'",
691691
"changeCode": "request-property-removed",
692-
"backwardCompatible": true,
692+
"backwardCompatible": false,
693693
"hideFromChangelog": true
694694
}
695695
]
@@ -708,7 +708,7 @@
708708
{
709709
"change": "removed the request property 'dropEnabled'",
710710
"changeCode": "request-property-removed",
711-
"backwardCompatible": true,
711+
"backwardCompatible": false,
712712
"hideFromChangelog": true
713713
}
714714
]

0 commit comments

Comments
 (0)