Skip to content

Commit ded065f

Browse files
andmateiandmatei
committed
fix(ipa): reword version release/deprecation changelog messages
Make the lifecycle messages reference the released version (which matches the changelog version bucket) and state that all previous versions are deprecated, instead of naming a single superseded resource version. This avoids confusing a consumer pinned to an intermediate API version that resolves to an older resource version. - endpoint-version-added: "A new version <v> of this resource was released." - endpoint-deprecated: "A new version <v> of this resource was released. All previous versions are deprecated and marked for removal on <sunset>." Structured fields (deprecatedVersion/sunsetDate/replacedByVersion/ replacesVersion) are unchanged. Refresh changelog e2e fixtures for the new wording (version-diff files across all scenarios plus changelog/changelog-all for the scenarios with a stable version bump).
1 parent 64e033a commit ded065f

113 files changed

Lines changed: 1733 additions & 1733 deletions

File tree

Some content is hidden

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

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@
122122
"tag": "Clusters",
123123
"changes": [
124124
{
125-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
125+
"change": "A new version 2023-02-01 of this resource was released.",
126126
"changeCode": "endpoint-version-added",
127127
"backwardCompatible": true,
128128
"replacesVersion": "2023-01-01"
@@ -239,7 +239,7 @@
239239
"tag": "Clusters",
240240
"changes": [
241241
{
242-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
242+
"change": "A new version 2023-02-01 of this resource was released.",
243243
"changeCode": "endpoint-version-added",
244244
"backwardCompatible": true,
245245
"replacesVersion": "2023-01-01"
@@ -253,7 +253,7 @@
253253
"tag": "Monitoring and Logs",
254254
"changes": [
255255
{
256-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
256+
"change": "A new version 2023-02-01 of this resource was released.",
257257
"changeCode": "endpoint-version-added",
258258
"backwardCompatible": true,
259259
"replacesVersion": "2023-01-01"

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"tag": "Cloud Backups",
2020
"changes": [
2121
{
22-
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
22+
"change": "A new version 2023-10-01 of this resource was released.",
2323
"changeCode": "endpoint-version-added",
2424
"backwardCompatible": true,
2525
"replacesVersion": "2023-01-01"
@@ -38,7 +38,7 @@
3838
"tag": "Cloud Backups",
3939
"changes": [
4040
{
41-
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
41+
"change": "A new version 2023-10-01 of this resource was released.",
4242
"changeCode": "endpoint-version-added",
4343
"backwardCompatible": true,
4444
"replacesVersion": "2023-01-01"
@@ -165,7 +165,7 @@
165165
"tag": "Clusters",
166166
"changes": [
167167
{
168-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
168+
"change": "A new version 2023-02-01 of this resource was released.",
169169
"changeCode": "endpoint-version-added",
170170
"backwardCompatible": true,
171171
"replacesVersion": "2023-01-01"
@@ -282,7 +282,7 @@
282282
"tag": "Clusters",
283283
"changes": [
284284
{
285-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
285+
"change": "A new version 2023-02-01 of this resource was released.",
286286
"changeCode": "endpoint-version-added",
287287
"backwardCompatible": true,
288288
"replacesVersion": "2023-01-01"
@@ -296,7 +296,7 @@
296296
"tag": "Monitoring and Logs",
297297
"changes": [
298298
{
299-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
299+
"change": "A new version 2023-02-01 of this resource was released.",
300300
"changeCode": "endpoint-version-added",
301301
"backwardCompatible": true,
302302
"replacesVersion": "2023-01-01"

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"tag": "Federated Authentication",
3333
"changes": [
3434
{
35-
"change": "API version 2023-11-15 was added. It replaces API version 2023-01-01.",
35+
"change": "A new version 2023-11-15 of this resource was released.",
3636
"changeCode": "endpoint-version-added",
3737
"backwardCompatible": true,
3838
"replacesVersion": "2023-01-01"
@@ -56,7 +56,7 @@
5656
"tag": "Federated Authentication",
5757
"changes": [
5858
{
59-
"change": "API version 2023-11-15 was added. It replaces API version 2023-01-01.",
59+
"change": "A new version 2023-11-15 of this resource was released.",
6060
"changeCode": "endpoint-version-added",
6161
"backwardCompatible": true,
6262
"replacesVersion": "2023-01-01"
@@ -116,7 +116,7 @@
116116
"tag": "Cloud Backups",
117117
"changes": [
118118
{
119-
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
119+
"change": "A new version 2023-10-01 of this resource was released.",
120120
"changeCode": "endpoint-version-added",
121121
"backwardCompatible": true,
122122
"replacesVersion": "2023-01-01"
@@ -135,7 +135,7 @@
135135
"tag": "Cloud Backups",
136136
"changes": [
137137
{
138-
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
138+
"change": "A new version 2023-10-01 of this resource was released.",
139139
"changeCode": "endpoint-version-added",
140140
"backwardCompatible": true,
141141
"replacesVersion": "2023-01-01"
@@ -262,7 +262,7 @@
262262
"tag": "Clusters",
263263
"changes": [
264264
{
265-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
265+
"change": "A new version 2023-02-01 of this resource was released.",
266266
"changeCode": "endpoint-version-added",
267267
"backwardCompatible": true,
268268
"replacesVersion": "2023-01-01"
@@ -431,7 +431,7 @@
431431
"tag": "Clusters",
432432
"changes": [
433433
{
434-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
434+
"change": "A new version 2023-02-01 of this resource was released.",
435435
"changeCode": "endpoint-version-added",
436436
"backwardCompatible": true,
437437
"replacesVersion": "2023-01-01"
@@ -471,7 +471,7 @@
471471
"tag": "Monitoring and Logs",
472472
"changes": [
473473
{
474-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
474+
"change": "A new version 2023-02-01 of this resource was released.",
475475
"changeCode": "endpoint-version-added",
476476
"backwardCompatible": true,
477477
"replacesVersion": "2023-01-01"

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"tag": "Federated Authentication",
3333
"changes": [
3434
{
35-
"change": "API version 2023-11-15 was added. It replaces API version 2023-01-01.",
35+
"change": "A new version 2023-11-15 of this resource was released.",
3636
"changeCode": "endpoint-version-added",
3737
"backwardCompatible": true,
3838
"replacesVersion": "2023-01-01"
@@ -56,7 +56,7 @@
5656
"tag": "Federated Authentication",
5757
"changes": [
5858
{
59-
"change": "API version 2023-11-15 was added. It replaces API version 2023-01-01.",
59+
"change": "A new version 2023-11-15 of this resource was released.",
6060
"changeCode": "endpoint-version-added",
6161
"backwardCompatible": true,
6262
"replacesVersion": "2023-01-01"
@@ -116,7 +116,7 @@
116116
"tag": "Alerts",
117117
"changes": [
118118
{
119-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
119+
"change": "A new version 2024-05-30 of this resource was released.",
120120
"changeCode": "endpoint-version-added",
121121
"backwardCompatible": true,
122122
"replacesVersion": "2023-01-01"
@@ -135,7 +135,7 @@
135135
"tag": "Cloud Backups",
136136
"changes": [
137137
{
138-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
138+
"change": "A new version 2024-05-30 of this resource was released.",
139139
"changeCode": "endpoint-version-added",
140140
"backwardCompatible": true,
141141
"replacesVersion": "2023-01-01"
@@ -164,7 +164,7 @@
164164
"tag": "Cloud Backups",
165165
"changes": [
166166
{
167-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
167+
"change": "A new version 2024-05-30 of this resource was released.",
168168
"changeCode": "endpoint-version-added",
169169
"backwardCompatible": true,
170170
"replacesVersion": "2023-01-01"
@@ -208,7 +208,7 @@
208208
"tag": "Cloud Backups",
209209
"changes": [
210210
{
211-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
211+
"change": "A new version 2024-05-30 of this resource was released.",
212212
"changeCode": "endpoint-version-added",
213213
"backwardCompatible": true,
214214
"replacesVersion": "2023-01-01"
@@ -237,7 +237,7 @@
237237
"tag": "Cloud Backups",
238238
"changes": [
239239
{
240-
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
240+
"change": "A new version 2023-10-01 of this resource was released.",
241241
"changeCode": "endpoint-version-added",
242242
"backwardCompatible": true,
243243
"replacesVersion": "2023-01-01"
@@ -256,7 +256,7 @@
256256
"tag": "Cloud Backups",
257257
"changes": [
258258
{
259-
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
259+
"change": "A new version 2023-10-01 of this resource was released.",
260260
"changeCode": "endpoint-version-added",
261261
"backwardCompatible": true,
262262
"replacesVersion": "2023-01-01"
@@ -383,7 +383,7 @@
383383
"tag": "Clusters",
384384
"changes": [
385385
{
386-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
386+
"change": "A new version 2023-02-01 of this resource was released.",
387387
"changeCode": "endpoint-version-added",
388388
"backwardCompatible": true,
389389
"replacesVersion": "2023-01-01"
@@ -552,7 +552,7 @@
552552
"tag": "Clusters",
553553
"changes": [
554554
{
555-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
555+
"change": "A new version 2023-02-01 of this resource was released.",
556556
"changeCode": "endpoint-version-added",
557557
"backwardCompatible": true,
558558
"replacesVersion": "2023-01-01"
@@ -571,7 +571,7 @@
571571
"backwardCompatible": false
572572
},
573573
{
574-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
574+
"change": "A new version 2024-05-30 of this resource was released.",
575575
"changeCode": "endpoint-version-added",
576576
"backwardCompatible": true,
577577
"replacesVersion": "2023-01-01"
@@ -590,7 +590,7 @@
590590
"tag": "Atlas Search",
591591
"changes": [
592592
{
593-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
593+
"change": "A new version 2024-05-30 of this resource was released.",
594594
"changeCode": "endpoint-version-added",
595595
"backwardCompatible": true,
596596
"replacesVersion": "2023-01-01"
@@ -604,7 +604,7 @@
604604
"tag": "Atlas Search",
605605
"changes": [
606606
{
607-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
607+
"change": "A new version 2024-05-30 of this resource was released.",
608608
"changeCode": "endpoint-version-added",
609609
"backwardCompatible": true,
610610
"replacesVersion": "2023-01-01"
@@ -623,7 +623,7 @@
623623
"backwardCompatible": false
624624
},
625625
{
626-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
626+
"change": "A new version 2024-05-30 of this resource was released.",
627627
"changeCode": "endpoint-version-added",
628628
"backwardCompatible": true,
629629
"replacesVersion": "2023-01-01"
@@ -785,7 +785,7 @@
785785
"tag": "Monitoring and Logs",
786786
"changes": [
787787
{
788-
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
788+
"change": "A new version 2023-02-01 of this resource was released.",
789789
"changeCode": "endpoint-version-added",
790790
"backwardCompatible": true,
791791
"replacesVersion": "2023-01-01"
@@ -812,7 +812,7 @@
812812
"tag": "Cloud Migration Service",
813813
"changes": [
814814
{
815-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
815+
"change": "A new version 2024-05-30 of this resource was released.",
816816
"changeCode": "endpoint-version-added",
817817
"backwardCompatible": true,
818818
"replacesVersion": "2023-01-01"
@@ -836,7 +836,7 @@
836836
"tag": "Cloud Migration Service",
837837
"changes": [
838838
{
839-
"change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.",
839+
"change": "A new version 2024-05-30 of this resource was released.",
840840
"changeCode": "endpoint-version-added",
841841
"backwardCompatible": true,
842842
"replacesVersion": "2023-01-01"

0 commit comments

Comments
 (0)