Skip to content

fix(ipa): clarify endpoint version lifecycle entries #1370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andmatei merged 7 commits into from
Jul 10, 2026
Merged

fix(ipa): clarify endpoint version lifecycle entries #1370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
74d3d8b
fix(ipa): clarify endpoint version lifecycle entries
andmatei Jul 8, 2026
fb9b984
test(ipa): cover operation version extraction and document lifecycle …
andmatei Jul 9, 2026
64e033a
fix(ipa): surface version release and deprecation in changelog.json
andmatei Jul 9, 2026
ded065f
fix(ipa): reword version release/deprecation changelog messages
andmatei Jul 9, 2026
a87e261
Revert "fix(ipa): reword version release/deprecation changelog messages"
andmatei Jul 9, 2026
7bcf022
test(ipa): assert version release surfaces deprecation in changelog p…
andmatei Jul 9, 2026
3dbe58f
chore: remove workspace checksum noise
andmatei Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-02-01.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,20 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",

@andmatei andmatei Jul 9, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these changes are from regenerating the e2e test fixtures

"httpMethod": "DELETE",
"operationId": "deleteCluster",
"tag": "Clusters",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",
"httpMethod": "GET",
Expand Down Expand Up @@ -218,6 +232,34 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries",
"httpMethod": "POST",
"operationId": "testFailover",
"tag": "Clusters",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz",
"httpMethod": "GET",
"operationId": "getHostLogs",
"tag": "Monitoring and Logs",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/streams",
"httpMethod": "GET",
Expand Down
54 changes: 54 additions & 0 deletions tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-10-01.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
"operationId": "getDataProtectionSettings",
"tag": "Cloud Backups",
"changes": [
{
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
},
{
"change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required for the status '200'",
"changeCode": "response-property-became-required",
Expand All @@ -31,6 +37,12 @@
"operationId": "updateDataProtectionSettings",
"tag": "Cloud Backups",
"changes": [
{
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
},
{
"change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required for the status '200'",
"changeCode": "response-property-became-required",
Expand Down Expand Up @@ -146,6 +158,20 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",
"httpMethod": "DELETE",
"operationId": "deleteCluster",
"tag": "Clusters",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",
"httpMethod": "GET",
Expand Down Expand Up @@ -249,6 +275,34 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries",
"httpMethod": "POST",
"operationId": "testFailover",
"tag": "Clusters",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz",
"httpMethod": "GET",
"operationId": "getHostLogs",
"tag": "Monitoring and Logs",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/streams",
"httpMethod": "GET",
Expand Down
66 changes: 66 additions & 0 deletions tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-11-15.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@
"operationId": "getIdentityProvider",
"tag": "Federated Authentication",
"changes": [
{
"change": "API version 2023-11-15 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
},
{
"change": "added `#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider` to the response body `oneOf` list for the response status `200`",
"changeCode": "response-body-one-of-added",
Expand All @@ -49,6 +55,12 @@
"operationId": "updateIdentityProvider",
"tag": "Federated Authentication",
"changes": [
{
"change": "API version 2023-11-15 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
},
{
"change": "added `#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate` to the request body `oneOf` list",
"changeCode": "request-body-one-of-added",
Expand Down Expand Up @@ -103,6 +115,12 @@
"operationId": "getDataProtectionSettings",
"tag": "Cloud Backups",
"changes": [
{
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
},
{
"change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required for the status '200'",
"changeCode": "response-property-became-required",
Expand All @@ -116,6 +134,12 @@
"operationId": "updateDataProtectionSettings",
"tag": "Cloud Backups",
"changes": [
{
"change": "API version 2023-10-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
},
{
"change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required for the status '200'",
"changeCode": "response-property-became-required",
Expand Down Expand Up @@ -231,6 +255,20 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",
"httpMethod": "DELETE",
"operationId": "deleteCluster",
"tag": "Clusters",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",
"httpMethod": "GET",
Expand Down Expand Up @@ -386,6 +424,20 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries",
"httpMethod": "POST",
"operationId": "testFailover",
"tag": "Clusters",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces",
"httpMethod": "GET",
Expand All @@ -412,6 +464,20 @@
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz",
"httpMethod": "GET",
"operationId": "getHostLogs",
"tag": "Monitoring and Logs",
"changes": [
{
"change": "API version 2023-02-01 was added. It replaces API version 2023-01-01.",
"changeCode": "endpoint-version-added",
"backwardCompatible": true,
"replacesVersion": "2023-01-01"
}
]
},
{
"path": "/api/atlas/v2/groups/{groupId}/collStats/metrics",
"httpMethod": "GET",
Expand Down
Loading
Loading